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 на своем локальном компьютере из коммита, который вы хотите развернуть в качестве демонстрации.