geoman-io/leaflet-geoman

Document Typescript casting of event payload

Open

#1,014 创建于 2021年10月19日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)JavaScript (1,933 star) (404 fork)batch import
good first issuehelp wantedimprovementtypescript

描述

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:

贡献者指南

技术栈
typescript
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
TypeScript basicsleaflet geoman event system
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.