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

class anychart.charts.Cartesian Improve this Doc

Extends: anychart.core.SeparateChart

Cartesian chart class.
To get the chart use any of these methods:

Chart can contain any number of series. Each series is interactive, you can customize click and hover behavior and other parameters.

Methods Overview

Specific settings
annotations()Creates annotations.
getType()Definition of the chart type.
globalToLocal()Converts the global coordinates to local coordinates.
localToGlobal()Converts the local coordinates to global coordinates.
Axes and Scales
getXAxesCount()Returns the number of X-axes.
getXScales()Returns chart X scales.
getYAxesCount()Returns the number of Y-axes.
getYScales()Returns chart Y 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
contextMenu()Context menu settings.
credits()Credits settings
label()Label settings.
legend()Legend settings.
title()Title settings.
xScroller()Scroller settings.
Coloring
selectMarqueeFill()Select marquee fill settings.
selectMarqueeStroke()Stroke settings.
Data
getSelectedPoints()Getter for the selected points.
getStat()Getter for a statistical value by the key.
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 chart.
saveAsCsv()Saves chart data as CSV file.
saveAsJpg()Saves the current chart as JPEG image.
saveAsJson()Saves chart config as JSON document.
saveAsPng()Saves the current chart as PNG image.
saveAsSvg()Saves the current chart as SVG image.
saveAsXlsx()Saves chart data as Excel document.
saveAsXml()Saves chart config as XML document.
toCsv()Returns CSV string with series data.
toSvg()Returns SVG string.
Interactivity
crosshair()Crosshair settings.
interactivity()Interactivity settings.
startSelectMarquee()Starts select marquee drawing.
tooltip()Tooltip settings.
xZoom()Zoom settings.
Point Elements
hoverLabels()Labels settings.
labels()Labels settings.
selectLabels()Labels settings.
Series
area()Adds Area series.
bar()Adds Bar series.
box()Adds Box series.
bubble()Adds Bubble series.
candlestick()Adds Candlestick series.
column()Adds Column series.
hilo()Adds HiLo series.
jumpLine()Adds Jump Line series.
line()Adds Line series.
marker()Adds Marker series.
ohlc()Adds OHLC series.
rangeArea()Adds Range Area series.
rangeBar()Adds Range Bar series.
rangeColumn()Adds Range Column series.
rangeSplineArea()Adds Range Spline Area series.
rangeStepArea()Adds Range Step Area series.
spline()Adds Spline series.
splineArea()Adds Spline Area series.
stepArea()Adds Step Area series.
stepLine()Adds Step Line series.
stick()Adds Stick series.
Size and Position
bottom()Bottom bound setting.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds of the chart.
getPlotBounds()Returns data bounds of the chart.
height()Height setting.
left()Left bound setting.
margin()Margin settings.
maxHeight()Maximum height setting.
maxWidth()Maximum width setting.
minHeight()Minimum height setting.
minWidth()Minimum width setting.
padding()Padding settings.
right()Right bound setting.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the chart.
Specific Series Settings
addSeries()Adds series to the chart.
barGroupsPadding()Settings for the space between bar groups.
barsPadding()Settings for the space between bars.
defaultSeriesType()Default series type.
getSeries()Returns series by id.
getSeriesAt()Returns series by index.
getSeriesCount()Returns the number of series in a chart.
maxBubbleSize()Maximum size for all bubbles on the charts.
minBubbleSize()Minimum size for all bubbles on the charts.
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()Returns chart configuration as JSON object or string.
toXml()Returns chart configuration as XML string or XMLNode.
Miscellaneous
cancelMarquee()Stops current marquee action if any.
container()Chart container
data()Getter for the data.
draw()Drawing of cartesian chart.
inMarquee()Gets marquee process running value.
saveAsPdf()Saves the current chart as PDF image.

Methods Description

addSeries

Adds series to the chart.

Params:

NameTypeDescription
var_argsanychart.data.View | anychart.data.Set | ArrayChart series data.

Returns:

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

animation

Getter for the current animation settings.

Returns:

anychart.core.utils.Animation - Returns true if the animation is enabled.
Setter for the animation settings by one value.

Params:

NameTypeDefaultDescription
valueboolean | Object
false
Whether to enable animation.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Setter for the animation settings using of several parameters.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable animation.
durationnumber
1000
Duration in milliseconds.

Returns:

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

annotations

Getter for the annotations.

Returns:

anychart.core.annotations.PlotController - The plot annotations.
Setter for the annotations.

Params:

NameTypeDescription
annotationsListArrayAnnotations list to set.

Returns:

