SpikeLayerTool

geovisto-map • Readme | API

---

geovisto-map / SpikeLayerTool

Class: SpikeLayerTool

This class represents Heat layer tool. It works with d3 to create spike icons Icons are created SpikeIcon

Author

Vladimir Korencik

Author

Petr Kaspar

Extends

• AbstractLayerTool

Implements

• ISpikeLayerTool
• IMapFormControl

Constructors

new SpikeLayerTool()

new SpikeLayerTool(props?): SpikeLayerTool

Parameters

• props?: ISpikeLayerToolProps

Returns

SpikeLayerTool

Overrides

AbstractLayerTool.constructor

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:61

Properties

mapForm

private mapForm: IMapForm

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:58

---

max

private max: number

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:59

---

selectionToolAPI

private selectionToolAPI: undefined | ISelectionToolAPI

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:57

Methods

aggregateValues()

private aggregateValues(dataItem, aggregationDimension, foundValue): void

Parameters

• dataItem: any

• aggregationDimension: IMapAggregationFunction

• foundValue: number

Returns

void

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:253

---

calculateHeight()

private calculateHeight(height): number

Parameters

• height: number

Returns

number

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:322

---

copy()

copy(): ISpikeLayerTool\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolState\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolConfig, object, object>, ISpikeLayerToolConfig, IMapToolInitProps\<ISpikeLayerToolConfig>>

It creates a copy of the uninitialized tool.

Returns

ISpikeLayerTool\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolState\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolConfig, object, object>, ISpikeLayerToolConfig, IMapToolInitProps\<ISpikeLayerToolConfig>>

Implementation of

ISpikeLayerTool.copy

Overrides

AbstractLayerTool.copy

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:67

---

create()

create(): this

It creates new layer with respect to configuration

Returns

this

Implementation of

ISpikeLayerTool.create

Inherited from

AbstractLayerTool.create

Source

model/internal/layer/AbstractLayerTool.ts:89

---

createDefaults()

protected createDefaults(): ISpikeLayerToolDefaults

It creates new defaults of the layer tool.

Returns

ISpikeLayerToolDefaults

Overrides

AbstractLayerTool.createDefaults

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:83

---

createLayerItems()

protected createLayerItems(): LayerGroup[]

It creates layer items.

Override this function.

Returns

LayerGroup[]

Overrides

AbstractLayerTool.createLayerItems

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:118

---

createMapForm()

protected createMapForm(): IMapForm

Returns

IMapForm

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:110

---

createMarker()

protected createMarker(data): any

Parameters

• data: any

Returns

any

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:296

---

createMarkers()

protected createMarkers(): void

Returns

void

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:278

---

createState()

protected createState(): ISpikeLayerToolState\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolConfig, object, object>

It creates new defaults of the layer tool.

Returns

ISpikeLayerToolState\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolConfig, object, object>

Overrides

AbstractLayerTool.createState

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:87

---

getAPIGetter()

getAPIGetter(): undefined | IMapToolAPIGetter

It returns the tool API

Returns

undefined | IMapToolAPIGetter

Implementation of

ISpikeLayerTool.getAPIGetter

Inherited from

AbstractLayerTool.getAPIGetter

Source

model/internal/tool/MapTool.ts:74

---

getDefaults()

getDefaults(): ISpikeLayerToolDefaults

It returns default values of the state properties.

Returns

ISpikeLayerToolDefaults

Implementation of

ISpikeLayerTool.getDefaults

Overrides

AbstractLayerTool.getDefaults

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:75

---

getId()

getId(): string

Help function which returns the id of the object.

Returns

string

Implementation of

ISpikeLayerTool.getId

Inherited from

AbstractLayerTool.getId

Source

model/internal/object/MapObject.ts:93

---

getLayerItems()

getLayerItems(): Layer[]

It returns layer items which should be rendered.

Returns

Layer[]

Implementation of

ISpikeLayerTool.getLayerItems

Inherited from

AbstractLayerTool.getLayerItems

Source

model/internal/layer/AbstractLayerTool.ts:163

---

getMap()

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

Help function returns map which uses this tool.

Do not override this function. Use the state class instead.

Returns

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

Implementation of

ISpikeLayerTool.getMap

Inherited from

AbstractLayerTool.getMap

Source

model/internal/tool/MapTool.ts:112

---

getMapForm()

getMapForm(): IMapForm

It returns a map control.

Returns

IMapForm

Implementation of

IMapFormControl.getMapForm

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:103

---

getProps()

getProps(): ISpikeLayerToolProps

It returns the props given by the programmer.

Returns

ISpikeLayerToolProps

