geoman-io/leaflet-geoman

Document Typescript casting of event payload

Open

#1.014 geöffnet am 19. Okt. 2021

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (1.933 Stars) (404 Forks)batch import
good first issuehelp wantedimprovementtypescript

Beschreibung

In the event payload the return type of layer is `L.Layer? so it needs to be casted to the Layer-Type.

layer.on('pm:edit', (e) => {
  if(e.shape === 'Polygon'){
     (e.layer as Polygon).getLatLngs();
  }
});

I think following should work too: (But not tested)

layer.on('pm:edit', (e) => {
  if(e.layer instanceof L.Polygon){
     (e.layer as Polygon).getLatLngs();
  }
});

This should documented in the Readme

Explainations:

Contributor Guide

Tech Stack
typescript
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
TypeScript basicsleaflet geoman event system
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
Add a section in the README.md file explaining how to cast the event payload's layer type to a specific type like Polygon. Use the code examples provided in the issue (e.g., `(e.layer as Polygon).getLatLngs()`) and reference the StackOverflow link and issue #945 for additional context. Ensure the documentation covers both the inline cast and the instanceof check approach.