SpikeLayerToolDefaults

geovisto-map • Readme | API

---

geovisto-map / SpikeLayerToolDefaults

Class: SpikeLayerToolDefaults

This class provide functions which return the default state values.

Author

Vladimir Korencik

Extends

• LayerToolDefaults

Implements

• ISpikeLayerToolDefaults

Constructors

new SpikeLayerToolDefaults()

new SpikeLayerToolDefaults(): SpikeLayerToolDefaults

Returns

SpikeLayerToolDefaults

Inherited from

LayerToolDefaults.constructor

Properties

idString?

protected optional idString: string

Inherited from

LayerToolDefaults.idString

Source

model/internal/object/MapObjectDefaults.ts:13

---

TYPE

static TYPE: string = "geovisto-tool-layer-bubble"

A unique string of the tool type.

Overrides

LayerToolDefaults.TYPE

Source

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

---

id

static protected id: number

Inherited from

LayerToolDefaults.id

Source

model/internal/object/MapObjectDefaults.ts:12

Methods

generateId()

protected generateId(): string

It returns identifier which is used when no identifier is specified.

Returns

string

Inherited from

LayerToolDefaults.generateId

Source

model/internal/object/MapObjectDefaults.ts:54

---

getAggregationDimension()

getAggregationDimension(): IMapDomainDimension\<IMapAggregationFunction>

Returns

IMapDomainDimension\<IMapAggregationFunction>

Implementation of

ISpikeLayerToolDefaults.getAggregationDimension

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:109

---

getCategoryColorDimension()

getCategoryColorDimension(): IMapTypeDimension\<string, ITypeManager\<string>>

Returns

IMapTypeDimension\<string, ITypeManager\<string>>

Implementation of

ISpikeLayerToolDefaults.getCategoryColorDimension

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:148

---

getCategoryColorOperationDimension()

getCategoryColorOperationDimension(): IMapDomainDimension\<IMapFilterOperation>

Returns

IMapDomainDimension\<IMapFilterOperation>

Implementation of

ISpikeLayerToolDefaults.getCategoryColorOperationDimension

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:130

---

getCategoryColorValueDimension()

getCategoryColorValueDimension(): IMapTypeDimension\<string, ITypeManager\<string>>

Returns

IMapTypeDimension\<string, ITypeManager\<string>>

Implementation of

ISpikeLayerToolDefaults.getCategoryColorValueDimension

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:144

---

getCategoryDimension()

getCategoryDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters

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

Returns

IMapDomainDimension\<IMapDataDomain>

Implementation of

ISpikeLayerToolDefaults.getCategoryDimension

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:93

---

getColorDimension()

getColorDimension(): IMapTypeDimension\<string, ITypeManager\<string>>

Returns

IMapTypeDimension\<string, ITypeManager\<string>>

Implementation of

ISpikeLayerToolDefaults.getColorDimension

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:122

---

getConfig()

getConfig(): IMapToolConfig

By defaults it returns the config with undefined props.

Returns

IMapToolConfig

Implementation of

ISpikeLayerToolDefaults.getConfig

Inherited from

LayerToolDefaults.getConfig

Source

model/internal/tool/MapToolDefaults.ts:34

---

getDataManager()

getDataManager(): IMapDataManager

It returns default map data manager.

Returns

IMapDataManager

Inherited from

LayerToolDefaults.getDataManager

Source

model/internal/tool/MapToolDefaults.ts:20

---

getDimensions()

getDimensions(map?): object

It returns list of map dimensions.

Parameters

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

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

ISpikeLayerToolDefaults.getDimensions

Overrides

LayerToolDefaults.getDimensions

Source

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

---

getFiltersManager()

getFiltersManager(): IMapFilterManager

Returns

IMapFilterManager

Implementation of

ISpikeLayerToolDefaults.getFiltersManager

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:53

---

getGeoDataManager()

getGeoDataManager(geoDataArray): IGeoDataManager

It returns default geo data manager.

Parameters

• geoDataArray: undefined | IGeoData[]

Returns

IGeoDataManager

Inherited from

LayerToolDefaults.getGeoDataManager

Source

model/internal/tool/MapToolDefaults.ts:27

---

getIcon()

getIcon(): string

It returns the icon of the tool.

Returns

string

Implementation of

ISpikeLayerToolDefaults.getIcon

Overrides

LayerToolDefaults.getIcon

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:49

---

getId()

getId(): string

It returns identifier which is used when no identifier is specified.

Returns

string

Implementation of

ISpikeLayerToolDefaults.getId

Inherited from

LayerToolDefaults.getId

Source

model/internal/object/MapObjectDefaults.ts:44

---

getLabel()

getLabel(): string

It returns the label of the tool.

Returns

string

Implementation of

ISpikeLayerToolDefaults.getLabel

Overrides

LayerToolDefaults.getLabel

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:45

---

getLatitudeDimension()

getLatitudeDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters

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

Returns

IMapDomainDimension\<IMapDataDomain>

Implementation of

ISpikeLayerToolDefaults.getLatitudeDimension

Source

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

---

getLayerName()

getLayerName(): string

It returns the layer name.

Returns

string

Implementation of

ISpikeLayerToolDefaults.getLayerName

Overrides

LayerToolDefaults.getLayerName

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:41

---

getLongitudeDimension()

getLongitudeDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters

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

Returns

IMapDomainDimension\<IMapDataDomain>

Implementation of

ISpikeLayerToolDefaults.getLongitudeDimension

Source

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

---

getProps()

getProps(): IMapObjectProps

It returns default props if no props are given.

Returns

IMapObjectProps

Implementation of

ISpikeLayerToolDefaults.getProps

Inherited from

LayerToolDefaults.getProps

Source

model/internal/object/MapObjectDefaults.ts:18

---

getType()

getType(): string

It returns a unique type string of the map object.

Returns

string

Implementation of

ISpikeLayerToolDefaults.getType

Overrides

LayerToolDefaults.getType

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:37

---

getValueDimension()

getValueDimension(map?): IMapDomainDimension\<IMapDataDomain>

Parameters

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

Returns

IMapDomainDimension\<IMapDataDomain>

Implementation of

ISpikeLayerToolDefaults.getValueDimension

Source

tools/layers/spike/model/internal/tool/SpikeLayerToolDefaults.ts:101

---

isEnabled()

isEnabled(): boolean

By default, the tool is enabled.

Returns

boolean

Implementation of

ISpikeLayerToolDefaults.isEnabled

Inherited from

LayerToolDefaults.isEnabled

Source

model/internal/tool/MapToolDefaults.ts:50

---

isSingleton()

isSingleton(): boolean

By default, the tool is singleton

Returns

boolean

Implementation of

ISpikeLayerToolDefaults.isSingleton

Inherited from

LayerToolDefaults.isSingleton

Source

model/internal/tool/MapToolDefaults.ts:43