Class: Timeline
A timeline component that shows data distribution over time or numeric range. It provides an interface for selecting a range within the data.
Extends
Constructors
Constructor
new Timeline(
containerNode,config?):Timeline
Parameters
| Parameter | Type |
|---|---|
containerNode | HTMLElement |
config? | TimelineConfigInterface |
Returns
Timeline
Overrides
DisplayStateManager.constructor
Methods
extractConfig()
staticextractConfig(config,defaultConfig):DisplayStateConfigInterface
Parameters
| Parameter | Type |
|---|---|
config | DisplayStateConfigInterface |
defaultConfig | DisplayStateConfigInterface |
Returns
Inherited from
DisplayStateManager.extractConfig
showState()
showState(
text?):void
Shows the DisplayState element with the specified text
Parameters
| Parameter | Type | Description |
|---|---|---|
text? | string | Optional text to display, defaults to noDataMessage |
Returns
void
Inherited from
hideState()
hideState():
void
Hides the DisplayState element
Returns
void
Inherited from
setDisplayStateConfig()
setDisplayStateConfig(
config):void
Updates the DisplayState configuration
Parameters
| Parameter | Type |
|---|---|
config | DisplayStateConfigInterface |
Returns
void
Inherited from
DisplayStateManager.setDisplayStateConfig
setLoadingState()
setLoadingState():
void
Sets the DisplayState element to loading state
Returns
void
Overrides
DisplayStateManager.setLoadingState
getCurrentSelection()
getCurrentSelection():
undefined| [Date,Date] | [number,number]
Returns
undefined | [Date, Date] | [number, number]
getCurrentSelectionInPixels()
getCurrentSelectionInPixels():
undefined| [number,number]
Returns
undefined | [number, number]
getBarWidth()
getBarWidth():
number
Returns
number
getConfig()
getConfig():
TimelineConfigInterface
Returns
getIsAnimationRunning()
getIsAnimationRunning():
boolean
Returns
boolean
setConfig()
setConfig(
config?):void
Parameters
| Parameter | Type |
|---|---|
config? | TimelineConfigInterface |
Returns
void
setTimeData()
setTimeData(
data,customExtent?):void
Parameters
| Parameter | Type |
|---|---|
data | undefined | number[] | Date[] |
customExtent? | [Date, Date] | [number, number] |
Returns
void
setHighlightedData()
setHighlightedData(
data):void
Parameters
| Parameter | Type |
|---|---|
data | undefined | number[] | Date[] |
Returns
void
setSelection()
setSelection(
selectionRange?,renderOnly?):void
Parameters
| Parameter | Type | Default value |
|---|---|---|
selectionRange? | [Date, Date] | [number, number] | undefined |
renderOnly? | boolean | false |
Returns
void
updateDimensions()
updateDimensions():
void
Returns
void
resize()
resize():
void
Returns
void
render()
render():
void
Returns
void
playAnimation()
playAnimation():
void
Returns
void
pauseAnimation()
pauseAnimation():
void
Returns
void
stopAnimation()
stopAnimation():
void
Returns
void
destroy()
destroy():
void
Cleanup method for DisplayState elements
Returns
void