Top
You are looking at an outdated 7.9.0 version of this document. Switch to the 8.0.1 version to see the up to date information.

class anychart.charts.Scatter Improve this Doc

Extends: anychart.core.SeparateChart

Scatter chart class.

Methods Overview

Specific settings
getType()Definition of the chart type.
Axes and Scales
grid()Grid settings.
lineMarker()Line marker settings.
minorGrid()Minor grid settings.
rangeMarker()Range marker settings.
textMarker()Text marker settings.
xAxis()X-axis settings.
xScale()X-scale settings.
yAxis()Y-axis settings.
yScale()Y-scale settings.
Chart Coloring
animation()Animation settings
background()Background settings.
hatchFillPalette()Hatch fill palette settings.
markerPalette()Markers palette settings.
palette()Palette settings.
Chart Controls
credits()Credits settings
label()Label settings.
legend()Legend settings.
title()Title settings.
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
crosshair()Crosshair settings
interactivity()Interactivity settings.
tooltip()Tooltip settings.
Series
bubble()Addition of the bubble series.
getSeries()Gets series by index.
line()Addition of the line series.
marker()Addition of the marker series.
Size and Position
bottom()Bottom bound setting.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
getPlotBounds()Getter for the current data bounds of the chart.
height()Height setting.
left()Left bound setting.
margin()Margin settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings.
right()Right bound setting.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.
Specific Series Settings
addSeries()Add series to chart.
defaultSeriesType()Default series type.
getSeriesAt()Gets series by its index.
getSeriesCount()Returns series count.
maxBubbleSize()Maximum size for all bubbles
minBubbleSize()Minimum size for all bubbles
removeAllSeries()Removes all series from chart.
removeSeries()Removes one of series from chart by its id.
removeSeriesAt()Removes one of series from chart by its index.
XML/JSON
toJson()Return chart configuration as JSON object or string.
toXml()Return chart configuration as XML string or XMLNode.
Miscellaneous
container()Getter for the element's container.
draw()Drawing of the chart.

Methods Description

addSeries

Add series to chart.

Params:

Name Type Description
var_args anychart.data.View | anychart.data.Set | Array Chart series data.

Returns:

Array.<anychart.core.scatter.series.Base> - Array of created series.

Try it:

animation

Getter for the current animation setting.

Returns:

anychart.core.utils.Animation - Returns true if the animation is enabled.

Try it:

Setter for the animation setting by one value.

Params:

Name Type Default Description
value boolean | Object
false
Whether to enable animation.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for the animation setting.

Params:

Name Type Default Description
enabled boolean
false
Whether to enable animation.
duration number
1000
Duration in milliseconds.

Returns:

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

Try it:

background

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current chart background.

Try it:

Setter for the chart background.

Params:

Name Type Default Description
value Object
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

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

Try it:

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:

bubble

Adds Bubble series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Data for the series.
csvSettings Object.<string, (string|boolean)> If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.scatter.series.Bubble - An instance of class for method chaining.

Try it:

container

Getter for the element's container.
Setter for the element's container.

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example
// string
 element.container('containerIdentifier');
// DOM-element
 var domElement = document.getElementById('containerIdentifier');
 element.container(domElement);
// Framework-element
 var fwElement = anychart.ui.title();
 element.container( fwElement.container() );

Try it:

credits

Getter for the current credits.

Returns:

anychart.core.ui.Credits - Chart credits.

Try it:

Setter for the chart credits. Learn more about credits settings.

Params:

Name Type Default Description
value Object | boolean | null
true
Credits settings

Returns:

anychart.core.Chart - An instance of class for method chaining.

crosshair

Getter for the current crosshair settings.

Returns:

anychart.core.ui.Crosshair - The current crosshair settings.

Try it:

Setter for the crosshair settings.

Params:

Name Type Default Description
value Object | boolean | null
false
Crosshair settings.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

defaultSeriesType

Getter for the default scatter series type.

Returns:

string - Default series type.

Try it:

Getter for the scatter default series type.

Params:

Name Type Description
value string Default series type.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

Try it:

draw

Starts the rendering of the chart into the container.

Returns:

anychart.core.Chart - 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.

getPlotBounds

Getter for the current data bounds of the chart. Note: Works only after anychart.charts.Scatter#draw is called.

Returns:

anychart.math.Rect - The current data bounds of the chart.

Try it:

getSeries

