ITimelineToolDefaults
geovisto-map / ITimelineToolDefaults
Interface: ITimelineToolDefaults
This interface provides functions which return the default state values.
Author
Krystof Rykala
Extends
Methods
getChartAggregationFn()
getChartAggregationFn():
IMapDomainDimension
\<IMapAggregationFunction
>
Returns
IMapDomainDimension
\<IMapAggregationFunction
>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:36
getChartEnabled()
getChartEnabled():
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
Returns
IMapTypeDimension
\<boolean
, ITypeManager
\<boolean
>>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:32
getChartValuePath()
getChartValuePath(
map
?):IMapDomainDimension
\<IMapDataDomain
>
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IMapDataDomain
>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:34
getConfig()
getConfig():
IMapToolConfig
It returns default config if no config is given.
Returns
Inherited from
Source
model/types/tool/IMapToolDefaults.ts:14
getDimensions()
getDimensions(
map
?):object
It returns the map of layer dimensions.
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
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
>>
Overrides
ILayerToolDefaults
.getDimensions
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:16
getGranularity()
getGranularity():
IMapDomainDimension
\<ITimeGranularity
>
Returns
IMapDomainDimension
\<ITimeGranularity
>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:30
getIcon()
getIcon():
string
It returns the icon of the tool.
Returns
string
Inherited from
Source
model/types/tool/IMapToolDefaults.ts:36
getId()
getId():
string
It returns identifier which is used when no identifier is specified.
Returns
string
Inherited from
Source
model/types/object/IMapObjectDefaults.ts:32
getLabel()
getLabel():
string
It returns the label of the tool.
Returns
string
Inherited from
Source
model/types/tool/IMapToolDefaults.ts:31
getLayerName()
getLayerName():
string
It returns the layer name.
Returns
string
Inherited from
ILayerToolDefaults
.getLayerName
Source
model/types/layer/ILayerToolDefaults.ts:15
getProps()
getProps():
IMapObjectProps
It returns default props if no props are given.
Returns
Inherited from
Source
model/types/object/IMapObjectDefaults.ts:17
getRealTimeEnabled()
getRealTimeEnabled():
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
Returns
IMapTypeDimension
\<boolean
, ITypeManager
\<boolean
>>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:28
getStepTimeLength()
getStepTimeLength():
IMapTypeDimension
\<number
,ITypeManager
\<number
>>
Returns
IMapTypeDimension
\<number
, ITypeManager
\<number
>>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:20
getStory()
getStory():
IMapTypeDimension
\<string
,ITypeManager
\<string
>>
Returns
IMapTypeDimension
\<string
, ITypeManager
\<string
>>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:26
getStoryEnabled()
getStoryEnabled():
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
Returns
IMapTypeDimension
\<boolean
, ITypeManager
\<boolean
>>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:24
getTimePathDimension()
getTimePathDimension(
map
?):IMapDomainDimension
\<IMapDataDomain
>
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IMapDataDomain
>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:18
getTransitionDuration()
getTransitionDuration():
IMapTypeDimension
\<number
,ITypeManager
\<number
>>
Returns
IMapTypeDimension
\<number
, ITypeManager
\<number
>>
Source
tools/timeline/model/types/tool/ITimelineToolDefaults.ts:22
getType()
getType():
string
It returns a unique type string of the map object.
Returns
string
Inherited from
Source
model/types/object/IMapObjectDefaults.ts:27
isEnabled()
isEnabled():
boolean
By default, the tool is enabled.
Returns
boolean
Inherited from
Source
model/types/tool/IMapToolDefaults.ts:26
isSingleton()
isSingleton():
boolean
It returns a logical value whether the tool type is singleton.
Returns
boolean
Inherited from
ILayerToolDefaults
.isSingleton