Interface: CosmographTimelineConfig

Extends

CosmographTimelineConfigInterface.TimelineConfigInterface

Properties

accessor?

optional accessor: string

Data column key to access time values for the CosmographTimeline. Make sure it’s included in pointIncludeColumns or linkIncludeColumns if you’re not using this column as other point or link accessor.

Default

undefined

Inherited from

CosmographTimelineConfigInterface.accessor

customExtent?

optional customExtent: [number, number]

Minimum and maximum extent for the CosmographHistogram visualization. Can be used if you don’t want histogram range to be automatically calculated from data extent.

Default

undefined

Inherited from

CosmographTimelineConfigInterface.customExtent

useLinksData?

optional useLinksData: boolean

Defines type of filter to use. true for links, false for points. Can only be set once during initialization.

Default

false

Inherited from

CosmographTimelineConfigInterface.useLinksData

highlightSelectedData?

optional highlightSelectedData: boolean

Whether to highlight currently selected data on timeline. If true, can impact performance.

Default

true

Inherited from

CosmographTimelineConfigInterface.highlightSelectedData

onSelection()?

optional onSelection: (selection, isManuallySelected?) => void

Callback for the range selection. Provides current selection of CosmographTimeline.

Parameters

Parameter	Type	Description
`selection`	`undefined` \| [`Date`, `Date`] \| [`number`, `number`]	The current selection range. If no selection is made, it will be `undefined`.
`isManuallySelected?`	`boolean`	Indicates whether the selection was made manually by the user.

Returns

void

Inherited from

CosmographTimelineConfigInterface.onSelection

noDataMessage?

optional noDataMessage: string | false

Text to display when there is no data. When set to false, this message will not be displayed.

Default

'No data'

Inherited from

TimelineConfigInterface.noDataMessage

loadingMessage?

optional loadingMessage: string | false

Text to display when data is loading. When set to false, this message will not be displayed.

Default

'Data loading...'

Inherited from

TimelineConfigInterface.loadingMessage

disableStateMessages?

optional disableStateMessages: boolean

Whether to disable all messages in the DisplayState element.

Default

false

Inherited from

TimelineConfigInterface.disableStateMessages

allowPointerEvents?

optional allowPointerEvents: boolean

Whether to allow pointer events on the DisplayState element when message is visible.

Default

false

Inherited from

TimelineConfigInterface.allowPointerEvents

padding?

optional padding: Padding

Padding between the outer edges of the timeline. Affects only timeline container without animation button. Set in pixels.

Default

{ top: 1, left: 5, bottom: 1, right: 5 }

Inherited from

TimelineConfigInterface.padding

axisTickHeight?

optional axisTickHeight: number

Height of the ticks that appear along the timeline axis. Set in pixels.

Default

Inherited from

TimelineConfigInterface.axisTickHeight

selectionRadius?

optional selectionRadius: number

Corners roundness of the data selection brush. Set in pixels.

Default

Inherited from

TimelineConfigInterface.selectionRadius

selectionPadding?

optional selectionPadding: number

Padding of the data selection brush. Set in pixels.

Default

Inherited from

TimelineConfigInterface.selectionPadding

barCount?

optional barCount: number

Number of bars to be displayed in the timeline. Ignored if dataStep is set.

Default

Inherited from

TimelineConfigInterface.barCount

barRadius?

optional barRadius: number

Corners roundness of each bar on the timeline. Set in pixels.

Default

Inherited from

TimelineConfigInterface.barRadius

barPadding?

optional barPadding: number

Padding between each bar on the timeline. Set in percent of bar width from 0 (as 0% of the bar width) to 1 (as 100% of the bar width).

Default

0.1

Inherited from

TimelineConfigInterface.barPadding

barTopMargin?

optional barTopMargin: number

Margin between the top edge of the timeline and the maximum height bar. Set in pixels.

Default

Inherited from

TimelineConfigInterface.barTopMargin

