SpikeLayerToolState

geovisto-map • Readme | API

---

geovisto-map / SpikeLayerToolState

Class: SpikeLayerToolState

This class provide functions for using the state of the layer tool.

Author

Vladimir Korencik

Extends

• LayerToolState

Implements

• ISpikeLayerToolState

Constructors

new SpikeLayerToolState()

new SpikeLayerToolState(tool): SpikeLayerToolState

Parameters

• tool: ISpikeLayerTool\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolState\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolConfig, object, object>, ISpikeLayerToolConfig, IMapToolInitProps\<ISpikeLayerToolConfig>>

Returns

SpikeLayerToolState

Overrides

LayerToolState.constructor

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:35

Properties

categoryColorRules

private categoryColorRules: ICategoryColorRules[]

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:32

---

layer?

private optional layer: any

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:29

---

manager

private manager: IMapFilterManager

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:33

---

markers

private markers: Marker[]

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:30

---

workData

private workData: any[]

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:31

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: ISpikeLayerToolConfig

Returns

void

Implementation of

ISpikeLayerToolState.deserialize

Overrides

LayerToolState.deserialize

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:96

---

deserializeDimensions()

deserializeDimensions(dimensionsConfig): void

It sets the marker layer dimensions property of tool state.

Parameters

• dimensionsConfig

• dimensionsConfig.aggregation?: string

• dimensionsConfig.category?: string

• dimensionsConfig.categoryColor?: string

• dimensionsConfig.categoryColorOp?: string

• dimensionsConfig.categoryColorValue?: string

• dimensionsConfig.color?: string

• dimensionsConfig.latitude?: string

• dimensionsConfig.longitude?: string

• dimensionsConfig.value?: string

Returns

void

Implementation of

ISpikeLayerToolState.deserializeDimensions

Overrides

LayerToolState.deserializeDimensions

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:123

---

getCategoryColorRules()

getCategoryColorRules(): ICategoryColorRules[]

Returns

ICategoryColorRules[]

Implementation of

ISpikeLayerToolState.getCategoryColorRules

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:244

---

getDimensions()

getDimensions(): object

It returns the layer dimensions property of the tool state.

Returns

object

aggregation

aggregation: IMapDomainDimension\<IMapAggregationFunction>

category

category: IMapDomainDimension\<IMapDataDomain>

categoryColor

categoryColor: IMapTypeDimension\<string, ITypeManager\<string>>

categoryColorOp

categoryColorOp: IMapDomainDimension\<IMapFilterOperation>

categoryColorValue

categoryColorValue: IMapTypeDimension\<string, ITypeManager\<string>>

color

color: IMapTypeDimension\<string, ITypeManager\<string>>

latitude

latitude: IMapDomainDimension\<IMapDataDomain>

longitude

longitude: IMapDomainDimension\<IMapDataDomain>

value

value: IMapDomainDimension\<IMapDataDomain>

Implementation of

ISpikeLayerToolState.getDimensions

Overrides

LayerToolState.getDimensions

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:216

---

getFiltersManager()

getFiltersManager(): IMapFilterManager

Returns

IMapFilterManager

Implementation of

ISpikeLayerToolState.getFiltersManager

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:207

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

ISpikeLayerToolState.getIcon

Inherited from

LayerToolState.getIcon

Source

model/internal/tool/MapToolState.ts:120

---

getId()

getId(): string

It returns the id property of the tool state.

Returns

string

Implementation of

ISpikeLayerToolState.getId

Inherited from

LayerToolState.getId

Source

model/internal/object/MapObjectState.ts:87

---

getLabel()

getLabel(): string

It returns the label property of the tool state.

Returns

string

Implementation of

ISpikeLayerToolState.getLabel

Inherited from

LayerToolState.getLabel

Source

model/internal/tool/MapToolState.ts:104

---

getLayer()

getLayer(): any

Returns

any

Implementation of

ISpikeLayerToolState.getLayer

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:224

---

getLayerItems()

getLayerItems(): undefined | Layer[]

It returns the layer items property of the tool state.

Returns

undefined | Layer[]

Implementation of

ISpikeLayerToolState.getLayerItems

Inherited from

LayerToolState.getLayerItems

Source

model/internal/layer/LayerToolState.ts:104

---

getLayerName()

getLayerName(): string

It returns the layer name property of the tool state.

Returns

string

Implementation of

ISpikeLayerToolState.getLayerName

Inherited from

LayerToolState.getLayerName

Source

model/internal/layer/LayerToolState.ts:88

---

getMap()

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

It returns the map property of the tool state.

Returns

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

Implementation of

ISpikeLayerToolState.getMap

Inherited from

LayerToolState.getMap

Source

model/internal/tool/MapToolState.ts:136

---

getMapObject()

protected getMapObject(): IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>

It makes the map object visible to extended classes.

Returns

IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>

Inherited from

LayerToolState.getMapObject

Source

