TimelineToolState

geovisto-map • Readme | API

---

geovisto-map / TimelineToolState

Class: TimelineToolState

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

Author

Krystof Rykala

Extends

• LayerToolState

Implements

• ITimelineToolState

Constructors

new TimelineToolState()

new TimelineToolState(tool): TimelineToolState

It creates a tool state.

Parameters

• tool: ITimelineTool\<ITimelineToolProps, ITimelineToolDefaults, ITimelineToolState\<ITimelineToolProps, ITimelineToolDefaults, ITimelineToolConfig, ITimelineToolDimensionsConfig, object>, ITimelineToolConfig, IMapToolInitProps\<ITimelineToolConfig>>

Returns

TimelineToolState

Overrides

LayerToolState.constructor

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:21

Properties

stories

private stories: TimelineStoryConfig[] = []

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:16

Methods

createStory()

createStory(name): void

Parameters

• name: string

Returns

void

Implementation of

ITimelineToolState.createStory

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:192

---

deserialize()

deserialize(config): void

The method takes config and deserializes the values.

Parameters

• config: ITimelineToolConfig

Returns

void

Implementation of

ITimelineToolState.deserialize

Overrides

LayerToolState.deserialize

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:106

---

deserializeDimensions()

deserializeDimensions(dimensionsConfig): void

It sets the marker layer dimensions property of tool state.

Parameters

• dimensionsConfig: ITimelineToolDimensionsConfig

Returns

void

Implementation of

ITimelineToolState.deserializeDimensions

Overrides

LayerToolState.deserializeDimensions

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:60

---

getDimensions()

getDimensions(): object

It returns the map layer dimensions property of the tool state.

Returns

object

chartAggregationFn

chartAggregationFn: IMapDomainDimension\<IMapAggregationFunction>

chartEnabled

chartEnabled: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

chartValuePath

chartValuePath: IMapDomainDimension\<IMapDataDomain>

granularity

granularity: IMapDomainDimension\<ITimeGranularity>

realTimeEnabled

realTimeEnabled: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

stepTimeLength

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

story

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

storyEnabled

storyEnabled: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

timePath

timePath: IMapDomainDimension\<IMapDataDomain>

transitionDuration

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

Implementation of

ITimelineToolState.getDimensions

Overrides

LayerToolState.getDimensions

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:158

---

getIcon()

getIcon(): string

It returns the icon property of the tool state.

Returns

string

Implementation of

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

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

ITimelineToolState.getLabel

Inherited from

LayerToolState.getLabel

Source

model/internal/tool/MapToolState.ts:104

---

getLayerItems()

getLayerItems(): undefined | Layer[]

It returns the layer items property of the tool state.

Returns

undefined | Layer[]

Implementation of

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

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

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

---

getStories()

getStories(): TimelineStoryConfig[]

Returns

TimelineStoryConfig[]

Implementation of

ITimelineToolState.getStories

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:171

---

getStoryByName()

getStoryByName(name): undefined | null | TimelineStoryConfig

Parameters

• name: string

Returns

undefined | null | TimelineStoryConfig

Implementation of

ITimelineToolState.getStoryByName

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:186

---

getType()

getType(): string

It returns the type property of the tool state.

Returns

string

Implementation of

ITimelineToolState.getType

Inherited from

LayerToolState.getType

Source

model/internal/object/MapObjectState.ts:80

---

initialize()

initialize(defaults, props, initProps): void

It resets state with respect to initial props.

Parameters

• defaults: ITimelineToolDefaults

• props: ITimelineToolProps

• initProps: IMapToolInitProps\<ITimelineToolConfig>

Returns

void

Implementation of

ITimelineToolState.initialize

Overrides

LayerToolState.initialize

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:32

---

isEnabled()

isEnabled(): boolean

It returns the enabled property of the tool state.

Returns

boolean

Implementation of

ITimelineToolState.isEnabled

Inherited from

LayerToolState.isEnabled

Source

model/internal/tool/MapToolState.ts:88

---

saveStory()

saveStory(story): void

Parameters

• story: TimelineStoryConfig

Returns

void

Implementation of

ITimelineToolState.saveStory

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:179

---

serialize()

serialize(defaults?): ITimelineToolConfig

The method serializes the tool state. Optionally, defaults can be set if property is undefined.

Parameters

• defaults?: ITimelineToolDefaults

Returns

ITimelineToolConfig

Implementation of

ITimelineToolState.serialize

Overrides

LayerToolState.serialize

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:126

---

setDimensions()

setDimensions(dimensions): void

It sets the map layer dimensions property of tool state.

Parameters

• dimensions

• dimensions.chartAggregationFn: IMapDomainDimension\<IMapAggregationFunction>

• dimensions.chartEnabled: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

• dimensions.chartValuePath: IMapDomainDimension\<IMapDataDomain>

• dimensions.granularity: IMapDomainDimension\<ITimeGranularity>

• dimensions.realTimeEnabled: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

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

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

• dimensions.storyEnabled: IMapTypeDimension\<boolean, ITypeManager\<boolean>>

• dimensions.timePath: IMapDomainDimension\<IMapDataDomain>

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

Returns

void

Implementation of

ITimelineToolState.setDimensions

Overrides

LayerToolState.setDimensions

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:167

---

setEnabled()

setEnabled(enabled): void

It sets the enabled property of tool state.

Parameters

• enabled: boolean

Returns

void

Implementation of

ITimelineToolState.setEnabled

Inherited from

LayerToolState.setEnabled

Source

model/internal/tool/MapToolState.ts:97

---

setIcon()

setIcon(icon): void

It sets the icon property of the tool state.

Parameters

• icon: string

Returns

void

Implementation of

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

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

ITimelineToolState.setLabel

Inherited from

LayerToolState.setLabel

Source

model/internal/tool/MapToolState.ts:113

---

setLayerItems()

setLayerItems(layerItems): void

It sets the layer items property of tool state.

Parameters

• layerItems: Layer[]

Returns

void

Implementation of

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

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

---

setStories()

setStories(stories): void

Parameters

• stories: TimelineStoryConfig[]

Returns

void

Implementation of

ITimelineToolState.setStories

Source

tools/timeline/model/internal/tool/TimelineToolState.ts:175