class anychart.charts.Timeline Improve this Doc

Timeline chart class.

Methods Overview

Specific settings
fit()	Fits chart horizontally by resetting zoom and vertical translation.
getType()	Returns chart type.
scroll()	Scroll settings.
scroller()	Scroller settings.
zoomTo()	Zooms into given dates.
Axes and Scales
axis()	Axis settings.
lineMarker()	Getter for the line marker.
rangeMarker()	Range marker settings.
scale()	Scale settings.
textMarker()	Text marker settings.
todayMarker()	Getter for the today marker.
Data
data()	Data settings.
Events
listen()	Adds an event listener.
listenOnce()	Adds a single time event listener
removeAllListeners()	Removes all listeners.
unlisten()	Removes the listener
unlistenByKey()	Removes the listener by the key.
Series
moment()	Adds Moment series.
range()	Adds Range series.
Specific Series Settings
addSeries()	Adds series to the chart.
defaultSeriesType()	Default series type.
getSeries()	Returns series by id.
getSeriesAt()	Returns series by index.
getSeriesCount()	Returns series count.
removeAllSeries()	Removes all series from chart.
removeSeries()	Removes one of series from chart by its id.
removeSeriesAt()	Removes one of series from chart by its index.
Miscellaneous
interactivity()	Chart interactivity settings.

Methods Description

addSeries

addSeries(var_args)Since version 7.13.0

Adds series to the chart.

Detailed description

Creates new series with type taken from defaultSeriesType method. For timeline default series is moment.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Chart series data.

Returns:

Array.<anychart.core.timeline.series.Base> - Array of created series.

axis

axis()

Getter for the chart axis.

Returns:

anychart.core.axes.Timeline - Axis settings.

axis(value)

Setter for the chart axis.

Params:

Name	Type	Description
value	Object	Timeline axis settings.

Returns:

anychart.charts.Timeline - Self instance for method chaining

data

data()

Getter for the chart data.

Returns:

anychart.data.View - Data view.

data(data)

Setter for the chart data.
Learn more about mapping at anychart.data.Mapping.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Mapping \| anychart.data.Set \| anychart.data.DataSettings \| Array	Data for the chart.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

defaultSeriesType

defaultSeriesType()Since version 7.13.0

Getter for the default series type.

Returns:

anychart.enums.TimelineSeriesType | string - Default series type.

Try it:

Usage sample

defaultSeriesType(type)Since version 7.13.0

Setter for the series type.

Detailed description

Setting the default type using this method affects only series created using addSeries() method after the default is set. All series created prior to that do not change the type.

Params:

Name	Type	Description
type	anychart.enums.TimelineSeriesType \| string	Default series type.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

Try it:

Usage sample

fit

fit()

Fits chart horizontally by resetting zoom and vertical translation.

Returns:

anychart.charts.Timeline - Self instance for method chaining

Try it:

Usage sample

getSeries

getSeries(id)

Getter for the series by its id.

Params:

Name	Type	Default	Description
id	number \| string	index	Id of the series.

Returns:

anychart.core.timeline.series.Base - An instance of the created series.

getSeriesAt

getSeriesAt(index)Since version 7.13.0

Getter for the series by its index.

Params:

Name	Type	Description
index	number	Index of the series.

Returns:

anychart.core.timeline.series.Base - An instance of the class for method chaining.

getSeriesCount

getSeriesCount()Since version 7.13.0

Returns series count.

Returns:

number - Number of series.

getType

getType()

Returns chart type.

Returns:

string - Chart type.

Try it:

Usage sample

interactivity

interactivity()

Get chart interactivity settings.

Returns:

anychart.core.utils.Interactivity -

interactivity(value)

Set chart interactivity settings.

Params:

Name	Type	Description
value	Object	Interactivity settings.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

lineMarker

lineMarker(index)

Getter for the line marker.

Params:

Name	Type	Default	Description
index	number	0	Line marker index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Line - Line marker instance by index.

Try it:

Usage sample

lineMarker(value)

Setter for the line marker.

Detailed description

Sets line marker settings depending on parameter type:

null/boolean - disable or enable line marker.
object - sets line marker settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Line marker settings to set.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

Try it:

lineMarker(index, value)

Setter for the line marker by index.

