HeatLayerToolState

geovisto-map • Readme | API

---

geovisto-map / HeatLayerToolState

Class: HeatLayerToolState

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

Author

Vladimir Korencik

Extends

• LayerToolState

Implements

• IHeatLayerToolState

Constructors

new HeatLayerToolState()

new HeatLayerToolState(tool): HeatLayerToolState

Parameters

• tool: IHeatLayerTool\<IHeatLayerToolProps, IHeatLayerToolDefaults, IHeatLayerToolState\<IHeatLayerToolProps, IHeatLayerToolDefaults, IHeatLayerToolConfig, object, object>, IHeatLayerToolConfig, IMapToolInitProps\<IHeatLayerToolConfig>>

Returns

HeatLayerToolState

Overrides

LayerToolState.constructor

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:36

Properties

latlngs

private latlngs: any[]

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:32

---

layer?

private optional layer: any

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:29

---

layers

private layers: HeatLayer[]

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:30

---

manager

private manager: IMapFilterManager

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:34

---

options

private options: HeatMapOptions

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:33

---

radiusRules

private radiusRules: IReactiveRadiusRules[]

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:31

Methods

deserialize()

deserialize(config): void

The metod takes config and deserializes the values.

Parameters

• config: IHeatLayerToolConfig

Returns

void

Implementation of

IHeatLayerToolState.deserialize

Overrides

LayerToolState.deserialize

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:105

---

deserializeDimensions()

deserializeDimensions(dimensionsConfig): void

It sets the marker layer dimensions property of tool state.

Parameters

• dimensionsConfig

• dimensionsConfig.blur?: number

• dimensionsConfig.gradient?: string

• dimensionsConfig.intensity?: string

• dimensionsConfig.latitude?: string

• dimensionsConfig.longitude?: string

• dimensionsConfig.radius?: number

• dimensionsConfig.reactiveOp?: string

• dimensionsConfig.reactiveRadius?: number

• dimensionsConfig.reactiveZoom?: number

• dimensionsConfig.zoom?: string

Returns

void

Implementation of

IHeatLayerToolState.deserializeDimensions

Overrides

LayerToolState.deserializeDimensions

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:132

---

getDimensions()

getDimensions(): object

It returns the layer dimensions property of the tool state.

Returns

object

blur

blur: IMapTypeDimension\<number, ITypeManager\<number>>

currentZoom

currentZoom: IMapTypeDimension\<number, ITypeManager\<number>>

gradient

gradient: IMapDomainDimension\<IGradient>

intensity

intensity: IMapDomainDimension\<IMapDataDomain>

latitude

latitude: IMapDomainDimension\<IMapDataDomain>

longitude

longitude: IMapDomainDimension\<IMapDataDomain>

radius

radius: IMapTypeDimension\<number, ITypeManager\<number>>

reactiveOp

reactiveOp: IMapDomainDimension\<IMapFilterOperation>

reactiveRadius

reactiveRadius: IMapTypeDimension\<number, ITypeManager\<number>>

reactiveZoom

reactiveZoom: IMapTypeDimension\<number, ITypeManager\<number>>

zoom

zoom: IMapDomainDimension\<IZoomLevel>

Implementation of

IHeatLayerToolState.getDimensions

Overrides

LayerToolState.getDimensions

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:229

---

getFiltersManager()

getFiltersManager(): IMapFilterManager

Returns

IMapFilterManager

Implementation of

IHeatLayerToolState.getFiltersManager

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:219

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

IHeatLayerToolState.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

IHeatLayerToolState.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

IHeatLayerToolState.getLabel

Inherited from

LayerToolState.getLabel

Source

model/internal/tool/MapToolState.ts:104

---

getLatlngsData()

getLatlngsData(): any[]

Returns

any[]

Implementation of

IHeatLayerToolState.getLatlngsData

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:265

---

getLayer()

getLayer(): any

Returns

any

Implementation of

IHeatLayerToolState.getLayer

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:237

---

getLayerItems()

getLayerItems(): undefined | Layer[]

It returns the layer items property of the tool state.

Returns

undefined | Layer[]

Implementation of

IHeatLayerToolState.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

IHeatLayerToolState.getLayerName

Inherited from

LayerToolState.getLayerName

Source

model/internal/layer/LayerToolState.ts:88

---

getLayers()

getLayers(): HeatLayer[]

Returns

HeatLayer[]

Implementation of

IHeatLayerToolState.getLayers

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:241

---

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

