Interface LegendOptions

since: 0.14.9

Hierarchy

LegendOptions

Index

Methods

Methods

Optional provideExtraGroupIconsHtml

provideExtraGroupIconsHtml(options: LegendNodeExtraHTMLProps<MapGroup>): string[]

Provide extra HTML elements to insert before a group name in a group legend node

Please note: If the HTML returned by this function would contain potentially untrusted input, you are responsible for sanitizing the HTML content. The given options contains a sanitize function for you to sanitize untrusted parts of the HTML content being assembled.

Parameters
- options: LegendNodeExtraHTMLProps<MapGroup>
Returns string[]

Optional provideExtraLayerIconsHtml

provideExtraLayerIconsHtml(options: LegendNodeExtraHTMLProps<MapLayer>): string[]

Provide extra HTML elements to insert before a layer name in a layer legend node

Please note: If the HTML returned by this function would contain potentially untrusted input, you are responsible for sanitizing the HTML content. The given options contains a sanitize function for you to sanitize untrusted parts of the HTML content being assembled.

Parameters
- options: LegendNodeExtraHTMLProps<MapLayer>
Returns string[]

Generated using TypeDoc