ITimelineToolState
geovisto-map / ITimelineToolState
Interface: ITimelineToolState\<TProps, TDefaults, TConfig, TDimensionsConfig, TDimensions>
This interface declares functions for using the state of the layer tool.
Author
Krystof Rykala
Extends
ILayerToolState\<TProps,TDefaults,TConfig,TDimensionsConfig,TDimensions>
Type parameters
• TProps extends ITimelineToolProps = ITimelineToolProps
• TDefaults extends ITimelineToolDefaults = ITimelineToolDefaults
• TConfig extends ITimelineToolConfig = ITimelineToolConfig
• TDimensionsConfig extends ITimelineToolDimensionsConfig = ITimelineToolDimensionsConfig
• TDimensions extends ITimelineToolDimensions = ITimelineToolDimensions
Methods
createStory()
createStory(
name):void
Parameters
• name: string
Returns
void
Source
tools/timeline/model/types/tool/ITimelineToolState.ts:29
deserialize()
deserialize(
config):void
The metod takes config and deserializes the values.
Parameters
• config: TConfig
Returns
void
Inherited from
Source
model/types/object/IMapObjectState.ts:32
deserializeDimensions()
deserializeDimensions(
dimensionsConfig):void
It sets the marker layer dimensions property of tool state.
Parameters
• dimensionsConfig: TDimensionsConfig
Returns
void
Inherited from
ILayerToolState.deserializeDimensions
Source
model/types/layer/ILayerToolState.ts:25
getDimensions()
getDimensions():
TDimensions
It returns the layer dimensions property of the tool state.
Returns
TDimensions
Inherited from
Source
model/types/layer/ILayerToolState.ts:30
getIcon()
getIcon():
string
It returns the icon property of the tool state.
Returns
string
Inherited from
Source
model/types/tool/IMapToolState.ts:61
getId()
getId():
string
It returns the id property of the map object state.
Returns
string
Inherited from
Source
model/types/object/IMapObjectState.ts:49
getLabel()
getLabel():
string
It returns the label property of the tool state.
Returns
string
Inherited from
Source
model/types/tool/IMapToolState.ts:49
getLayerItems()
getLayerItems():
undefined|Layer[]
It returns the layer items property of the tool state.
Returns
undefined | Layer[]
Inherited from
Source
model/types/layer/ILayerToolState.ts:54
getLayerName()
getLayerName():
string
It returns the layer name property of the tool state.
Returns
string
Inherited from
Source
model/types/layer/ILayerToolState.ts:42
getMap()
getMap():
undefined|IMap\<IMapProps,IMapDefaults,IMapState\<IMapProps,IMapDefaults,IMapConfig>,IMapConfig,IMapInitProps\<IMapConfig>>
It returns the map property of the tool state.
Returns
undefined | IMap\<IMapProps, IMapDefaults, IMapState\<IMapProps, IMapDefaults, IMapConfig>, IMapConfig, IMapInitProps\<IMapConfig>>
Inherited from
Source
model/types/tool/IMapToolState.ts:44
getStories()
getStories():
TimelineStoryConfig[]
Returns
TimelineStoryConfig[]
Source
tools/timeline/model/types/tool/ITimelineToolState.ts:21
getStoryByName()
getStoryByName(
name):undefined|null|TimelineStoryConfig
Parameters
• name: string
Returns
undefined | null | TimelineStoryConfig
Source
tools/timeline/model/types/tool/ITimelineToolState.ts:27
getType()
getType():
string
It returns the type property of the map object state.
Returns
string
Inherited from
Source
model/types/object/IMapObjectState.ts:44
initialize()
initialize(
defaults,props,initProps):void
It resets the state with respect to the initial props.
Parameters
• defaults: TDefaults
• props: TProps
• initProps: IMapToolInitProps\<TConfig>
Returns
void
Inherited from
Source
model/types/tool/IMapToolState.ts:27
isEnabled()
isEnabled():
boolean
It returns the enabled property of the tool state.
Returns
boolean
Inherited from
Source
model/types/tool/IMapToolState.ts:32
saveStory()
saveStory(
story):void
Parameters
• story: TimelineStoryConfig
Returns
void
Source
tools/timeline/model/types/tool/ITimelineToolState.ts:25
serialize()
serialize(
defaults):TConfig
The method serializes the map object state. Optionally, a serialized value can be let undefined if it equals the default value.
Parameters
• defaults: undefined | TDefaults
Returns
TConfig
Inherited from
Source
model/types/object/IMapObjectState.ts:39
setDimensions()
setDimensions(
dimensions):void
It sets the layer dimensions property of tool state.
Parameters
• dimensions: TDimensions
Returns
void
Inherited from
Source
model/types/layer/ILayerToolState.ts:37
setEnabled()
setEnabled(
enabled):void
It sets the enabled property of tool state.
Parameters
• enabled: boolean
Returns
void
Inherited from
Source
model/types/tool/IMapToolState.ts:39
setIcon()
setIcon(
icon):void
It sets the icon property of the tool state.
Parameters
• icon: string
Returns
void
Inherited from
Source
model/types/tool/IMapToolState.ts:68
setId()
setId(
id):void
It sets the id property of the map object state. It can be set only once.
Parameters
• id: string
Returns
void
Inherited from
Source
model/types/object/IMapObjectState.ts:57
setLabel()
setLabel(
label):void
It sets the label property of the tool state.
Parameters
• label: string
Returns
void
Inherited from
Source
model/types/tool/IMapToolState.ts:56
setLayerItems()
setLayerItems(
layerItems):void
It sets the layer items property of tool state.
Parameters
• layerItems: Layer[]
Returns
void
Inherited from
Source
model/types/layer/ILayerToolState.ts:61
setLayerName()
setLayerName(
layerName):void
It sets the layer name property of the tool state.
Parameters
• layerName: string
Returns
void
Inherited from
Source
model/types/layer/ILayerToolState.ts:49
setStories()
setStories(
stories):void
Parameters
• stories: TimelineStoryConfig[]
Returns
void