model/internal/object/MapObjectState.ts:39

---

getMarkers()

getMarkers(): Marker[]

Returns

Marker[]

Implementation of

ISpikeLayerToolState.getMarkers

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:232

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

ISpikeLayerToolState.getType

Inherited from

LayerToolState.getType

Source

model/internal/object/MapObjectState.ts:80

---

getWorkData()

getWorkData(): any[]

Returns

any[]

Implementation of

ISpikeLayerToolState.getWorkData

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:252

---

initialize()

initialize(defaults, props, initProps): void

It resets the state with respect to the initial props.

Parameters

• defaults: ISpikeLayerToolDefaults

• props: ISpikeLayerToolProps

• initProps: IMapToolInitProps\<ISpikeLayerToolConfig>

Returns

void

Implementation of

ISpikeLayerToolState.initialize

Overrides

LayerToolState.initialize

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:43

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

ISpikeLayerToolState.isEnabled

Inherited from

LayerToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): ISpikeLayerToolConfig

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

Parameters

• defaults: undefined | ISpikeLayerToolDefaults

Returns

ISpikeLayerToolConfig

Implementation of

ISpikeLayerToolState.serialize

Overrides

LayerToolState.serialize

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:174

---

setCategoryColorRules()

setCategoryColorRules(rules): void

Parameters

• rules: ICategoryColorRules[]

Returns

void

Implementation of

ISpikeLayerToolState.setCategoryColorRules

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:240

---

setDimensions()

setDimensions(dimensions): void

It sets the layer dimensions property of tool state.

Parameters

• dimensions

• dimensions.aggregation: IMapDomainDimension\<IMapAggregationFunction>

• dimensions.category: IMapDomainDimension\<IMapDataDomain>

• dimensions.categoryColor: IMapTypeDimension\<string, ITypeManager\<string>>

• dimensions.categoryColorOp: IMapDomainDimension\<IMapFilterOperation>

• dimensions.categoryColorValue: IMapTypeDimension\<string, ITypeManager\<string>>

• dimensions.color: IMapTypeDimension\<string, ITypeManager\<string>>

• dimensions.latitude: IMapDomainDimension\<IMapDataDomain>

• dimensions.longitude: IMapDomainDimension\<IMapDataDomain>

• dimensions.value: IMapDomainDimension\<IMapDataDomain>

Returns

void

Implementation of

ISpikeLayerToolState.setDimensions

Overrides

LayerToolState.setDimensions

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:220

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

ISpikeLayerToolState.setEnabled

Inherited from

LayerToolState.setEnabled

Source

model/internal/tool/MapToolState.ts:97

---

setFiltersManager()

setFiltersManager(manager): void

Parameters

• manager: IMapFilterManager

Returns

void

Implementation of

ISpikeLayerToolState.setFiltersManager

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:211

---

setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

• icon: string

Returns

void

Implementation of

ISpikeLayerToolState.setIcon

Inherited from

LayerToolState.setIcon

Source

model/internal/tool/MapToolState.ts:129

---

setId()

setId(id): void

It sets the id property of the tool state.

Parameters

• id: string

Returns

void

Implementation of

ISpikeLayerToolState.setId

Inherited from

LayerToolState.setId

Source

model/internal/object/MapObjectState.ts:96

---

setLabel()

setLabel(label): void

It sets the label property of the tool state.

Parameters

• label: string

Returns

void

Implementation of

ISpikeLayerToolState.setLabel

Inherited from

LayerToolState.setLabel

Source

model/internal/tool/MapToolState.ts:113

---

setLayer()

setLayer(layer): void

Parameters

• layer: LayerGroup

Returns

void

Implementation of

ISpikeLayerToolState.setLayer

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:228

---

setLayerItems()

setLayerItems(layerItems): void

It sets the layer items property of tool state.

Parameters

• layerItems: Layer[]

Returns

void

Implementation of

ISpikeLayerToolState.setLayerItems

Inherited from

LayerToolState.setLayerItems

Source

model/internal/layer/LayerToolState.ts:113

---

setLayerName()

setLayerName(layerName): void

It sets the layer name property of the tool state.

Parameters

• layerName: string

Returns

void

Implementation of

ISpikeLayerToolState.setLayerName

Inherited from

LayerToolState.setLayerName

Source

model/internal/layer/LayerToolState.ts:97

---

setMap()

protected setMap(map): void

It sets the map property of the tool state.

Parameters

• map: IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>

Returns

void

Inherited from

LayerToolState.setMap

Source

model/internal/tool/MapToolState.ts:145

---

setMarkers()

setMarkers(markers): void

Parameters

• markers: Marker[]

Returns

void

Implementation of

ISpikeLayerToolState.setMarkers

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:236

---

setWorkData()

setWorkData(workData): void

Parameters

• workData: any[]

Returns

void

Implementation of

ISpikeLayerToolState.setWorkData

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolState.ts:248