class anychart.core.timeline.series.Moment Improve this Doc
Extends: anychart.core.timeline.series.Base
Timeline Moment 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.
Detailed description
If you want to work with accessibility then you only need to turn accessibility on using anychart.core.SeriesBase#a11y method.
Sets accessibility setting depending on parameter type:
Sets accessibility setting depending on parameter type:
- boolean - disable or enable accessibility.
- object - sets accessibility setting.
Params:
| Name | Type | Description |
|---|---|---|
| value | boolean | Object | Whether to enable accessibility. |
Returns:
anychart.core.timeline.series.Moment - Self instance for method chaining.data
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.Moment - Self instance for method chaining.direction
Series direction setter.
Params:
| Name | Type | Description |
|---|---|---|
| direction | anychart.enums.Direction | Series direction. |
Returns:
anychart.core.timeline.series.Moment - Itself for chaining.Try it:
getPoint
Gets wrapped point by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Point index. |
Returns:
anychart.core.SeriesPoint - Wrapped point.Try it:
hovered
Getter for hovered state settings.
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Setter for hovered state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.timeline.series.Moment - Self instance for method chaining.Try it:
id
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.Moment - Self instance for method chaining.Try it:
labels
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.Moment - Self instance for method chaining.markers
Getter for series data markers.
Returns:
anychart.core.ui.MarkersFactory - Markers instance.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.Moment - Self instance for method chaining.name
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:
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.Moment - Self instance for method chaining.Try it:
normal
Getter for normal state settings.
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Setter for normal state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.timeline.series.Moment - Self instance for method chaining.Try it:
selected
Getter for selected state settings.
Returns:
anychart.core.StateSettings - Selected state settingsTry it:
Setter for selected state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.timeline.series.Moment - Self instance for method chaining.Try it:
selectionMode
Gets the state of the series for selection mode.
Returns:
anychart.enums.SelectionMode | string | null - Selection mode.Try it:
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.Moment - Self instance for method chaining.Try it:
unhover
Removes hover from the series.
Params:
| Name | Type | Description |
|---|---|---|
| indexOrIndexes | number | Array.<number> | Point index or array of indexes. |
Returns:
anychart.core.timeline.series.Moment - Self instance for method chaining.Try it:
unselect
Deselects all selected points.
Returns:
anychart.core.timeline.series.Moment - Self instance for method chaining.Try it:
Deselects selected point by index.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Index of the point to select. |
Returns:
anychart.core.timeline.series.Moment - Self instance for method chaining.Try it:
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.Moment - Self instance for method chaining.Try it: