Skip to content

Add documentation pages for CustomPointStyle and CustomLayerRenderer - #3317

Merged
pauldendulk merged 2 commits into
mainfrom
docs/custom-renderer
Mar 24, 2026
Merged

pauldendulk merged 2 commits into
mainfrom
docs/custom-renderer

Conversation

@pauldendulk

Copy link
Copy Markdown
Member

Summary

Adds two new documentation pages for the custom renderer types introduced in v5, which previously had no docs:

  • custom-point-style-renderer.md — documents CustomPointStyle + MapRenderer.RegisterPointStyleRenderer. Explains that the framework handles all transforms (translate, scale, rotate) so the user draws at (0, 0). Includes a quick-start code snippet, a link to the three existing samples (Basic, Advanced, Shader), a note on RelativeOffset, and a section on the experimental renderer's extra IFeature feature parameter in DrawPointStyle.

  • custom-layer-renderer.md — documents CustomLayerRendererName + MapRenderer.RegisterLayerRenderer. Explains that the user has full control and is responsible for all coordinate transforms. Includes a quick-start snippet and a link to the existing sample.

Both pages are registered in mkdocs.yml adjacent to the existing custom-style-renders.md page.

Files changed

  • docs/general/markdown/custom-point-style-renderer.md (new)
  • docs/general/markdown/custom-layer-renderer.md (new)
  • docs/general/mkdocs.yml (nav entries added)

@pauldendulk pauldendulk added the PR type: 📝 Documentation Changes to user guides, README, API docs, etc. label Mar 23, 2026
@pauldendulk
pauldendulk merged commit 6ef24b1 into main Mar 24, 2026
8 of 9 checks passed
@pauldendulk
pauldendulk deleted the docs/custom-renderer branch March 24, 2026 06:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR type: 📝 Documentation Changes to user guides, README, API docs, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant