geoman-io/leaflet-geoman

Document Typescript casting of event payload

Open

#1 014 ouverte le 19 oct. 2021

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)JavaScript (1 933 stars) (404 forks)batch import
good first issuehelp wantedimprovementtypescript

Description

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:

Guide contributeur

Stack technique
typescript
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
TypeScript basicsleaflet geoman event system
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
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.