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

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

Extends: anychart.core.VisualBaseWithBounds

Base class for all scatter series.

Methods Overview

Miscellaneous
clip()Getter for series clip settings.
color()Getter for current series color.
data()Getter for series mapping.
error()Getter for series error.
hover()Sets the hover state on a point or a series.
hoverLabels()Getter for series data hover labels.
labels()Getter for current series data labels.
legendItem()Getter for legend item settings of series.
meta()Getter for series meta data.
name()Getter for series name.
tooltip()Getter for current series data tooltip.
xScale()Getter for current series X scale.
yScale()Getter for current series Y scale.

Methods Description

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:

color

Getter for current series color.

Returns:

anychart.graphics.vector.Fill - Current color.

Try it:

Sets color settings using an object or a string. Learn more about coloring.

Params:

Name Type Default Description
value anychart.graphics.vector.Fill
'#1D8BD1'
Color as an object or a string.

Returns:

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

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

data

Getter for series mapping.

Returns:

anychart.data.View - Returns current mapping.

Try it:

Setter for series mapping.

Params:

Name Type Description
value anychart.data.View | anychart.data.Set | Array | string Value to set.
csvSettings Object.<string, (string|boolean)> If CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

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

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.

hover

Sets the hover state on a point or a series.

Params:

Name Type Description
index number Point index.

Returns:

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

hoverLabels

Getter for series data hover labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for series data hover labels.

Params:

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

Returns:

anychart.core.ui.LabelsFactory anychart.core.scatter.series.Base - Labels instance or itself for chaining call.

labels

Getter for current series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for series data labels.

Params:

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

Returns:

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

legendItem

Getter for legend item settings of series.

Returns:

anychart.core.utils.LegendItemSettings - Legend item settings.
Setter for legend item settings of series.

Params:

Name Type Description
value Object Legend item settings object.

Returns:

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

Try it:

meta

Getter for series meta data.

Params:

Name Type Description
key * Metadata key.

Returns:

* - Metadata object by key.

Try it:

Setter for series meta data.

Params:

Name Type Description
object * Object to replace metadata.

Returns:

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

Try it:

Add/Replace meta data for series by key.

Params:

Name Type Description
key string Metadata key.
value * Metadata value.

Returns:

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

Try it:

name

Getter for series name.

Returns:

string undefined - Series name value.

Try it:

Setter for series name.

Params:

Name Type Default Description
value string
undefined
Value to set.

Returns:

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

Try it:

tooltip

Getter for current series data tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.

Try it:

Setter for series data tooltip.

Params:

Name Type Default Description
value Object | boolean | null
true
Tooltip settings.

Returns:

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

xScale

Getter for current series X scale.

Returns:

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

Params:

Name Type Description
value anychart.scales.Base 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 Description
value anychart.scales.ScatterBase Value to set.

Returns:

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

Try it: