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.4.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.
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.

color

Getter for current series color.

Returns:

anychart.graphics.vector.Fill - Current color.
Sets color settings using an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
valueanychart.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:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

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

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

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

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

data

Getter for series mapping.

Returns:

anychart.data.View - Returns current mapping.
Setter for series mapping.

Params:

NameTypeDescription
valueanychart.data.View | anychart.data.Set | Array | stringValue to set.
csvSettingsObject.<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.
Setter for series error.

Params:

NameTypeDescription
valueObject | null | boolean | string | numberError settings.

Returns:

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

hover

Sets the hover state on a point or a series.

Params:

NameTypeDescription
indexnumberPoint 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.
Setter for series data hover labels.

Params:

NameTypeDescription
valueObject | boolean | nullSeries 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.
Setter for series data labels.

Params:

NameTypeDefaultDescription
valueObject | 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:

NameTypeDescription
valueObjectLegend item settings object.

Returns:

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

meta

Getter for series meta data.

Params:

NameTypeDescription
key*Metadata key.

Returns:

* - Metadata object by key.
Setter for series meta data.

Params:

NameTypeDescription
object*Object to replace metadata.

Returns:

anychart.core.scatter.series.Base - Self instance for method chaining.
Add/Replace meta data for series by key.

Params:

NameTypeDescription
keystringMetadata key.
value*Metadata value.

Returns:

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

name

Getter for series name.

Returns:

string | undefined - Series name value.
Setter for series name.

Params:

NameTypeDefaultDescription
valuestring
undefined
Value to set.

Returns:

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

tooltip

Getter for current series data tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for series data tooltip.

Params:

NameTypeDefaultDescription
valueObject | 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:

NameTypeDescription
valueanychart.scales.BaseValue to set.

Returns:

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

yScale

Getter for current series Y scale.

Returns:

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

Params:

NameTypeDescription
valueanychart.scales.ScatterBaseValue to set.

Returns:

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