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

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

bottom()

Getter for element bottom bound setting.

Returns:

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

bottom(value)

Sets element bottom bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Bottom bound setting for the element.

Returns:

anychart.core.scatter.series.Base - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.

bounds(value)

Sets bounds of the element using one parameter.

Params:

Name	Type	Description
value	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

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

Try it:

Usage sample

bounds(x, y, width, height)

Setter for the element bounds settings.

Params:

Name	Type	Default	Description
x	number \| string	null	X-coordinate.
y	number \| string	null	Y-coordinate.
width	number \| string	null	Width.
height	number \| string	null	Height.

Returns:

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

Try it:

Usage sample

clip

clip()

Getter for series clip settings.

Returns:

boolean | anychart.math.Rect - Clip settings.

Try it:

Usage sample

clip(value)

Setter for series clip settings. Clips visible part of a series by a rectangle (or chart).

Params:

Name	Type	Default	Description
value	boolean \| 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.

Try it:

Usage sample

enabled

enabled()

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

Returns:

boolean - The current element state.

Try it:

Usage sample

Name	Type	Default	Description
value	boolean	true	Value to set.

error

error()

Getter for series error.

Returns:

anychart.core.utils.Error - Series error.

Try it:

Usage sample

error(value)

Setter for series error.

Detailed description

Sets series error settings depending on parameter type:

null - disable series error.
boolean - enable mode both or none for series error.
string - sets value for series error.
object - sets series error settings.

Params:

Name	Type	Description
value	Object \| null \| boolean \| string \| number	Error 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.

Try it:

excludePoint

excludePoint(indexes)Since version 7.11.1

Excludes points at the specified index.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Points indexes.

Returns:

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

Try it:

Usage sample

getExcludedPoints

getExcludedPoints()Since version 7.11.1

Returns an array of excluded points.

Returns:

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

Try it:

Usage sample

getPixelBounds

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

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

getStat

getStat(key)Since version 7.8.0

Getter for the statistics value by key.

Params:

Name	Type	Description
key	string \| anychart.enums.Statistics	Key.

Returns:

* - Statistics value.

Try it:

Usage sample

height

height()

Getter for element height setting.

Returns:

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

height(value)

Sets element height setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Height setting for the element.

Returns:

anychart.core.scatter.series.Base - Returns self for method chaining.

Try it:

Usage sample

id

id()Since version 7.8.0

Getter for the current series id.

Returns:

string | number - The current series id.

Try it:

Usage sample

id(value)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
value	string \| number	Id of the series. Default id is equal to internal index.

Returns:

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

Try it:

Usage sample

includeAllPoints

includeAllPoints()Since version 7.11.1

Includes all excluded points.

Returns:

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

Try it:

Usage sample

includePoint

includePoint(indexes)Since version 7.11.1

Includes excluded points with the specified indexes.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Points indexes.

Returns:

boolean - Returns true if the points were included.

Try it:

Usage sample

keepOnlyPoints

keepOnlyPoints(indexes)Since version 7.11.1

Keep only the specified points.

Params:

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

Try it:

Usage sample

left

left()

Getter for element left bound setting.

Returns:

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

left(value)

Sets element left bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Left bound setting for the element.

Returns:

anychart.core.scatter.series.Base - Returns self for method chaining.

Try it:

Usage sample

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		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 }`.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

maxHeight

maxHeight()

Getter for maximum height.

Returns:

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

maxHeight(value)

Setter for maximum height.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

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

maxWidth(value)

Setter for maximum width.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

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

minHeight(value)

Setter for minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

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

minWidth(value)

Setter for minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Value to set.

Returns:

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

Try it:

Usage sample

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

Params:

Name	Type	Default	Description
paperSizeOrOptions	anychart.graphics.vector.PaperSize \| Object		Paper size or object with options.
landscape	boolean	false	Flag of landscape.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

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

Params:

Name	Type	Description
type	string	Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

Usage sample

right

right()

Getter for element right bound setting.

Returns:

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

right(value)

Sets element right bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Right bound setting for the element.

Returns:

anychart.core.scatter.series.Base - Returns self for method chaining.

Try it:

Usage sample

select

select(index)Since version 7.7.0

Selects point by index.

Params:

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

Returns:

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

Try it:

Usage sample

select(indexes)Since version 7.7.0

Selects point by indexes.

Params:

Name	Type	Description
indexes	number \| Array.<number>	Array of indexes of the point to select.

Returns:

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

Try it:

Usage sample

selectLabels

selectLabels()Since version 7.7.0

Gets the current series select data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

selectLabels(value)Since version 7.7.0

Sets the series select data labels.

Detailed description

Setting selected labels settings depending on parameter type:

null/boolean - disable or enable labels in selected state.
object - sets selected labels settings.

Params:

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

Returns:

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

Try it:

selectionMode

selectionMode()Since version 7.7.0

Gets the current state of the series for selection mode.

Returns:

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

Try it:

Usage sample

top

top()

Getter for element top bound setting.

Returns:

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

top(value)

Sets element top bound setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Top bound setting for the element.

Returns:

anychart.core.scatter.series.Base - Returns self for method chaining.

Try it:

Usage sample

transformX

transformX(xValue)Since version 7.8.0

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

Params:

Name	Type	Description
xValue	*	X value.

Returns:

number - Pixel value.

Try it:

Usage sample

transformY

transformY(yValue)Since version 7.8.0

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

Params:

Name	Type	Description
yValue	*	Y value.

Returns:

number - Pixel value.

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

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.