Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Legend

The Legend component provides a component to view the layer structure, its styles and thematics and the ability to toggle the group/layer visibility of the current map

export
class

Legend

extends

{React.Component}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

context

context: any

props

props: Readonly<object> & Readonly<ILegendProps>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<any>

Static childContextTypes

childContextTypes: any = LEGEND_CONTEXT_VALIDATION_MAP

Methods

componentWillReceiveProps

forceUpdate

  • forceUpdate(callBack?: undefined | function): void

  • Parameters

    • Optional callBack: undefined | function

    Returns void

getChildContext

getSelectableLayers

  • getSelectableLayers(): string[]

  • Returns string[]

render

  • render(): Element

  • Returns Element

setState

  • setState<K>(f: function, callback?: undefined | function): void
  • setState<K>(state: Pick<any, K>, callback?: undefined | function): void

  • Type parameters

    • K: keyof S

    Parameters

    • f: function

        • Parameters

          Returns Pick<any, K>

    • Optional callback: undefined | function

    Returns void

  • Type parameters

    • K: keyof S

    Parameters

    • state: Pick<any, K>
    • Optional callback: undefined | function

    Returns void

Static Optional componentDidMount

  • componentDidMount(): void

  • Returns void

Static Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<ILegendProps>, prevState: Readonly<any>, prevContext: any): void

  • Parameters

    • prevProps: Readonly<ILegendProps>
    • prevState: Readonly<any>
    • prevContext: any

    Returns void

Static Optional componentWillMount

  • componentWillMount(): void

  • Returns void

Static Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<ILegendProps>, nextContext: any): void

  • Parameters

    Returns void

Static Optional componentWillUnmount

  • componentWillUnmount(): void

  • Returns void

Static Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<ILegendProps>, nextState: Readonly<any>, nextContext: any): void

  • Parameters

    • nextProps: Readonly<ILegendProps>
    • nextState: Readonly<any>
    • nextContext: any

    Returns void

Static Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<ILegendProps>, nextState: Readonly<any>, nextContext: any): boolean

  • Parameters

    • nextProps: Readonly<ILegendProps>
    • nextState: Readonly<any>
    • nextContext: any

    Returns boolean

Generated using TypeDoc