mapgl ruler

règle mapgl

Plugin de règle pour Mapgl

Démo en direct

Usage

Installer avec NPM

npm install @2gis/mapgl-ruler

Utiliser directement la règle

Importez la classe Ruler dans votre projet et utilisez-la :

 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 ] ,
    ]
} ) ;

Utiliser la règle via RulerControl

Importez la classe RulerControl dans votre projet et utilisez-la :

 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' } ) 

Contribuer

Mapgl-ruler utilise github-flow pour accepter et fusionner les correctifs et améliorations. Le processus de base est :

• Forkez le dépôt.
• Créez une branche.
• Ajoutez ou corrigez du code.
• Exécutez la suite de tests avec npm run docker:test et assurez-vous que rien n'est cassé
• Ajoutez des tests pour votre nouveau code ou corrigez les tests défectueux.
• Engagez-vous et poussez.
• Créez une nouvelle demande d'extraction vers le dépôt d'origine.

Les demandes de tirage dont les tests ont échoué ne seront pas acceptées. De plus, si vous modifiez des packages ou les ajoutez à package.json , assurez-vous d'utiliser npm et de mettre à jour package-lock.json .

Essais

Exécuter des tests

npm run docker:test

Mettre à jour les captures d'écran

npm run docker:screenshot:update

Libérer

npm

1. Mettez à jour la version du package en exécutant npm version patch|minor|major . Cette commande renvoie une nouvelle version du package. Supposons que ce soit 1.2.3
2. Transférez les modifications vers github et fusionnez-les dans la branche « master »
3. Accédez à https://github.com/2gis/mapgl-ruler/releases/new
4. Cliquez sur le bouton « Choisir une balise » et créez une nouvelle balise en fonction de la version dans package.json, par exemple v1.2.3
5. Assurez-vous que la cible de la version est la branche « master »
6. Collez la balise de version dans le champ « Titre de la version », par exemple v1.2.3
7. Ajouter une description de la version
8. Cliquez sur le bouton « Publier la version »
9. Accédez à https://github.com/2gis/mapgl-ruler/actions et attendez la fin du workflow de publication

Démo

1. Exécutez simplement npm run deploy-gh-pages sur votre machine locale à partir d'un commit que vous souhaitez déployer en tant que démo.