anychart.charts.Cartesian - Self instance for method chaining

area

Adds Area series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | ArrayData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Area - An instance of the created series.

background

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current chart background.
Setter for the chart background settings.

Params:

NameTypeDescription
valuestring | Object | null | booleanBackground settings to set.

Returns:

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

bar

Adds Bar series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Bar - An instance of the created series.

barGroupsPadding

Getter for the current space between bar groups on the ordinal scale by ratio of bars width.

Returns:

number - Current bar groups padding.
Setter for the space between bar groups on the ordinal scale by ratio of bars width.
See illustration at anychart.charts.Cartesian#barsPadding.

Params:

NameTypeDefaultDescription
valuenumber
0.8
Value to set.

Returns:

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

barsPadding

Getter for the space between bars on the ordinal scale by ratio of bars width.

Returns:

number - Current bars padding.
Setter for the space between bars on the ordinal scale by ratio of bars width.

Params:

NameTypeDefaultDescription
valuenumber
0.4
Value to set.

Returns:

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

bottom

Getter for the current chart's bottom bound setting.

Returns:

number | string | undefined - Current chart's bottom bound setting.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.bottom();
Setter for the chart's bottom bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Bottom bound setting for the chart.

Returns:

anychart.charts.Cartesian - Returns self for method chaining.

bounds

Getter for the current chart bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.bounds();
Setter for the chart bounds using one parameter.

Params:

NameTypeDescription
valueanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of teh chart.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Setter for the chart bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

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

box

Adds Box series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Box - An instance of the created series.

bubble

Adds Bubble series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Bubble - An instance of the created series.

cancelMarquee

Stops current marquee action if any.

Returns:

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

candlestick

Adds Candlestick series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Candlestick - An instance of the created series.

column

Adds Column series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Column - An instance of the created series.

container

Getter for the chart container.
Setter for the chart container.

Params:

NameTypeDescription
valueanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementThe value to set.

Returns:

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

contextMenu

Getter for the current context menu.

Returns:

anychart.ui.ContextMenu - The current context menu.
Setter for the context menu.

Params:

NameTypeDescription
valueObject | boolean | nullContext menu settings

Returns:

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

credits

Getter for the current credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.
Setter for the chart credits. Learn more about credits settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Credits settings

Returns:

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

crosshair

Getter for the current crosshair settings.

Returns:

anychart.core.ui.Crosshair - The current crosshair settings.
Setter for the crosshair settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Crosshair settings.

Returns:

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

data

Getter for the data.

Returns:

anychart.data.View - The data view.
Setter for the data.

Params:

NameTypeDescription
valueanychart.data.Set | anychart.data.DataSettings | ArrayValue to set

Returns:

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

defaultSeriesType

Getter for the current default series type.

Returns:

string | anychart.enums.CartesianSeriesType - Default series type.
Setter for the default series type.

Params:

NameTypeDescription
valuestring | anychart.enums.CartesianSeriesTypeDefault series type.

Returns:

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

draw

Starts the rendering of the chart into the container.

Params:

NameTypeDescription
asyncbooleanWhether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

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

getPixelBounds

Returns pixel bounds of the chart.
Returns pixel bounds of the chart due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the chart.

getPlotBounds

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

Returns:

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

getSelectedPoints

Getter for the selected points.

Returns:

Array.<anychart.core.Point> - An array of the selected points.

getSeries

Getter for the series by its id.

Params:

NameTypeDefaultDescription
idnumber | string
index
Id of the series.

Returns:

anychart.core.cartesian.series.Base - An instance of the created series.

getSeriesAt

Getter for the series by its index.

Params:

NameTypeDescription
indexnumberIndex of the series.

Returns:

anychart.core.cartesian.series.Base - An instance of the created series.

getSeriesCount

Returns the number of series in a chart.

Returns:

number - Number of series.

getStat

Getter for a statistical value by the key.

Params:

NameTypeDescription
keystring | anychart.enums.StatisticsKey.

Returns:

* - Statistics value.

getType

Returns chart type.

Returns:

string - Current chart type.

getXAxesCount

Returns the number of X-axes.

Returns:

number - Number of X-axes.

getXScales

Returns chart X scales.

Returns:

Array - An array of all X scales (including axes, grids, and axis markers scales).

getYAxesCount

Returns the number of Y-axes.

Returns:

number - Number of Y-axes.

getYScales

Returns chart Y scales.

Returns:

Array - An array of all Y scales (including axes, grids, and axis markers scales).

globalToLocal

Converts the global coordinates to local coordinates. Note: Works only after anychart.core.Chart#draw is called.