Detailed description

Sets line marker settings depending on parameter type:

null/boolean - disable or enable line marker by index.
object - sets line marker settings by index.

Params:

Name	Type	Description
index	number	Line marker index.
value	Object \| boolean \| null	Line marker settings to set.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

Try it:

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note: Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method. Function that looks like: function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note: In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

moment

moment(data, csvSettings)

Adds Moment series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.timeline.series.Moment - Created series.

Try it:

Usage sample

range

range(data, csvSettings)

Adds Range series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.timeline.series.Range - Created series.

Try it:

Usage sample

rangeMarker

rangeMarker(index)

Getter for the range marker.

Params:

Name	Type	Description
index	number	Range marker index.

Returns:

anychart.core.axisMarkers.Range - Range marker instance by index.

Try it:

Usage sample

rangeMarker(value)Since version 7.9.0

Setter for the range marker.

Detailed description

Sets range marker settings depending on parameter type:

null/boolean - disable or enable range marker.
object - sets range marker settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Range marker settings to set.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

Try it:

rangeMarker(index, value)

Setter for the range marker by index.

Detailed description

Sets range marker settings depending on parameter type:

null/boolean - disable or enable range marker by index.
object - sets range marker settings by index.

Params:

Name	Type	Description
index	number	Range marker index.
value	Object \| boolean \| null	Range marker settings to set.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

Try it:

removeAllListeners

removeAllListeners(type)

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Usage sample

removeAllSeries

removeAllSeries()Since version 7.13.0

Removes all series from chart.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

removeSeries

removeSeries(id)Since version 7.13.0

Removes one of series from chart by its id.

Params:

Name	Type	Description
id	number \| string	Series id.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

removeSeriesAt

removeSeriesAt(index)Since version 7.13.0

Removes one of series from chart by its index.

Params:

Name	Type	Description
index	number	Series index.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

scale

scale()

Getter for the chart scale.

Returns:

anychart.scales.GanttDateTime - Default chart scale value.

Try it:

Usage sample

scale(value)

Setter for the chart scale.

Params:

Name	Type	Description
value	Object	Scale configuration.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

Try it:

Usage sample

scroll

scroll()

Getter of the scroll value.

Returns:

number - Scroll value.

scroll(value)

Setter of the scroll value.

Detailed description

Scrolls chart vertically dependent on scroll value:

-1 - scroll up and show part of the chart above axis.
0 - center chart at axis level.
1 - scroll down and show part of the chart under the axis.

Params:

Name	Type	Description
value	number	Scroll value.

Returns:

anychart.charts.Timeline - Self instance for method chaining

scroller

scroller()

Getter for the scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller settings.

scroller(value)

Setter for the scroller.

Params:

Name	Type	Description
value	Object \| boolean \| null	Chart scroller settings.

Returns:

anychart.charts.Timeline - Self instance for method chaining

textMarker

textMarker(index)

Getter for the text marker.

Params:

Name	Type	Description
index	number	Text marker index.

Returns:

anychart.core.axisMarkers.Text - Text marker instance by index.

Try it:

Usage sample

textMarker(value)

Setter for the text marker.

Detailed description

Sets text marker settings depending on parameter type:

null/boolean - disable or enable text marker.
object - sets text marker settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Text marker settings to set.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

Try it:

textMarker(index, value)

Setter for text marker by index.

Detailed description

Sets text marker settings depending on parameter type:

null/boolean - disable or enable text marker by index.
object - sets text marker settings by index.

Params:

Name	Type	Description
index	number	Text marker index.
value	Object \| boolean \| null	Text marker settings to set.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

Try it:

todayMarker

todayMarker()

Getter for the today marker.

Detailed description

Today marker is a line marker with value set to current system date.

Returns:

anychart.core.axisMarkers.Line - Line marker instance by index.

Try it:

Usage sample

todayMarker(value)

Setter for the today marker.

Detailed description

Sets today marker settings depending on parameter type:

null/boolean - disable or enable today marker.
object - sets today marker settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Line marker settings to set.

Returns:

anychart.charts.Timeline - Self instance for method chaining.

Try it:

unlisten

unlisten(type, listener, useCapture, listenerScope)

Removes a listener added using listen() or listenOnce() methods.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.