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

Extends: anychart.core.timeline.series.Base

Timeline Range 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.
height()	Getter of series height.

Methods Description

a11y()Since version 7.11.0

a11y(value)Since version 7.11.0

Setter for the accessibility setting.

Detailed description

Params:

Name	Type	Description
value	boolean \| Object	Whether to enable accessibility.

Returns:

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

Try it:

data

data()Since version 7.7.0

Getter for series mapping.

Returns:

anychart.data.View - Returns series mapping.

Try it:

Usage sample

data(data, csvSettings)Since version 7.7.0

Setter for series mapping.

Params:

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

Returns:

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

Try it:

direction

direction()

Series direction getter.

Returns:

anychart.enums.Direction - Series direction.

Try it:

Usage sample

direction(direction)

Series direction setter.

Params:

Name	Type	Description
direction	anychart.enums.Direction	Series direction.

Returns:

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

Try it:

Usage sample

getPoint

getPoint(index)Since version 7.8.0

Gets wrapped point by index.

Params:

Name	Type	Description
index	number	Point index.

Returns:

anychart.core.SeriesPoint - Wrapped point.

Try it:

Usage sample

height

height()

Getter of series height.

Returns:

number | string - Series height.

Try it:

Usage sample

height(value)

Setter of series height.

Params:

Name	Type	Description
value	number \| string	Height in pixels or as percent string.

Returns:

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

Try it:

Usage sample

hovered

hovered()Since version 8.0.0

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Usage sample

hovered(settings)Since version 8.0.0

Setter for hovered state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

id

id()Since version 7.8.0

Getter for the series id.

Returns:

string | number - Series id.

Try it:

Usage sample

id(id)Since version 7.8.0

Setter for the series id.

Detailed description

If you will set series id that is equal to an existing index, all changes will be set for the first series with this index.

Params:

Name	Type	Description
id	string \| number	Id of the series. Default id is equal to internal index.

Returns:

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

Try it:

Usage sample

labels

labels()

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

labels(settings)

Setter for series data labels.

Detailed description

Sets series labels settings depending on parameter type:

null/boolean - disable or enable chart labels.
object - sets chart labels settings.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	false	Series data labels settings.

Returns:

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

Try it:

markers

markers()

Getter for series data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

markers(settings)

Setter for series data markers.

Detailed description

Sets series markers settings depending on parameter type:

null/boolean - disable or enable series markers.
object - sets series markers settings.
string - sets series markers type.

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null \| string	false	Series data markers settings.

Returns:

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

name

name()Since version 7.7.0

Getter for the series name.

Detailed description

This method can be used as getter only if the value has been previously set.

Returns:

string | undefined - Series name value.

Try it:

Usage sample

name(name)Since version 7.7.0

Setter for the series name.

Detailed description

Basically, name of series is used in Legend displaying, but it can be used in tooltips.

Params:

Name	Type	Description
name	string	Series name to set.

Returns:

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

Try it:

Usage sample

normal

normal()Since version 8.0.0

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)Since version 8.0.0

Setter for normal state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

selected

selected()Since version 8.0.0

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)Since version 8.0.0

Setter for selected state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

selectionMode

selectionMode()Since version 7.7.0

Gets the state of the series for selection mode.

Returns:

anychart.enums.SelectionMode | string | null - Selection mode.

Try it:

Usage sample

selectionMode(value)Since version 7.7.0

Allows to select points of the series. To select multiple points, press 'ctrl' and click on them.

Params:

Name	Type	Default	Description
value	anychart.enums.SelectionMode \| string \| null	'multiSelect'	Selection mode.

Returns:

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

Try it:

Usage sample

unhover

unhover(indexOrIndexes)Since version 7.7.0

Removes hover from the series.

Params:

Name	Type	Description
indexOrIndexes	number \| Array.<number>	Point index or array of indexes.

Returns:

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

Try it:

Usage sample

unselect

unselect()Since version 7.7.0

Deselects all selected points.

Returns:

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

Try it:

Usage sample

unselect(index)Since version 7.7.0

Deselects selected point by index.

Params:

Name	Type	Description
index	number	Index of the point to select.

Returns:

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

Try it:

Usage sample

unselect(indexes)Since version 7.7.0

Deselects selected points by indexes.

Params:

Name	Type	Description
indexes	Array.<number>	An array of indexes of the point to select.

Returns:

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

Try it:

Usage sample