Params:

NameTypeDescription
xCoordnumberGlobal X coordinate.
yCoordnumberGlobal Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

grid

Getter for the current chart grid.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart grid index. If don't set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.grids.Linear - Grid instance by index.
Setter for the chart grid.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Chart grid settings to set.

Returns:

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

Params:

NameTypeDefaultDescription
indexnumber
0
Chart grid index.
valueObject | boolean | null
false
Chart grid settings to set.

Returns:

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

hatchFillPalette

Getter for the current hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Current chart hatch fill palette.
Setter for hatch fill palette settings.

Params:

NameTypeDescription
valueArray.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFillsChart hatch fill palette settings to set.

Returns:

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

height

Getter for the current chart's height setting.

Returns:

number | string | undefined - Current chart's height setting.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.height();
Setter for the chart's height setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Height setting for the chart.

Returns:

anychart.charts.Cartesian - Returns self for method chaining.

hilo

Adds HiLo series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Hilo - An instance of the created series.

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

inMarquee

Gets marquee process running value.

Returns:

boolean - Returns true if there is a marquee process running.

interactivity

Getter for the current interactivity settings.

Returns:

anychart.core.utils.Interactivity - The current interactivity settings.
Setter for the interactivity settings.

Params:

NameTypeDescription
valueObject | anychart.enums.HoverModeSettings object or boolean value like enabled state.

Returns:

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

jumpLine

Adds Jump Line series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.JumpLine - An instance of the created series.

label

Getter for the current chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

anychart.core.ui.Label - An instance of class.
Setter for the chart label.

Params:

NameTypeDefaultDescription
valuenull | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Setter for chart label using index.

Params:

NameTypeDefaultDescription
indexstring | number
0
Label index.
valuenull | boolean | Object | string
false
Chart label settings.

Returns:

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

labels

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for series data labels.

Params:

NameTypeDescription
valueObject | boolean | nullSeries data labels settings.

Returns:

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

left

Getter for the current chart's left bound setting.

Returns:

number | string | undefined - Current chart's left bound setting.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.left();
Setter for the chart's left bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the chart.

Returns:

anychart.charts.Cartesian - Returns self for method chaining.

legend

Getter for the current chart legend.

Returns:

anychart.core.ui.Legend - An instance of the class for method chaining.
Setter for the chart legend setting.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Legend settings.

Returns:

anychart.charts.Cartesian - An instance of the class for method chaining.

line

Adds Line series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Line - An instance of the created series.

lineMarker

Getter for the current line marker.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart line marker index. If don't set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Line - Line marker instance by index.
Setter for the line marker settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Chart line marker settings to set.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Setter for the line marker settings by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart line marker index.
valueObject | boolean | null
Chart line marker settings to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

localToGlobal

Converts the local coordinates to global coordinates. Note: Works only after anychart.core.Chart#draw is called.

Params:

NameTypeDescription
xCoordnumberLocal X coordinate.
yCoordnumberLocal Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

margin

Setter for the chart margin in pixels using a single complex object.

Params:

NameTypeDefaultDescription
valueArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.charts.Cartesian - 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.margin(5, 15));
Setter for the chart margin in pixels using several simple values.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Cartesian - 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);

marker

Adds Marker series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Marker - An instance of the created series.

markerPalette

Getter for the current chart markers palette settings.

Returns:

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

Params:

NameTypeDescription
valueanychart.palettes.Markers | Object | Array.<anychart.enums.MarkerType>Chart marker palette settings to set.

Returns:

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

maxBubbleSize

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

Returns:

number | string - The current maximum size all of the bubbles.
Setter for the maximum size for all bubbles on the charts.

Params:

NameTypeDefaultDescription
valuenumber | string
"20%"
Maximum size to set.

Returns:

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

maxHeight

Getter for the current chart's maximum height.

Returns:

number | string | null - Current chart's maximum height.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.maxHeight();
Setter for the chart's maximum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

maxWidth

Getter for the current chart's maximum width.

Returns:

number | string | null - Current chart's maximum width.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.maxWidth();
Setter for the chart's maximum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minBubbleSize

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

Returns:

number | string - The current minimum size of the all bubbles.
Setter for the minimum size for all bubbles on the charts.

Params:

NameTypeDefaultDescription
valuenumber | string
"5%"
Minimum size to set.

Returns:

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

minHeight

Getter for the current chart's minimum height.

Returns:

number | string | null - Current chart's minimum height.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.minHeight();
Setter for the chart's minimum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minWidth

Getter for the current chart's minimum width.

Returns:

