AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.timeline.series.Base Improve this Doc

Extends: anychart.core.cartesian.series.Base

Timeline base series.

Methods Overview

Specific settings
a11y()Accessibility settings.
id()Series id.
selectionMode()Selection mode.
Data
data()Data settings.
name()Series name settings.
Interactivity
hovered()Hovered state settings.
normal()Normal state settings.
selected()Selected state settings.
unhover()Removes hover from the series.
unselect()Deselects all selected points.
Point Elements
getPoint()Gets wrapped point by index.
labels()Labels settings.
markers()Markers settings.
Miscellaneous
direction()Direction settings.

Methods Description

a11y

Getter for the accessibility setting.

Returns:

anychart.core.utils.SeriesA11y - Accessibility settings object.
See listing.
var series = chart.line([3, 5, 2, 14, 3]);
var a11y = series.a11y();
Setter for the accessibility setting.

Params:

NameTypeDescription
valueboolean | ObjectWhether to enable accessibility.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

data

Getter for series mapping.

Returns:

anychart.data.View - Returns series mapping.
Setter for series mapping.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData to set.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettingsIf CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

direction

Series direction getter.

Returns:

anychart.enums.Direction - Series direction.
Series direction setter.

Params:

NameTypeDescription
directionanychart.enums.DirectionSeries direction.

Returns:

anychart.core.timeline.series.Base - Itself for chaining.

getPoint

Gets wrapped point by index.

Params:

NameTypeDescription
indexnumberPoint index.

Returns:

anychart.core.SeriesPoint - Wrapped point.

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

id

Getter for the series id.

Returns:

string | number - Series id.
Setter for the series id.

Params:

NameTypeDescription
idstring | numberId of the series. Default id is equal to internal index.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

labels

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for series data labels.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Series data labels settings.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

markers

Getter for series data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.
Setter for series data markers.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null | string
false
Series data markers settings.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

name

Getter for the series name.

Returns:

string | undefined - Series name value.
Setter for the series name.

Params:

NameTypeDescription
namestringSeries name to set.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings
Setter for selected state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

selectionMode

Gets the state of the series for selection mode.

Returns:

anychart.enums.SelectionMode | string | null - Selection mode.
Allows to select points of the series. To select multiple points, press 'ctrl' and click on them.

Params:

NameTypeDefaultDescription
valueanychart.enums.SelectionMode | string | null
'multiSelect'
Selection mode.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

unhover

Removes hover from the series.

Params:

NameTypeDescription
indexOrIndexesnumber | Array.<number>Point index or array of indexes.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.

unselect

Deselects all selected points.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.
Deselects selected point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.
Deselects selected points by indexes.

Params:

NameTypeDescription
indexesArray.<number>An array of indexes of the point to select.

Returns:

anychart.core.timeline.series.Base - Self instance for method chaining.