Getter series by its id.

Params:

Name Type Description
id number | string Id of the series.

Returns:

anychart.core.scatter.series.Base - An instance of class for method chaining.

Try it:

getSeriesAt

Gets series by its index.

Params:

Name Type Description
index number Index of the series.

Returns:

anychart.core.scatter.series.Base - An instance of class for method chaining.

Try it:

getSeriesCount

Returns series count.

Returns:

number - Number of series.

Try it:

getType

Returns chart type.

Returns:

string - Current chart type.

Try it:

grid

Getter for chart grid.

Params:

Name Type Default Description
index number
0
Chart grid index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.grids.Linear - Axis instance by index.

Try it:

Setter for chart grid.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart grid settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.
Setter for chart grid by index.

Params:

Name Type Default Description
index number
0
Chart grid index.
value Object | boolean | null
Chart grid settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

hatchFillPalette

Getter for hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Current markers palette.

Params:

Name Type Description
value Array.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFills Chart hatch fill palette settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

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:

interactivity

Gets the current interactivity settings for chart.

Returns:

anychart.core.utils.Interactivity - The current interactivity settings.
Sets interactivity settings for chart.

Params:

Name Type Description
value Object | anychart.enums.HoverMode Settings object or boolean value like enabled state.

Returns:

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

Try it:

label

Getter for chart label.

Params:

Name Type Default Description
index string | number
0
Index of instance.

Returns:

anychart.core.ui.Label - An instance of class.

Try it:

Setter for chart label.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for chart label.

Params:

Name Type Default Description
index string | number
Label index.
value null | boolean | Object | string
false
Chart label settings.

Returns:

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

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:

legend

Getter for the current chart legend.

Returns:

anychart.core.ui.Legend - An instance of class for method chaining.

Try it:

Setter for chart legend setting.

Params:

Name Type Default Description
value Object | boolean | null
false
Legend settings.

Returns:

anychart.core.Chart - An instance of class for method chaining.

line

Adds Line series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Data for the series.
csvSettings Object.<string, (string|boolean)> If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.scatter.series.Line - An instance of class for method chaining.

Try it:

lineMarker

Getter for chart line marker.

Params:

Name Type Default Description
index number
0
Chart line marker index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Line - Line marker instance by index.

Try it:

Setter for chart line marker.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart line marker settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.
Setter for chart line marker by index.

Params:

Name Type Default Description
index number
0
Chart line marker index.
value Object | boolean | null
Chart line marker settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

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:

margin

Getter for the current chart margin.

Returns:

anychart.core.utils.Margin - The current chart margin.
Setter for the chart margin in pixels using a single complex object.

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.space(5, 15));

Try it:

Setter for the chart margin in pixels using several simple values.

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | number
0
Left space.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// 1) all 10px
chart.margin(10);
// 2) top and bottom 10px, left and right 15px
chart.margin(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.margin(10, "15px", 5);
// 4) top 10px, right 15px, bottom 5px, left 12px
chart.margin(10, "15px", "5px", 12);

Try it:

marker

Adds Marker series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Data for the series.
csvSettings Object.<string, (string|boolean)> If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.scatter.series.Marker - An instance of class for method chaining.

Try it:

markerPalette

Getter for markers palette settings.

Returns:

anychart.palettes.Markers - Current markers palette.
Setter for markers palette settings.

Params:

Name Type Description
value anychart.palettes.Markers | Object | Array.<anychart.enums.MarkerType> Value to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

Try it:

maxBubbleSize

Getter for the current maximum size for all bubbles on the charts.

Returns:

number string - The current maximum size of the all bubbles.

Try it:

Setter for the maximum size for all bubbles on the charts.

Params:

Name Type Default Description
value number | string
"20%"
Maximum size to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

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:

minBubbleSize

Getter for the current minimum size for all bubbles on the charts.

Returns:

number string - The current minimum size of the all bubbles.

Try it:

Setter for the minimum size for all bubbles on the charts.

Params:

Name Type Default Description
value number | string
"5%"
Minimum size to set.

Returns:

anychart.charts.Scatter - 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:

minorGrid

Getter for chart minor grid.

Params:

Name Type Default Description
index number
0
Chart minor grid index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.grids.Linear - Axis instance by index.

Try it:

Setter for chart minor grid.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart minor grid settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.
Setter for chart minor grid by index.

Params:

Name Type Default Description
index number
0
Chart minor grid index.
value Object | boolean | null
Chart minor grid settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

padding

Getter for the current chart padding.

Returns:

anychart.core.utils.Padding - Current chart padding.
Setter for the chart paddings in pixels using a single value.

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});