number | string | null - Current chart's minimum width.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.minWidth();
Setter for the chart's minimum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minorGrid

Getter for the current chart minor grid.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart minor grid index. If don't set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.grids.Linear - Minor grid instance by index.
Setter for the chart minor grid.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Chart minor grid settings to set.

Returns:

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

Params:

NameTypeDefaultDescription
indexnumber
0
Chart minor grid index.
valueObject | boolean | null
false
Chart minor grid settings to set.

Returns:

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

ohlc

Adds OHLC series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.OHLC - An instance of the created series.

padding

Setter for the chart paddings in pixels using a single value.

Params:

NameTypeDefaultDescription
valueArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
See listing.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});
Setter for the chart paddings in pixels using several numbers.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Cartesian - 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);

palette

Getter for the current series colors palette.
Setter for the current series colors palette.

Params:

NameTypeDescription
valueanychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string>Series colors palette settings to set.

Returns:

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

print

Prints chart.

Params:

NameTypeDefaultDescription
paperSizeanychart.graphics.vector.PaperSize
Paper size.
landscapeboolean
false
Flag of landscape.

rangeArea

Adds Range Area series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.RangeArea - An instance of the created series.

rangeBar

Adds Range Bar series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.RangeBar - An instance of the created series.

rangeColumn

Adds Range Column series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.RangeColumn - An instance of the created series.

rangeMarker

Getter for the current range marker.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart range marker index. If don't set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Range - Range marker instance by index.
Setter for the range marker.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Chart range marker settings to set.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Setter for the range marker by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart range marker index.
valueObject | boolean | null
Chart range marker settings to set.

Returns:

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

rangeSplineArea

Adds Range Spline Area series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.RangeSplineArea - An instance of the created series.

rangeStepArea

Adds Range Step Area series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.RangeStepArea - An instance of the created series.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

removeAllSeries

Removes all series from chart.

Returns:

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

removeSeries

Removes one of series from chart by its id.

Params:

NameTypeDescription
idnumber | stringSeries id.

Returns:

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

removeSeriesAt

Removes one of series from chart by its index.

Params:

NameTypeDescription
indexnumberSeries index.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Getter for the current chart's right bound setting.

Returns:

number | string | undefined - Current chart's right bound setting.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.right();
Setter for the chart's right bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Right bound setting for the chart.

Returns:

anychart.charts.Cartesian - Returns self for method chaining.

saveAsCsv

Saves chart data as CSV file.

Params:

NameTypeDescription
chartDataExportModestring | anychart.enums.ChartDataExportModeData export mode.
csvSettingsObject.<string, (string|boolean|undefined)>CSV settings.
filenamestringFile name to save.

saveAsJpg

Saves the current chart as JPEG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanDefine, should we force transparent to white background.

saveAsJson

Saves chart config as JSON document.

Params:

NameTypeDescription
includeThemebooleanIf the current theme properties should be included into the result.
filenamestringFile name to save.

saveAsPdf

Saves the current chart as PDF image.

Params:

NameTypeDescription
paperSizestringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.

saveAsPng

Saves the current chart as PNG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.

saveAsSvg

Saves the current chart as SVG image using paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.
Saves the stage as SVG image using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

saveAsXlsx

Saves chart data as Excel document.

Params:

NameTypeDescription
chartDataExportModestring | anychart.enums.ChartDataExportModeData export mode.
filenamestringFile name to save.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
includeThemebooleanIf the current theme properties should be included into the result.
filenamestringFile name to save.

selectLabels

Getter for series select data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for series select data labels.

Params:

NameTypeDescription
valueObject | boolean | nullSeries data labels settings.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

selectMarqueeFill

Getter for the select marquee fill.

Returns:

anychart.graphics.vector.Fill - Select marquee fill.
See listing
var selectMarqueeFill = chart.selectMarqueeFill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

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

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

selectMarqueeStroke

Getter for the select marquee stroke.

Returns:

anychart.graphics.vector.Stroke - Select marquee stroke.
See listing.
var selectMarqueeStroke = chart.selectMarqueeStroke();
Setter for the select marquee stroke. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

spline

Adds Spline series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Spline - An instance of the created series.

splineArea

Adds Spline Area series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.SplineArea - An instance of the created series.

startSelectMarquee

Starts select marquee drawing. Note: Works only after anychart.core.Chart#draw is called.

Params:

NameTypeDescription
repeatbooleanWhether to start select marquee drawing.

Returns:

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

stepArea

Adds Step Area series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.StepArea - An instance of the created series.

stepLine

Adds Step Line series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.StepLine - An instance of the created series.

