TimelineToolDefaults
geovisto-map / TimelineToolDefaults
Class: TimelineToolDefaults
This class provide functions which return the default state values.
Author
Krystof Rykala
Extends
Implements
Constructors
new TimelineToolDefaults()
new TimelineToolDefaults():
TimelineToolDefaults
Returns
Inherited from
Properties
idString?
protected
optional
idString:string
Inherited from
Source
model/internal/object/MapObjectDefaults.ts:13
TYPE
static
TYPE:string
="geovisto-tool-layer-timeline"
Static tool type constant.
Overrides
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:34
id
static
protected
id:number
Inherited from
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
Source
model/internal/object/MapObjectDefaults.ts:54
getChartAggregationFn()
getChartAggregationFn():
IMapDomainDimension
\<IMapAggregationFunction
>
Returns
IMapDomainDimension
\<IMapAggregationFunction
>
Implementation of
ITimelineToolDefaults
.getChartAggregationFn
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:163
getChartEnabled()
getChartEnabled():
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
Returns
IMapTypeDimension
\<boolean
, ITypeManager
\<boolean
>>
Implementation of
ITimelineToolDefaults
.getChartEnabled
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:147
getChartValuePath()
getChartValuePath(
map
?):IMapDomainDimension
\<IMapDataDomain
>
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IMapDataDomain
>
Implementation of
ITimelineToolDefaults
.getChartValuePath
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:155
getConfig()
getConfig():
IMapToolConfig
By defaults it returns the config with undefined props.
Returns
Implementation of
ITimelineToolDefaults
.getConfig
Inherited from
Source
model/internal/tool/MapToolDefaults.ts:34
getDataManager()
getDataManager():
IMapDataManager
It returns default map data manager.
Returns
Inherited from
LayerToolDefaults
.getDataManager
Source
model/internal/tool/MapToolDefaults.ts:20
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
>>
Implementation of
ITimelineToolDefaults
.getDimensions
Overrides
LayerToolDefaults
.getDimensions
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:67
getGeoDataManager()
getGeoDataManager(
geoDataArray
):IGeoDataManager
It returns default geo data manager.
Parameters
• geoDataArray: undefined
| IGeoData
[]
Returns
Inherited from
LayerToolDefaults
.getGeoDataManager
Source
model/internal/tool/MapToolDefaults.ts:27
getGranularity()
getGranularity():
IMapDomainDimension
\<ITimeGranularity
>
Returns
IMapDomainDimension
\<ITimeGranularity
>
Implementation of
ITimelineToolDefaults
.getGranularity
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:130
getIcon()
getIcon():
string
It returns the icon of the tab pane.
Returns
string
Implementation of
Overrides
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:53
getId()
getId():
string
It returns identifier which is used when no identifier is specified.
Returns
string
Implementation of
Inherited from
Source
model/internal/object/MapObjectDefaults.ts:44
getLabel()
getLabel():
string
It returns the label of the tool.
Returns
string
Implementation of
ITimelineToolDefaults
.getLabel
Overrides
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:60
getLayerName()
getLayerName():
string
It returns the layer name.
Returns
string
Implementation of
ITimelineToolDefaults
.getLayerName
Overrides
LayerToolDefaults
.getLayerName
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:46
getProps()
getProps():
IMapObjectProps
It returns default props if no props are given.
Returns
Implementation of
ITimelineToolDefaults
.getProps
Inherited from
Source
model/internal/object/MapObjectDefaults.ts:18
getRealTimeEnabled()
getRealTimeEnabled():
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
Returns
IMapTypeDimension
\<boolean
, ITypeManager
\<boolean
>>
Implementation of
ITimelineToolDefaults
.getRealTimeEnabled
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:122
getStepTimeLength()
getStepTimeLength():
IMapTypeDimension
\<number
,ITypeManager
\<number
>>
Returns
IMapTypeDimension
\<number
, ITypeManager
\<number
>>
Implementation of
ITimelineToolDefaults
.getStepTimeLength
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:90
getStory()
getStory():
IMapTypeDimension
\<string
,ITypeManager
\<string
>>
Returns
IMapTypeDimension
\<string
, ITypeManager
\<string
>>
Implementation of
ITimelineToolDefaults
.getStory
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:114
getStoryEnabled()
getStoryEnabled():
IMapTypeDimension
\<boolean
,ITypeManager
\<boolean
>>
Returns
IMapTypeDimension
\<boolean
, ITypeManager
\<boolean
>>
Implementation of
ITimelineToolDefaults
.getStoryEnabled
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:106
getTimePathDimension()
getTimePathDimension(
map
?):IMapDomainDimension
\<IMapDataDomain
>
Parameters
• map?: IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Returns
IMapDomainDimension
\<IMapDataDomain
>
Implementation of
ITimelineToolDefaults
.getTimePathDimension
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:82
getTransitionDuration()
getTransitionDuration():
IMapTypeDimension
\<number
,ITypeManager
\<number
>>
Returns
IMapTypeDimension
\<number
, ITypeManager
\<number
>>
Implementation of
ITimelineToolDefaults
.getTransitionDuration
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:98
getType()
getType():
string
It returns a unique type string of the tool which is based on the layer it wraps.
Returns
string
Implementation of
Overrides
Source
tools/timeline/model/internal/tool/TimelineToolDefaults.ts:39
isEnabled()
isEnabled():
boolean
By default, the tool is enabled.
Returns
boolean
Implementation of
ITimelineToolDefaults
.isEnabled
Inherited from
Source
model/internal/tool/MapToolDefaults.ts:50
isSingleton()
isSingleton():
boolean
By default, the tool is singleton
Returns
boolean
Implementation of
ITimelineToolDefaults
.isSingleton