mapgl ruler

マップグルルーラー

Mapgl 用定規プラグイン

ライブデモ

使用法

NPM を使用してインストールする

npm install @2gis/mapgl-ruler

定規を直接使用する

Ruler クラスをプロジェクトにインポートして使用します。

 import { Ruler } from '@2gis/mapgl-ruler' ;

const map = new mapgl . Map ( 'container' , {
    center : [ 55.31878 , 25.23584 ] ,
    zoom : 13 ,
    key : 'Your API access key' ,
} ) ;

const ruler = new Ruler ( map , { 
    points : [
        [ 55.31878 , 25.23584 ] ,
        [ 55.35878 , 25.23584 ] ,
        [ 55.35878 , 25.26584 ] ,
    ]
} ) ;

RulerControl経由でルーラーを使用する

RulerControl クラスをプロジェクトにインポートして使用します。

 import { RulerControl } from "@2gis/mapgl-ruler" ;

const map = new mapgl . Map ( 'container' , {
    center : [ 55.31878 , 25.23584 ] ,
    zoom : 13 ,
    key : 'Your API access key' ,
} ) ;

const control = new RulerControl ( map , { position : 'centerRight' } ) 

貢献する

Mapgl-ruler は github-flow を使用して修正と改善を受け入れ、マージします。基本的なプロセスは次のとおりです。

• リポジトリをフォークします。
• ブランチを作成します。
• コードを追加または修正します。
• npm run docker:testでテストスイートを実行し、何も壊れていないことを確認します
• 新しいコードにテストを追加するか、壊れたテストを修正します。
• コミットしてプッシュします。
• 元のリポジトリに新しいプル リクエストを作成します。

テストに失敗したプル リクエストは受け入れられません。また、パッケージを変更するか、 package.jsonに追加する場合は、必ずnpm使用し、 package-lock.jsonを更新してください。

テスト

テストの実行

npm run docker:test

スクリーンショットを更新する

npm run docker:screenshot:update

リリース

npm

1. npm version patch|minor|major実行して、パッケージのバージョンを更新します。このコマンドは、新しいパッケージのバージョンを返します。 1.2.3だと仮定しましょう
2. 変更を github にプッシュし、«master» ブランチにマージします。
3. https://github.com/2gis/mapgl-ruler/releases/new に移動します。
4. 「タグを選択」ボタンをクリックし、package.json 内のバージョン (例: v1.2.3) に従って新しいタグを作成します。
5. リリースターゲットが«master»ブランチであることを確認してください
6. リリース タグを「リリース タイトル」フィールドに貼り付けます (例: v1.2.3)。
7. リリースの説明を追加する
8. 「リリースを公開」ボタンをクリックします。
9. https://github.com/2gis/mapgl-ruler/actions に移動し、リリース ワークフローが完了するまで待ちます。

デモ

1. デモとしてデプロイしたいコミットからローカルマシン上でnpm run deploy-gh-pages実行するだけです。