Try it:

Setter for the chart paddings in pixels using several numbers.

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | number
0
Left space.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// 1) all 10px
chart.padding(10);
// 2) top and bottom 10px, left and right 15px
chart.padding(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.padding(10, "15px", 5);
// 4) top 10px, right 15%, bottom 5px, left 12px
chart.padding(10, "15%", "5px", 12);

Try it:

palette

Getter for series colors palette.
Setter for series colors palette.

Params:

Name Type Description
value anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> Value to set.

Returns:

anychart.charts.Scatter - 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:

rangeMarker

Getter for chart range marker.

Params:

Name Type Default Description
index number
0
Chart range marker index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Range - Range marker instance by index.

Try it:

Setter for chart range marker.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart range marker settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.
Setter for chart range marker by index.

Params:

Name Type Default Description
index number
0
Chart range marker index.
value Object | boolean | null
Chart range marker settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

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:

removeAllSeries

Removes all series from chart.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

Try it:

removeSeries

Removes one of series from chart by its id.

Params:

Name Type Description
id number | string Series id.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

Try it:

removeSeriesAt

Removes one of series from chart by its index.

Params:

Name Type Description
index number Series index.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

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:

textMarker

Getter for chart text marker.

Params:

Name Type Default Description
index number
0
Chart text marker index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Text - Text marker instance by index.

Try it:

Setter for chart text marker.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart text marker settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.
Setter for chart text marker by index.

Params:

Name Type Default Description
index number
0
Chart text marker index.
value Object | boolean | null
Chart text marker settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

title

Getter for chart title.

Returns:

anychart.core.ui.Title - The current chart title.

Try it:

Setter for the chart title.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

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

toJson

Return chart configuration as JSON object or string.

Params:

Name Type Default Description
stringify boolean
false
Returns JSON as string.
includeTheme boolean
false
If the current theme properties should be included into the result.

Returns:

Object string - Chart configuration.

toXml

Return chart configuration as XML string or XMLNode.

Params:

Name Type Default Description
asXmlNode boolean
false
Return XML as XMLNode.
includeTheme boolean
false
If the current theme properties should be included into the result.

Returns:

string Node - Chart configuration.

tooltip

Getter for current chart tooltip.

Returns:

anychart.core.ui.ChartTooltip anychart.core.ui.Tooltip - An instance of class for method chaining.
Example
var tooltipSettings = chart.tooltip();
Setter for chart tooltip.

Params:

Name Type Description
value Object | boolean | null

Returns:

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

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:

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:

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:

xAxis

Getter for chart X-axis.

Params:

Name Type Default Description
index number
0
Chart axis index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axes.Linear - Axis instance by index.

Try it:

Setter for chart X-axis.

Params:

Name Type Default Description
value Object | boolean | null
true
Chart axis settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.
Setter for chart X-axis by index.

Params:

Name Type Default Description
index number
0
Chart axis index.
value Object | boolean | null
Chart axis settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

xScale

Getter for default chart X scale.

Returns:

anychart.scales.ScatterBase - Default chart scale value.

Try it:

Setter for default chart X scale.

Params:

Name Type Default Description
value anychart.enums.ScatterScaleTypes | anychart.scales.ScatterBase
"linear"
X Scale to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

Try it:

yAxis

Getter for chart Y-axis.

Params:

Name Type Default Description
index number
0
Chart axis index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axes.Linear - Axis instance by index.

Try it:

Setter for chart Y-axis.

Params:

Name Type Default Description
value Object | boolean | null
true
Chart axis settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.
Setter for chart Y-axis by index.

Params:

Name Type Default Description
index number
0
Chart axis index.
value Object | boolean | null
Chart axis settings to set.

Returns:

anychart.charts.Scatter - Self instance for method chaining.

yScale

Getter for default chart Y scale.

Returns:

anychart.scales.ScatterBase - Default chart scale value.

Try it:

Setter for default chart Y scale.

Params:

Name Type Default Description
value anychart.enums.ScatterScaleTypes | anychart.scales.ScatterBase
"linear"
Y Scale to set.

Returns:

anychart.charts.Scatter - 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: