ChoroplethLayerToolMapLegend

geovisto-map • Readme | API

---

geovisto-map / ChoroplethLayerToolMapLegend

Class: ChoroplethLayerToolMapLegend

This class provides controls for management of the layer legend.

Author

Tomas Koscielniak

Extends

• MapLayerToolLegend\<IChoroplethLayerTool>

Implements

• IMapLegend

Constructors

new ChoroplethLayerToolMapLegend()

new ChoroplethLayerToolMapLegend(tool): ChoroplethLayerToolMapLegend

It creates new map Legend with respect to the given props.

Parameters

• tool: IChoroplethLayerTool\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolState\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolConfig, object, object>, IChoroplethLayerToolConfig, IMapToolInitProps\<IChoroplethLayerToolConfig>>

Returns

ChoroplethLayerToolMapLegend

Overrides

MapLayerToolLegend.constructor

Source

tools/layers/choropleth/model/internal/legend/ChoroplethLayerToolMapLegend.ts:24

Properties

htmlContent

private htmlContent: HTMLElement

Source

tools/layers/choropleth/model/internal/legend/ChoroplethLayerToolMapLegend.ts:17

Methods

getContent()

getContent(tool): undefined | HTMLElement

It returns the legend.

Parameters

• tool: IChoroplethLayerTool\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolState\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolConfig, object, object>, IChoroplethLayerToolConfig, IMapToolInitProps\<IChoroplethLayerToolConfig>>

Returns

undefined | HTMLElement

Implementation of

IMapLegend.getContent

Overrides

MapLayerToolLegend.getContent

Source

tools/layers/choropleth/model/internal/legend/ChoroplethLayerToolMapLegend.ts:31

---

getMapObject()

protected getMapObject(): IChoroplethLayerTool\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolState\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolConfig, object, object>, IChoroplethLayerToolConfig, IMapToolInitProps\<IChoroplethLayerToolConfig>>

Returns

IChoroplethLayerTool\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolState\<IChoroplethLayerToolProps, IChoroplethLayerToolDefaults, IChoroplethLayerToolConfig, object, object>, IChoroplethLayerToolConfig, IMapToolInitProps\<IChoroplethLayerToolConfig>>

Inherited from

MapLayerToolLegend.getMapObject

Source

model/internal/legend/MapObjectLegend.ts:17