stick

Adds Stick series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringData for the series.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.cartesian.series.Stick - An instance of the created series.

textMarker

Getter for the current text marker.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart text marker index. If don't set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Text - Text marker instance by index.
Setter for the text marker.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Chart text marker settings to set.

Returns:

anychart.charts.Cartesian - Self instance for method chaining.
Setter for the text marker by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart text marker index.
valueObject | boolean | null
Chart text marker settings to set.

Returns:

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

title

Getter for the current chart title.

Returns:

anychart.core.ui.Title - The current chart title.
Setter for the chart title.

Params:

NameTypeDefaultDescription
valuenull | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

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

toCsv

Returns CSV string with series data.

Params:

NameTypeDescription
chartDataExportModestring | anychart.enums.ChartDataExportModeData export mode.
csvSettingsObject.<string, (string|boolean|undefined)>CSV settings.

Returns:

string - CSV string.

toJson

Returns chart configuration as JSON object or string.

Params:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.
includeThemeboolean
false
If the current theme properties should be included into the result.

Returns:

Object | string - Chart configuration.

toSvg

Returns SVG string using paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.

Returns:

string - SVG content or empty string.
Returns SVG string using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

Returns:

string - SVG content or empty string.

toXml

Returns chart configuration as XML string or XMLNode.

Params:

NameTypeDefaultDescription
asXmlNodeboolean
false
Return XML as XMLNode.
includeThemeboolean
false
If the current theme properties should be included into the result.

Returns:

string | Node - Chart configuration.

tooltip

Getter for the current chart tooltip.

Returns:

anychart.core.ui.Tooltip - An instance of the class for method chaining.
See listing.
chart.tooltip();
Setter for the chart tooltip.

Params:

NameTypeDescription
valueObject | boolean | null

Returns:

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

top

Getter for the current chart's top bound setting.

Returns:

number | string | undefined - Current chart's top bound setting.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.top();
Setter for the chart's top bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Top bound setting for the chart.

Returns:

anychart.charts.Cartesian - Returns self for method chaining.

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

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

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

width

Getter for the current chart's width setting.

Returns:

number | string | undefined - Current chart's width setting.
See listing
var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
chart.width();
Setter for the chart's width setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Width setting for the chart.

Returns:

anychart.charts.Cartesian - Returns self for method chaining.

xAxis

Getter for the current chart X-axis.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart axis index. If don't set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axes.Linear - Axis instance by index.
Setter for the chart X-axis.

Params:

NameTypeDescription
valueObject | boolean | nullChart axis settings to set.

Returns:

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

Params:

NameTypeDefaultDescription
indexnumber
0
Chart axis index.
valueObject | boolean | null
Chart axis settings to set.

Returns:

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

xScale

Getter for the current chart X-scale.

Returns:

anychart.scales.Ordinal - Default chart scale value.
Setter for the chart X-scale.

Params:

NameTypeDescription
valueanychart.enums.ScaleTypes | anychart.scales.BaseX-scale to set.

Returns:

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

xScroller

Getter for the current scroller.

Returns:

anychart.core.ui.ChartScroller - The current scroller settings.
Setter for the scroller.

Params:

NameTypeDescription
valueObject | boolean | nullChart scroller settings.

Returns:

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

xZoom

Getter for the current zoom settings.

Returns:

anychart.core.utils.OrdinalZoom - The current zoom settings.
Setter for the zoom settings.

Params:

NameTypeDescription
valuenumber | boolean | null | ObjectValue to set. If you will pass null, true, false or number less than 1, then value will be converted in 1.

Returns:

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

yAxis

Getter for the current chart Y-axis.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart axis index. If don't set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axes.Linear - Axis instance by index.
Setter for the chart Y-axis.

Params:

NameTypeDescription
valueObject | boolean | nullChart axis settings to set.

Returns:

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

Params:

NameTypeDefaultDescription
indexnumber
0
Chart axis index.
valueObject | boolean | null
Chart axis settings to set.

Returns:

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

yScale

Getter for the current chart Y-scale.

Returns:

anychart.scales.Linear - Default chart scale value.
Setter for the chart Y-scale.

Params:

NameTypeDescription
valueanychart.enums.ScaleTypes | anychart.scales.BaseY-scale to set.

Returns:

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

zIndex

Getter for the current Z-index of the chart.

Returns:

number - The current Z-index.
See listing
var chart = anychart.line([1, 2, 3, 4], [2, 3, 4, 1], [3, 4, 1, 2], [4, 1, 2, 3]);
chart.zIndex();
Setter for the Z-index of the chart.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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