Implementation of

ISpikeLayerTool.getProps

Overrides

AbstractLayerTool.getProps

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:71

---

getSelectionTool()

private getSelectionTool(): undefined | ISelectionToolAPI

Returns

undefined | ISelectionToolAPI

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:91

---

getState()

getState(): ISpikeLayerToolState\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolConfig, object, object>

It returns the map object state.

Returns

ISpikeLayerToolState\<ISpikeLayerToolProps, ISpikeLayerToolDefaults, ISpikeLayerToolConfig, object, object>

Implementation of

ISpikeLayerTool.getState

Overrides

AbstractLayerTool.getState

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:79

---

getType()

getType(): string

Help function which returns the type of the object.

Returns

string

Implementation of

ISpikeLayerTool.getType

Inherited from

AbstractLayerTool.getType

Source

model/internal/object/MapObject.ts:86

---

handleEvent()

handleEvent(event): void

This function is called when a custom event is invoked.

Override this function, if needed.

Parameters

• event: IMapEvent\<IMapObject\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectState\<IMapObjectProps, IMapObjectDefaults\<IMapObjectProps, IMapObjectConfig>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>, IMapObjectConfig, IMapObjectInitProps\<IMapObjectConfig>>>

Returns

void

Overrides

AbstractLayerTool.handleEvent

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:373

---

hideLayerItems()

protected hideLayerItems(): void

Help function which hides layer items

This function is meant to be private.

Returns

void

Inherited from

AbstractLayerTool.hideLayerItems

Source

model/internal/layer/AbstractLayerTool.ts:147

---

initialize()

initialize(initProps): this

It initializes the state of the object. It processes the serialized config and sets further objects.

This cannot be done in the object constructor since the object can be created before the Geovisto map is created.

Parameters

• initProps: IMapToolInitProps\<ISpikeLayerToolConfig>

Returns

this

Implementation of

ISpikeLayerTool.initialize

Overrides

AbstractLayerTool.initialize

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:114

---

isEnabled()

isEnabled(): boolean

Help getter which returns enabled property of state.

Do not override this function. Use the state class instead.

Returns

boolean

Implementation of

ISpikeLayerTool.isEnabled

Inherited from

AbstractLayerTool.isEnabled

Source

model/internal/tool/MapTool.ts:130

---

isSingleton()

isSingleton(): boolean

Help getter which returns a logtical value whether the tool type is singleton.

Returns

boolean

Implementation of

ISpikeLayerTool.isSingleton

Inherited from

AbstractLayerTool.isSingleton

Source

model/internal/tool/MapTool.ts:81

---

render()

render(type): void

It reloads data and redraw the layer with respect to the type.

By default it works with LayerRedrawType

Parameters

• type: number

Returns

void

Implementation of

ISpikeLayerTool.render

Overrides

AbstractLayerTool.render

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:328

---

setCategoryColor()

private setCategoryColor(dataItem, category): void

Parameters

• dataItem: any

• category: string

Returns

void

Source

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

---

setEnabled()

setEnabled(enabled): void

It changes layer state to enabled/disabled.

Parameters

• enabled: boolean

Returns

void

Implementation of

ISpikeLayerTool.setEnabled

Inherited from

AbstractLayerTool.setEnabled

Source

model/internal/layer/AbstractLayerTool.ts:102

---

setProps()

protected setProps(props): void

It updates the props.

Parameters

• props: IMapObjectProps

Returns

void

Inherited from

AbstractLayerTool.setProps

Source

model/internal/object/MapObject.ts:38

---

showLayerItems()

protected showLayerItems(): void

Help function which shows layer items.

This function is meant to be private.

Returns

void

Inherited from

AbstractLayerTool.showLayerItems

Source

model/internal/layer/AbstractLayerTool.ts:126

---

switchEnabled()

switchEnabled(): void

Help function which switches enabled state (enabled/disabled).

Do not override this function. Use setEnabled instead.

Returns

void

Implementation of

ISpikeLayerTool.switchEnabled

Inherited from

AbstractLayerTool.switchEnabled

Source

model/internal/tool/MapTool.ts:158

---

updateData()

protected updateData(): void

Returns

void

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:133

---

updateDimension()

updateDimension(dimension, value, redraw): void

It updates the dimension.

Parameters

• dimension: IMapDomainDimension\<IMapDomain>

• value: string

• redraw: undefined | number

Returns

void

Implementation of

ISpikeLayerTool.updateDimension

Overrides

AbstractLayerTool.updateDimension

Source

tools/layers/spike/model/internal/tool/SpikeLayerTool.ts:348