minBarHeight?

optional minBarHeight: number

Height of bars with an empty data on the timeline. Set in pixels.

Default

Inherited from

TimelineConfigInterface.minBarHeight

stickySelection?

optional stickySelection: boolean

Stick selection brush coordinates to the bar edges.

Default

true

Inherited from

TimelineConfigInterface.stickySelection

allowSelection?

optional allowSelection: boolean

Determines whether or not the timeline allows users to select a range of dates using a selection brush control.

Default

true

Inherited from

TimelineConfigInterface.allowSelection

showAnimationControls?

optional showAnimationControls: boolean

If set to true, shows an animation control button that allows to play or pause animation of selected range of dates.

Default

false

Inherited from

TimelineConfigInterface.showAnimationControls

animationSpeed?

optional animationSpeed: number

Rate of refresh for each selection brush movement. Set in ms.

Default

Inherited from

TimelineConfigInterface.animationSpeed

dataStep?

optional dataStep: number

Generate bars of width of this value mapped in the X axis units. Overrides barCount. Set in ms for Date[] data.

Default

undefined

Inherited from

TimelineConfigInterface.dataStep

tickStep?

optional tickStep: number

Interval between each tick mark on the timeline axis. Set in the X axis units, in ms for Date[] timeline data or in relative units for number[] timeline data. Custom dateFormat may be required for the proper display of tick labels if the timeline data is Date[].

Default

undefined

Inherited from

TimelineConfigInterface.tickStep

formatter()?

optional formatter: (date) => string

Formatter function for ticks displayed on the timeline axis.

Parameters

Parameter	Type	Description
`date`	`number` \| `Date`	The date or number to format

Returns

string

The formatted string representation of the date/number

Inherited from

TimelineConfigInterface.formatter

onBrush()?

optional onBrush: (selection, isManuallySelected?) => void

Callback for the range selection. Provides current selection of Timeline.

Parameters

Parameter	Type	Description
`selection`	`undefined` \| [`Date`, `Date`] \| [`number`, `number`]	The current selection range as [start, end] dates or numbers
`isManuallySelected?`	`boolean`	Whether the selection was made by user interaction

Returns

void

Inherited from

TimelineConfigInterface.onBrush

onBarHover()?

optional onBarHover: (data) => void

Callback that is called when a bar is hovered over. Provides BarData for hovered bar: rangeStart, rangeEnd and count of records in this bar.

Parameters

Parameter	Type	Description
`data`	`TimelineBarData`	The data for the hovered bar

Returns

void

Inherited from

TimelineConfigInterface.onBarHover

onAnimationPlay()?

optional onAnimationPlay: (isAnimationRunning, selection) => void

Callback for the animation play that will be executed in playAnimation. Provides isAnimationRunning state and current selection of Timeline.

Parameters

Parameter	Type	Description
`isAnimationRunning`	`boolean`	Whether the animation is currently running
`selection`	`undefined` \| (`number` \| `Date`)[]	The current selection range

Returns

void

Inherited from

TimelineConfigInterface.onAnimationPlay

onAnimationPause()?

optional onAnimationPause: (isAnimationRunning, selection) => void

Callback for the animation play that will be executed in pauseAnimation. Provides isAnimationRunning state and current selection of Timeline.

Parameters

Parameter	Type	Description
`isAnimationRunning`	`boolean`	Whether the animation is currently running
`selection`	`undefined` \| (`number` \| `Date`)[]	The current selection range

Returns

void

Inherited from

TimelineConfigInterface.onAnimationPause

onAnimationTick()?

optional onAnimationTick: (selection) => void

Callback that is called on each animation tick. Provides current selection of Timeline.

Parameters

Parameter	Type	Description
`selection`	`undefined` \| (`number` \| `Date`)[]	The current selection range

Returns

void

Inherited from

TimelineConfigInterface.onAnimationTick

CosmographSizeLegendConfig CosmographTypeColorLegendConfig