Interface: CosmographTimelineConfigInterface

Extended by

CosmographTimelineConfig

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

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

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

highlightSelectedData?

optional highlightSelectedData: boolean

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

Default

true

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

Upgrade from v1 CosmographBars