Top
You are looking at an outdated 7.8.0 version of this document. Switch to the 7.14.3 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.
Events
listen()Adds an event listener.
listenOnce()Adds a single time event listener.
removeAllListeners()Remove all listeners.
unlisten()Remove of the listener.
unlistenByKey()Remove of 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:

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

Returns:

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

Try it:

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:

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

Returns:

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

Try it:

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.VisualBase - Self instance for method chaining.

Try it:

clip

Getter for series clip settings.

Returns:

boolean anychart.math.Rect - Current clip settings.

Try it:

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:

enabled

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

Returns:

boolean - The current element state.

Try it:

Setter for the element enabled state.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

error

Getter for series error.

Returns:

anychart.core.utils.Error - Current series error.

Try it:

Setter for series error.

Params:

Name Type Description
value Object | null | boolean | string | number Error settings.

Returns:

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

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:

Name Type Description
index number Point index.

Returns:

anychart.core.SeriesPoint - Wrapped point.

Try it:

height

Getter for element height setting.

Returns:

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

Params:

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

Returns:

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

Try it:

id

Getter for the current series id.

Returns:

string number - The current series id.

Try it:

Setter for the series id.

Params:

Name Type Description
value string | number Id of the series. Default id is equal to internal index.

Returns:

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

Try it:

left

Getter for element left bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

listen

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

maxHeight

Getter for maximum height.

Returns:

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

Params:

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

Returns:

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

Try it:

maxWidth

Getter for maximum width.

Returns:

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

Params:

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

Returns:

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

Try it:

minHeight

Getter for minimum height.

Returns:

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

Params:

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

Returns:

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

Try it:

minWidth

Getter for minimum width.

Returns:

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

Params:

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

Returns:

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

Try it:

print

Prints all elements on related stage.

Params:

Name Type Default Description
paperSize anychart.graphics.vector.PaperSize
Paper size.
landscape boolean
false
Flag of landscape.

Try it:

removeAllListeners

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:

Getter for element right bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

select

Imitates selects a point of the series by its index.

Params:

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

Returns:

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

Try it:

Imitates selects a point of the series by several indexes.

Params:

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

Returns:

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

Try it:

selectLabels

Gets the current series select data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Sets the series select data labels.

Params:

Name Type Description
value Object | boolean | null Series 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.

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

Try it:

top

Getter for element top bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

transformX

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:

transformY

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:

unhover

Removes hover from the series.

Returns:

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

Try it:

unlisten

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

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

unselect

Deselects all selected points.

Returns:

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

Try it:

width

Getter for element width setting.

Returns:

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

Params:

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

Returns:

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

Try it:

xScale

Getter for current series X scale.

Returns:

anychart.scales.ScatterBase - Current series X scale.
Setter for series X scale.

Params:

Name Type Default Description
value anychart.scales.Base
null
Value to set.

Returns:

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

Try it:

yScale

Getter for current series Y scale.

Returns:

anychart.scales.ScatterBase - Current series Y scale.
Setter for series Y scale.

Params:

Name Type Default Description
value anychart.scales.ScatterBase
null
Value to set.

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it: