Interface ILegendContext

Hierarchy

ILegendContext

Properties

stateless

stateless: boolean

Methods

getBaseIconSize

getBaseIconSize(): number

Returns number

getChildren

getChildren(objectId: string): (MapLayer | MapGroup)[]

Parameters
- objectId: string
Returns (MapLayer | MapGroup)[]

getCurrentScale

getCurrentScale(): number

Returns number

getFilterText

getFilterText(): string

Returns string

getGroupExpanded

getGroupExpanded(groupId: string): boolean

Parameters
- groupId: string
Returns boolean

getGroupVisibility

getGroupVisibility(group: MapGroup): boolean

Parameters
- group: MapGroup
Returns boolean

getIconMimeType

getIconMimeType(): undefined | string

Returns undefined | string

getLayerExpanded

getLayerExpanded(layerId: string): boolean

Parameters
- layerId: string
Returns boolean

getLayerSelectability

getLayerSelectability(layerId: string): boolean

Parameters
- layerId: string
Returns boolean

getLayerVisibility

getLayerVisibility(layer: MapLayer): boolean

Parameters
- layer: MapLayer
Returns boolean

getLocale

getLocale(): string

Returns string

getMapName

getMapName(): undefined | string

Returns undefined | string

getSessionId

getSessionId(): undefined | string

since
0.14.9

Returns undefined | string

getTree

getTree(): any

Returns any

isFiltering

isFiltering(): boolean

Returns boolean

Optional provideExtraGroupIconsHtml

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

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

since
0.14.9

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

since
0.14.9

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

setGroupExpanded

setGroupExpanded(groupId: string, expanded: boolean): void

Parameters
- groupId: string
- expanded: boolean
Returns void

setGroupVisibility

setGroupVisibility(groupId: string, visible: boolean): void

Parameters
- groupId: string
- visible: boolean
Returns void

setLayerExpanded

setLayerExpanded(layerId: string, expanded: boolean): void

Parameters
- layerId: string
- expanded: boolean
Returns void

setLayerSelectability

setLayerSelectability(layerId: string, selectable: boolean): void

Parameters
- layerId: string
- selectable: boolean
Returns void

setLayerVisibility

setLayerVisibility(layerId: string, visible: boolean): void

Parameters
- layerId: string
- visible: boolean
Returns void

Generated using TypeDoc