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

Base class for all scatter series.

Methods Overview

Specific settings
a11y()	Accessibility 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()	Gets the statistics value by key.
includeAllPoints()	Includes all excluded points.
includePoint()	Includes excluded points with the specified indexes.
keepOnlyPoints()	Keep only the specified points.
Interactivity
enabled()	Element state (enabled or disabled).
hovered()	Hovered state settings.
normal()	Normal state settings.
select()	Select settings.
selected()	Selected state settings.
unhover()	Removes hover from the series.
unselect()	Deselects all selected points.
Point Elements
error()	Error settings.
getPoint()	Gets wrapped point by index.
Scales
xScale()	X-scale settings.
yScale()	Y-scale settings.
Size and Position
bottom()	Bottom bound settings.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
left()	Left bound settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound settings.
top()	Top bound settings.
width()	Width settings.
zIndex()	Z-index of the element.

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

Try it:

bottom

bottom()

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.

bottom(bottom)

Setter for element bottom bound settings.

Params:

Name	Type	Default	Description
bottom	number \| string \| null	null	Bottom bound settings for the element.

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for element bounds settings.

Returns:

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

bounds(bounds)

Setter for bounds of the element using one parameter.

Params:

Name	Type	Description
bounds	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 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(settings)

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

Params:

Name	Type	Default	Description
settings	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 element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

error

error()

Getter for series error.

Returns:

anychart.core.utils.Error - Series error.

Try it:

Usage sample

error(settings)

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
settings	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

Gets the statistics value by key.

Params:

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

Returns:

* - Statistics value.

Try it:

Usage sample

height

height()

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.

height(height)

Setter for element height setting.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Height settings for the element.

Returns:

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

Returns:

number | string | undefined - Element's left bound setting.

left(left)

Setter for element left bound settings.

Params:

Name	Type	Default	Description
left	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

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.

maxHeight(height)

Setter for the maximum height.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Maximum height to set.

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.

maxWidth(width)

Setter for the maximum width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Maximum width to set.

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.

minHeight(height)

Setter for the 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
height	number \| string \| null	null	Minimum height to set.

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.

minWidth(width)

Setter for the 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
width	number \| string \| null	null	Minimum width to set.

Returns:

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

Try it:

Usage sample

right

right()

Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.

right(right)

Setter for element right bound setting.

Params:

Name	Type	Default	Description
right	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

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

Try it:

Usage sample

top

top()

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.

top(top)

Setter for element top bound settings.

Params:

Name	Type	Default	Description
top	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

unselect

unselect()Since version 7.7.0

Deselects all selected points.

Returns:

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

Try it:

Usage sample

width

width()

Getter for element width settings.

Returns:

number | string | undefined - Element's width setting.

width(width)

Setter for element width setting.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Width settings for the element.

Returns:

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

Try it:

Usage sample

xScale

xScale()

Getter for the series X-scale.

Returns:

anychart.scales.ScatterBase - Series X-scale.

See listing

var xScale = series.xScale();

xScale(scale)

Setter for the series X-scale.

Params:

Name	Type	Default	Description
scale	anychart.scales.Base	anychart.scales.Linear	Scale settings to set.

Returns:

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

Try it:

Usage sample

yScale

yScale()

Getter for the series Y-scale.

Returns:

anychart.scales.ScatterBase - Series Y-scale.

See listing

var yScale = series.yScale();

yScale(settings)

Setter for the series Y-scale.

Params:

Name	Type	Default	Description
settings	anychart.scales.ScatterBase \| Object \| anychart.enums.ScaleTypes \| string	anychart.scales.Linear	Scale settings to set.

Returns:

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

Try it:

Usage sample

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(zIndex)

Setter for the Z-index of the element.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
zIndex	number	0	Value to set.

Returns:

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

Try it:

Usage sample