IHeatLayerToolState.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

---

getOptions()

getOptions(): HeatMapOptions

Returns

HeatMapOptions

Implementation of

IHeatLayerToolState.getOptions

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:273

---

getReactiveRadiusRules()

getReactiveRadiusRules(): IReactiveRadiusRules[]

Returns

IReactiveRadiusRules[]

Implementation of

IHeatLayerToolState.getReactiveRadiusRules

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:257

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

IHeatLayerToolState.getType

Inherited from

LayerToolState.getType

Source

model/internal/object/MapObjectState.ts:80

---

initialize()

initialize(defaults, props, initProps): void

It resets the state with respect to the initial props.

Parameters

• defaults: IHeatLayerToolDefaults

• props: IHeatLayerToolProps

• initProps: IMapToolInitProps\<IHeatLayerToolConfig>

Returns

void

Implementation of

IHeatLayerToolState.initialize

Overrides

LayerToolState.initialize

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:44

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

IHeatLayerToolState.isEnabled

Inherited from

LayerToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

serialize()

serialize(defaults): IHeatLayerToolConfig

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

Parameters

• defaults: undefined | IHeatLayerToolDefaults

Returns

IHeatLayerToolConfig

Implementation of

IHeatLayerToolState.serialize

Overrides

LayerToolState.serialize

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:185

---

setDimensions()

setDimensions(dimensions): void

It sets the layer dimensions property of tool state.

Parameters

• dimensions

• dimensions.blur: IMapTypeDimension\<number, ITypeManager\<number>>

• dimensions.currentZoom: IMapTypeDimension\<number, ITypeManager\<number>>

• dimensions.gradient: IMapDomainDimension\<IGradient>

• dimensions.intensity: IMapDomainDimension\<IMapDataDomain>

• dimensions.latitude: IMapDomainDimension\<IMapDataDomain>

• dimensions.longitude: IMapDomainDimension\<IMapDataDomain>

• dimensions.radius: IMapTypeDimension\<number, ITypeManager\<number>>

• dimensions.reactiveOp: IMapDomainDimension\<IMapFilterOperation>

• dimensions.reactiveRadius: IMapTypeDimension\<number, ITypeManager\<number>>

• dimensions.reactiveZoom: IMapTypeDimension\<number, ITypeManager\<number>>

• dimensions.zoom: IMapDomainDimension\<IZoomLevel>

Returns

void

Implementation of

IHeatLayerToolState.setDimensions

Overrides

LayerToolState.setDimensions

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:233

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

IHeatLayerToolState.setEnabled

Inherited from

LayerToolState.setEnabled

Source

model/internal/tool/MapToolState.ts:97

---

setFiltersManager()

setFiltersManager(manager): void

Parameters

• manager: IMapFilterManager

Returns

void

Implementation of

IHeatLayerToolState.setFiltersManager

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:224

---

setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

• icon: string

Returns

void

Implementation of

IHeatLayerToolState.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

IHeatLayerToolState.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

IHeatLayerToolState.setLabel

Inherited from

LayerToolState.setLabel

Source

model/internal/tool/MapToolState.ts:113

---

setLatlngsData()

setLatlngsData(latlngs): void

Parameters

• latlngs: any[]

Returns

void

Implementation of

IHeatLayerToolState.setLatlngsData

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:261

---

setLayer()

setLayer(layer): void

Parameters

• layer: LayerGroup

Returns

void

Implementation of

IHeatLayerToolState.setLayer

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:245

---

setLayerItems()

setLayerItems(layerItems): void

It sets the layer items property of tool state.

Parameters

• layerItems: Layer[]

Returns

void

Implementation of

IHeatLayerToolState.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

IHeatLayerToolState.setLayerName

Inherited from

LayerToolState.setLayerName

Source

model/internal/layer/LayerToolState.ts:97

---

setLayers()

setLayers(layers): void

Parameters

• layers: HeatLayer[]

Returns

void

Implementation of

IHeatLayerToolState.setLayers

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:249

---

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

---

setOptions()

setOptions(options): void

Parameters

• options: HeatMapOptions

Returns

void

Implementation of

IHeatLayerToolState.setOptions

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:269

---

setReactiveRadiusRules()

setReactiveRadiusRules(rules): void

Parameters

• rules: IReactiveRadiusRules[]

Returns

void

Implementation of

IHeatLayerToolState.setReactiveRadiusRules

Source

tools/layers/heat/model/internal/tool/HeatLayerToolState.ts:253