mapgl ruler

Mapgl 标尺

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

发布

新项目管理

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即可。