mapgl ruler

Mapgl-Herrscher

Lineal-Plugin für Mapgl

Live-Demo

Verwendung

Mit NPM installieren

npm install @2gis/mapgl-ruler

Verwenden Sie direkt das Lineal

Importieren Sie die Ruler-Klasse in Ihr Projekt und verwenden Sie sie:

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

Verwenden Sie das Lineal über RulerControl

Importieren Sie die RulerControl-Klasse in Ihr Projekt und verwenden Sie sie:

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

Mitwirken

Mapgl-Ruler verwendet Github-Flow, um Korrekturen und Verbesserungen zu akzeptieren und zusammenzuführen. Der grundlegende Prozess ist:

• Forken Sie das Repo.
• Erstellen Sie einen Zweig.
• Fügen Sie Code hinzu oder korrigieren Sie ihn.
• Führen Sie die Testsuite mit npm run docker:test und stellen Sie sicher, dass nichts kaputt ist
• Fügen Sie einige Tests für Ihren neuen Code hinzu oder reparieren Sie fehlerhafte Tests.
• Commit & Push.
• Erstellen Sie eine neue Pull-Anfrage an das ursprüngliche Repo.

Pull-Requests mit fehlgeschlagenen Tests werden nicht akzeptiert. Wenn Sie Pakete ändern oder zu package.json hinzufügen, stellen Sie außerdem sicher, dass Sie npm verwenden und package-lock.json aktualisieren.

Tests

Führen Sie Tests durch

npm run docker:test

Screenshots aktualisieren

npm run docker:screenshot:update

Freigeben

npm

1. Aktualisieren Sie die Paketversion, indem Sie npm version patch|minor|major ausführen. Dieser Befehl gibt eine neue Paketversion zurück. Nehmen wir an, es ist 1.2.3
2. Übertragen Sie Änderungen an Github und führen Sie sie im „Master“-Zweig zusammen
3. Gehen Sie zu https://github.com/2gis/mapgl-ruler/releases/new
4. Klicken Sie auf die Schaltfläche „Tag auswählen“ und erstellen Sie ein neues Tag entsprechend der Version in package.json, zum Beispiel v1.2.3
5. Stellen Sie sicher, dass das Release-Ziel der „Master“-Zweig ist
6. Fügen Sie das Release-Tag in das Feld „Release-Titel“ ein, zum Beispiel v1.2.3
7. Fügen Sie eine Release-Beschreibung hinzu
8. Klicken Sie auf die Schaltfläche «Veröffentlichung veröffentlichen»
9. Gehen Sie zu https://github.com/2gis/mapgl-ruler/actions und warten Sie, bis der Release-Workflow abgeschlossen ist

Demo

1. Führen Sie einfach npm run deploy-gh-pages auf Ihrem lokalen Computer von einem Commit aus aus, den Sie als Demo bereitstellen möchten.