AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.14.3 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.core.SeriesBase Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Base class for all base series.
Base class defines common methods, such as those for:

  • Binding series to a scale: xScale, yScale
  • Base color settings: color
You can also obtain getIterator, getResetIterator iterators here.

Methods Overview

Specific settings
a11y()Accessibility setting.
id()Series id.
legendItem()Legend item settings.
selectionMode()Selection mode.
Coloring
color()Color settings.
Data
data()Data settings.
getStat()Getter for the statistics value by key.
meta()Series meta data settings.
name()Series name 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.
Export
print()Prints all elements.
Interactivity
enabled()Element state (enabled or disabled).
hover()Hover settings.
select()Select settings.
tooltip()Tooltip settings.
unhover()Removes hover from the series.
unselect()Deselects all selected points.
Point Elements
getPoint()Gets wrapped point by index.
hoverLabels()Labels settings in hover mode.
labels()Labels settings.
selectLabels()Labels settings in selected mode.
Size and Position
bottom()Bottom bound setting.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
height()Height setting.
left()Left bound setting.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
right()Right bound setting.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.

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 currentStateOfAccsessibility = series.a11y();
Setter for the accessibility setting.

Params:

NameTypeDescription
valueboolean | ObjectWhether to enable accessibility.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

bottom

Getter for element bottom bound setting.

Returns:

number | string | undefined - Current element's bottom bound setting.
Sets element bottom bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Bottom bound setting for the element.

Returns:

anychart.core.SeriesBase - Returns self for method chaining.

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets bounds of the element using one parameter.

Params:

NameTypeDescription
valueanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.
Setter for the element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

color

Getter for the series color.

Returns:

string - Series color.
Setter for the series color.

Params:

NameTypeDescription
valuestringColor as a string.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

data

Getter for series mapping.

Returns:

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

Params:

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

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

enabled

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
valueboolean
true
Value to set.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

getPixelBounds

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

getPoint

Gets wrapped point by index.

Params:

NameTypeDescription
indexnumberPoint index.

Returns:

anychart.core.SeriesPoint - Wrapped point.

getStat

Getter for the statistics value by key.

Params:

NameTypeDescription
keystring | anychart.enums.StatisticsKey.

Returns:

* - Statistics value.

height

Getter for element height setting.

Returns:

number | string | undefined - Current element's height setting.
Sets element height setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Height setting for the element.

Returns:

anychart.core.SeriesBase - Returns self for method chaining.

hover

Hovers points.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.
Hovers point by index.

Params:

NameTypeDescription
indexnumberPoint index.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.
Hovers points by indexes.

Params:

NameTypeDescription
indexesArray.<number>Array of indexes.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

hoverLabels

Gets the current series hover data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Sets the series hover data labels.

Params:

NameTypeDescription
valueObject | boolean | nullSeries data labels settings.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

id

Getter for the current series id.

Returns:

string | number - The current series id.
Setter for the series id.

Params:

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

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

labels

Getter for the current series data labels.

Returns:

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

Params:

NameTypeDescription
valueObject | boolean | nullSeries data labels settings.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

left

Getter for element left bound setting.

Returns:

number | string | undefined - Current element's left bound setting.
Sets element left bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the element.

Returns:

anychart.core.SeriesBase - Returns self for method chaining.

legendItem

Gets the current legend item setting for series.

Returns:

anychart.core.utils.LegendItemSettings - Legend item settings.
Sets the legend item setting for series.

Params:

NameTypeDescription
valueObjectLegend item settings object.

Returns:

anychart.core.SeriesBase - Legend item settings or self for chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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 }.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

maxHeight

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.
Setter for maximum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

maxWidth

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.
Setter for maximum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

meta

Gets series meta data.

Params:

NameTypeDescription
key*Metadata key.

Returns:

* - Metadata object, key value or itself for method chaining.
Sets series meta data using object.

Params:

NameTypeDescription
object*Object to replace metadata.
value*Meta data value.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.
Sets series meta data using key.

Params:

NameTypeDescription
key*Metadata key.
value*Meta data value.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

minHeight

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.
Setter for minimum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

minWidth

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.
Setter for minimum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

name

Getter for the current series name.

Returns:

string | undefined - The current series name value.
Setter for the series name.

Params:

NameTypeDescription
valuestringValue to set.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.
Getter for element right bound setting.

Returns:

number | string | undefined - Current element's right bound setting.
Sets element right bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Right bound setting for the element.

Returns:

anychart.core.SeriesBase - Returns self for method chaining.

select

Selects point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.
Selects point by indexes.

Params:

NameTypeDescription
indexesnumber | Array.<number>Array of indexes of the point to select.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

selectLabels

Gets the current series select data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Sets the series select data labels.

Params:

NameTypeDescription
valueObject | boolean | nullSeries data labels settings.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

selectionMode

Gets the current state of the series for selection mode.

Returns:

anychart.enums.SelectionMode | 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.SeriesBase - Self instance for method chaining.

tooltip

Gets the current series data tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Sets series data tooltip.

Params:

NameTypeDescription
valueObject | boolean | nullTooltip settings.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

top

Getter for element top bound setting.

Returns:

number | string | undefined - Current element's top bound setting.
Sets element top bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Top bound setting for the element.

Returns:

anychart.core.SeriesBase - Returns self for method chaining.

unhover

Removes hover from the series.

Params:

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

Returns:

anychart.core.SeriesBase - Self instance for method chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

unselect

Deselects all selected points.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.
Deselects selected point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.SeriesBase - 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.SeriesBase - Self instance for method chaining.

width

Getter for element width setting.

Returns:

number | string | undefined - Current element's width setting.
Sets element width setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Width setting for the element.

Returns:

anychart.core.SeriesBase - Returns self for method chaining.

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

anychart.core.SeriesBase - Self instance for method chaining.