Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ILegendProps

Legend component props

export
interface

ILegendProps

Hierarchy

  • ILegendProps

Index

Properties

Methods

Properties

Optional activeMapName

activeMapName?: string

Optional baseIconSize

baseIconSize?: number

currentScale

currentScale: number

Optional externalBaseLayers

externalBaseLayers?: IExternalBaseLayer[]

Optional externalLayers

externalLayers?: ILayerInfo[]

hideGroups

hideGroups: undefined | string[]

hideLayers

hideLayers: undefined | string[]

inlineBaseLayerSwitcher

inlineBaseLayerSwitcher: boolean

locale

locale: string

Optional map

map?: RuntimeMap
since

0.14 made optional

Optional maxHeight

maxHeight?: number

Optional onGroupVisibilityChanged

onGroupVisibilityChanged?: MapElementChangeFunc

Optional onLayerVisibilityChanged

onLayerVisibilityChanged?: MapElementChangeFunc

Optional overrideExpandedItems

overrideExpandedItems?: any

Optional overrideSelectableLayers

overrideSelectableLayers?: any

showGroups

showGroups: undefined | string[]

showLayers

showLayers: undefined | string[]

stateless

stateless: boolean

Methods

Optional onBaseLayerChanged

  • onBaseLayerChanged(name: string): undefined | void

  • Parameters

    • name: string

    Returns undefined | void

Optional onGroupExpansionChanged

  • onGroupExpansionChanged(id: string, expanded: boolean): undefined | void

  • Parameters

    • id: string
    • expanded: boolean

    Returns undefined | void

Optional onLayerSelectabilityChanged

  • onLayerSelectabilityChanged(id: string, selectable: boolean): undefined | void

  • Parameters

    • id: string
    • selectable: boolean

    Returns undefined | void

Optional provideExtraGroupIconsHtml

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

    since

    0.14.9

    Parameters

    Returns string[]

Optional provideExtraLayerIconsHtml

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

    since

    0.14.9

    Parameters

    Returns string[]

Generated using TypeDoc