IChoroplethLayerToolState

geovisto-map • Readme | API

---

geovisto-map / IChoroplethLayerToolState

Interface: IChoroplethLayerToolState\<TProps, TDefaults, TConfig, TDimensionsConfig, TDimensions>

This interface declares functions for using the state of the layer tool.

Author

Jiri Hynek

Extends

• ILayerToolState\<TProps, TDefaults, TConfig, TDimensionsConfig, TDimensions>

Type parameters

• TProps extends IChoroplethLayerToolProps = IChoroplethLayerToolProps

• TDefaults extends IChoroplethLayerToolDefaults = IChoroplethLayerToolDefaults

• TConfig extends IChoroplethLayerToolConfig = IChoroplethLayerToolConfig

• TDimensionsConfig extends IChoroplethLayerToolDimensionsConfig = IChoroplethLayerToolDimensionsConfig

• TDimensions extends IChoroplethLayerToolDimensions = IChoroplethLayerToolDimensions

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: TConfig

Returns

void

Inherited from

ILayerToolState.deserialize

Source

model/types/object/IMapObjectState.ts:32

---

deserializeDimensions()

deserializeDimensions(dimensionsConfig): void

It sets the marker layer dimensions property of tool state.

Parameters

• dimensionsConfig: TDimensionsConfig

Returns

void

Inherited from

ILayerToolState.deserializeDimensions

Source

model/types/layer/ILayerToolState.ts:25

---

getBucketData()

getBucketData(): Map\<string, IMapAggregationBucket>

It returns the bucket data.

Returns

Map\<string, IMapAggregationBucket>

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolState.ts:66

---

getDimensions()

getDimensions(): TDimensions

It returns the layer dimensions property of the tool state.

Returns

TDimensions

Inherited from

ILayerToolState.getDimensions

Source

model/types/layer/ILayerToolState.ts:30

---

getGeoJSONLayer()

getGeoJSONLayer(): any

It returns a Leaflet geoJSON layer.

Returns

any

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolState.ts:28

---

getHoveredItem()

getHoveredItem(): undefined | string

It returns the hovered item.

Returns

undefined | string

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolState.ts:40

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Inherited from

ILayerToolState.getIcon

Source

model/types/tool/IMapToolState.ts:61

---

getId()

getId(): string

It returns the id property of the map object state.

Returns

string

Inherited from

ILayerToolState.getId

Source

model/types/object/IMapObjectState.ts:49

---

getLabel()

getLabel(): string

It returns the label property of the tool state.

Returns

string

Inherited from

ILayerToolState.getLabel

Source

model/types/tool/IMapToolState.ts:49

---

getLayerItems()

getLayerItems(): undefined | Layer[]

It returns the layer items property of the tool state.

Returns

undefined | Layer[]

Inherited from

ILayerToolState.getLayerItems

Source

model/types/layer/ILayerToolState.ts:54

---

getLayerName()

getLayerName(): string

It returns the layer name property of the tool state.

Returns

string

Inherited from

ILayerToolState.getLayerName

Source

model/types/layer/ILayerToolState.ts:42

---

getMap()

getMap(): undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

It returns the map property of the tool state.

Returns

undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Inherited from

ILayerToolState.getMap

Source

model/types/tool/IMapToolState.ts:44

---

getType()

getType(): string

It returns the type property of the map object state.

Returns

string

Inherited from

ILayerToolState.getType

Source

model/types/object/IMapObjectState.ts:44

---

getZIndex()

getZIndex(): number

It returns the z index.

Returns

number

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolState.ts:52

---

initialize()

initialize(defaults, props, initProps): void

It resets the state with respect to the initial props.

Parameters

• defaults: TDefaults

• props: TProps

• initProps: IMapToolInitProps\<TConfig>

Returns

void

Inherited from

ILayerToolState.initialize

Source

model/types/tool/IMapToolState.ts:27

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Inherited from

ILayerToolState.isEnabled

Source

model/types/tool/IMapToolState.ts:32

---

serialize()

serialize(defaults): TConfig

The method serializes the map object state. Optionally, a serialized value can be let undefined if it equals the default value.

Parameters

• defaults: undefined | TDefaults

Returns

TConfig

Inherited from

ILayerToolState.serialize

Source

model/types/object/IMapObjectState.ts:39

---

setBucketData()

setBucketData(bucketData): void

It sets the bucket data.

Parameters

• bucketData: Map\<string, IMapAggregationBucket>

Returns

void

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolState.ts:73

---

setDimensions()

setDimensions(dimensions): void

It sets the layer dimensions property of tool state.

Parameters

• dimensions: TDimensions

Returns

void

Inherited from

ILayerToolState.setDimensions

Source

model/types/layer/ILayerToolState.ts:37

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Inherited from

ILayerToolState.setEnabled

Source

model/types/tool/IMapToolState.ts:39

---

setGeoJSONLayer()

setGeoJSONLayer(layer): void

It sets a Leaflet geoJSON layer.

Parameters

• layer: GeoJSON

Returns

void

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolState.ts:35

---

setHoveredItem()

setHoveredItem(hoveredItem): void

It sets the hovered item.

Parameters

• hoveredItem: undefined | string

Returns

void

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolState.ts:47

---

setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

• icon: string

Returns

void

Inherited from

ILayerToolState.setIcon

Source

model/types/tool/IMapToolState.ts:68

---

setId()

setId(id): void

It sets the id property of the map object state. It can be set only once.

Parameters

• id: string

Returns

void

Inherited from

ILayerToolState.setId

Source

model/types/object/IMapObjectState.ts:57

---

setLabel()

setLabel(label): void

It sets the label property of the tool state.

Parameters

• label: string

Returns

void

Inherited from

ILayerToolState.setLabel

Source

model/types/tool/IMapToolState.ts:56

---

setLayerItems()

setLayerItems(layerItems): void

It sets the layer items property of tool state.

Parameters

• layerItems: Layer[]

Returns

void

Inherited from

ILayerToolState.setLayerItems

Source

model/types/layer/ILayerToolState.ts:61

---

setLayerName()

setLayerName(layerName): void

It sets the layer name property of the tool state.

Parameters

• layerName: string

Returns

void

Inherited from

ILayerToolState.setLayerName

Source

model/types/layer/ILayerToolState.ts:49

---

setZIndex()

setZIndex(zindex): void

It sets the z index.

Parameters

• zindex: number

Returns

void

Source

tools/layers/choropleth/model/types/tool/IChoroplethLayerToolState.ts:59