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

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

Extends: anychart.core.SeriesBase

Base class for all scatter series.

Methods Overview

Specific settings
clip()Clip settings.
id()Series id.
selectionMode()Selection mode.
transformX()Transforms X value to pixel coordinates.
transformY()Transforms Y value to pixel coordinates.
Data
excludePoint()Excludes points at the specified index.
getExcludedPoints()Returns an array of excluded points.
getStat()Getter for the statistics value by key.
includeAllPoints()Includes all excluded points.
includePoint()Includes excluded points with the specified indexes.
keepOnlyPoints()Keep only the specified points.
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).
select()Select settings.
unhover()Removes hover from the series.
unselect()Deselects all selected points.
Point Elements
error()Error settings.
getPoint()Gets wrapped point by index.
selectLabels()Labels settings in selected mode.
Scales
xScale()X-scale settings.
yScale()Y-scale settings.
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

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.scatter.series.Base - 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.scatter.series.Base - 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.scatter.series.Base - Self instance for method chaining.

clip

Getter for series clip settings.

Returns:

boolean | anychart.math.Rect - Clip settings.
Setter for series clip settings. Clips visible part of a series by a rectangle (or chart).

Params:

NameTypeDefaultDescription
valueboolean | anychart.math.Rect
False, if series is created manually.
True, if created via chart
Enable/disable series clip.

Returns:

anychart.core.scatter.series.Base - 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.scatter.series.Base - Self instance for method chaining.
Example.
if (!element.enabled())
   element.enabled(true);

error

Getter for series error.

Returns:

anychart.core.utils.Error - Series error.
Setter for series error.

Params:

NameTypeDescription
valueObject | null | boolean | string | numberError settings. An error value can be set as absolute numbers or as a percentage.

Returns:

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

excludePoint

Excludes points at the specified index.

Params:

NameTypeDescription
indexesnumber | Array.<number>Points indexes.

Returns:

boolean - Returns 'true' if the points were excluded.

getExcludedPoints

Returns an array of excluded points.

Returns:

Array.<anychart.core.Point> - Array of the points.

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.scatter.series.Base - Returns self 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.scatter.series.Base - Self instance for method chaining.

includeAllPoints

Includes all excluded points.

Returns:

boolean - Returns 'true' if all points were included.

includePoint

Includes excluded points with the specified indexes.

Params:

NameTypeDescription
indexesnumber | Array.<number>Points indexes.

Returns:

boolean - Returns true if the points were included.

keepOnlyPoints

Keep only the specified points.

Params:

NameTypeDescription
indexesnumber | Array.<number>Point index or indexes.

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.scatter.series.Base - Returns self for method 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.scatter.series.Base - 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.scatter.series.Base - 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.scatter.series.Base - 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.scatter.series.Base - 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.scatter.series.Base - Returns self for method chaining.

select

Selects point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.scatter.series.Base - 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.scatter.series.Base - 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.scatter.series.Base - 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.scatter.series.Base - 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.scatter.series.Base - Returns self for method chaining.

transformX

Transforms X value to pixel coordinates. Note: Works only after anychart.charts.Scatter#draw is called.

Params:

NameTypeDescription
xValue*X value.

Returns:

number - Pixel value.

transformY

Transforms Y value to pixel coordinates. Note: Works only after anychart.charts.Scatter#draw is called.

Params:

NameTypeDescription
yValue*Y value.

Returns:

number - Pixel value.

unhover

Removes hover from the series.

Params:

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

Returns:

anychart.core.scatter.series.Base - 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.scatter.series.Base - Self instance for method chaining.
Deselects selected point by index.

Params:

NameTypeDescription
indexnumberIndex of the point to select.

Returns:

anychart.core.scatter.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.scatter.series.Base - 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.scatter.series.Base - Returns self for method chaining.

xScale

Getter for the series X-scale.

Returns:

anychart.scales.ScatterBase - Series X-scale.
See listing
var xScale = series.xScale();
Setter for the series X-scale.

Params:

NameTypeDefaultDescription
valueanychart.scales.Base
null
Value to set.

Returns:

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

yScale

Getter for the series Y-scale.

Returns:

anychart.scales.ScatterBase - Series Y-scale.
See listing
var yScale = series.yScale();
Setter for the series Y-scale.

Params:

NameTypeDefaultDescription
valueanychart.scales.ScatterBase
null
Value to set.

Returns:

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