class anychart.charts.Cartesian Improve this Doc

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
a11y()	Accessibility settings.
annotations()	Creates annotations.
categorizedBySeries()	Categorization settings on the X axis
getType()	Definition of the chart type.
globalToLocal()	Converts the global coordinates to local coordinates.
localToGlobal()	Converts the local coordinates to global coordinates.
maxPointWidth()	Maximum point width settings.
minPointLength()	Minimum point length settings.
pointWidth()	Point width settings.
toA11yTable()	Creates and returns the chart represented as an invisible HTML table.
toHtmlTable()	Creates and returns a chart as HTML table.
Axes and Scales
baseline()	Set the baseline by the Y-Scale value.
getXAxesCount()	Returns the number of X-axes.
getXScales()	Returns chart X scales.
getYAxesCount()	Returns the number of Y-axes.
getYScales()	Returns chart Y scales.
lineMarker()	Line marker settings.
rangeMarker()	Range marker settings.
textMarker()	Text marker settings.
xAxis()	X-axis settings.
xGrid()	Grid settings.
xMinorGrid()	Minor grid settings.
xScale()	X-scale settings.
yAxis()	Y-axis settings.
yGrid()	Grid settings.
yMinorGrid()	Minor grid settings.
yScale()	Y-scale settings.
Chart Coloring
animation()	Animation settings
background()	Background settings.
dataArea()	Data area 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.
yScroller()	Y scroller settings.
Coloring
selectRectangleMarqueeFill()	Select marquee fill settings.
selectRectangleMarqueeStroke()	Stroke settings.
Data
getSelectedPoints()	Getter for the selected points.
getStat()	Getter for a statistical value by the key.
noData()	NoData 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
exports()	Exports settings
print()	Prints chart.
saveAsCsv()	Saves chart data as a CSV file.
saveAsJpg()	Saves the chart as JPEG image.
saveAsJson()	Saves chart config as JSON document.
saveAsPng()	Saves the chart as PNG image.
saveAsSvg()	Saves the chart as SVG image.
saveAsXlsx()	Saves chart data as an Excel document.
saveAsXml()	Saves chart config as XML document.
shareWithFacebook()	Opens Facebook sharing dialog.
shareWithLinkedIn()	Opens LinkedIn sharing dialog.
shareWithPinterest()	Opens Pinterest sharing dialog.
shareWithTwitter()	Opens Twitter sharing dialog.
toCsv()	Returns CSV string with the chart data.
toSvg()	Returns SVG string.
Interactivity
crosshair()	Crosshair settings.
hovered()	Hovered state settings.
interactivity()	Interactivity settings.
normal()	Normal state settings.
selected()	Selected state settings.
startSelectRectangleMarquee()	Starts select marquee drawing.
tooltip()	Tooltip settings.
xZoom()	Zoom settings.
yZoom()	Y zoom settings.
Point Elements
labels()	Labels settings.
maxLabels()	Maximum labels settings.
minLabels()	Minimum 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
autoRedraw()	Redraw chart after changes or not.
cancelMarquee()	Stops marquee action if any.
container()	Chart container
data()	Getter for the data.
draw()	Chart drawing.
fullScreen()	Fullscreen mode.
getJpgBase64String()	Returns JPG as base64 string.
getPdfBase64String()	Returns PDF as base64 string.
getPngBase64String()	Returns PNG as base64 string.
getSvgBase64String()	Returns SVG as base64 string.
id()	Chart id.
inMarquee()	Gets marquee process running value.
isFullScreenAvailable()	Whether the fullscreen mode available in the browser or not.
isVertical()	Getter for the layout direction.
saveAsPdf()	Saves the chart as PDF image.
shareAsJpg()	Shares a chart as a JPG file and returns a link to the shared image.
shareAsPdf()	Shares a chart as a PDF file and returns a link to the shared image.
shareAsPng()	Shares a chart as a PNG file and returns a link to the shared image.
shareAsSvg()	Shares a chart as a SVG file and returns a link to the shared image.

Methods Description

a11y(settings)

Setter for the accessibility setting.

Detailed description

Params:

Name	Type	Description
settings	boolean \| Object	Whether to enable accessibility or object with settings.

Returns:

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

Try it:

addSeries

addSeries(var_args)Since version 7.8.0

Adds series to the chart.

Params:

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

Returns:

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

Try it:

Usage sample

animation

animation()

Getter for the animation settings.

Returns:

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

Try it:

Usage sample

animation(settings)

Setter for the animation settings by one value.

Detailed description

Sets animation settings depending on parameter type:

null/boolean - disable or enable animation.
object - sets animation settings.

Note: If you use anychart.graphics.vector.Stage#suspend, you will not see animation.

Params:

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

Returns:

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

Try it:

animation(enabled, duration)

Setter for the animation settings using of several parameters.

Detailed description

Note: If you use anychart.graphics.vector.Stage#suspend, you will not see animation.

Params:

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

Returns:

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

Try it:

Usage sample

annotations

annotations()Since version 7.11.0

Getter for the annotations.

Returns:

anychart.core.annotations.PlotController - The plot annotations.

Try it:

Usage sample

annotations(annotationsList)Since version 7.11.0

Setter for the annotations.

Params:

Name	Type	Description
annotationsList	Array	Annotations list to set.

Returns:

anychart.charts.Cartesian - Self instance for method chaining

Try it:

Usage sample

area

area(data, csvSettings)

Adds Area series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

autoRedraw

autoRedraw()

Getter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Returns:

boolean - AutoRedraw flag.

See listing

var autoRedraw = chart.autoRedraw();

autoRedraw(enabled)

Setter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Params:

Name	Type	Default	Description
enabled	boolean	true	Value to set.

Returns:

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

Try it:

Usage sample

background

background()

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.

Try it:

Usage sample

background(settings)

Setter for the chart background settings.

Detailed description

Sets chart background settings depending on parameter type:

null/boolean - disable or enable chart background.
object - sets chart background settings.
string - sets chart background color.

Params:

Name	Type	Description
settings	string \| Object \| null \| boolean	Background settings to set.

Returns:

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

Try it:

bar

bar(data, csvSettings)

Adds Bar series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

barGroupsPadding

barGroupsPadding()

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

Returns:

number - Bar groups padding.

Try it:

Usage sample

barGroupsPadding(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:

Name	Type	Default	Description
padding	number	0.8	Value to set.

Returns:

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

Try it:

Usage sample

barsPadding

barsPadding()

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

Returns:

number - Bars padding.

Try it:

Usage sample

barsPadding(padding)

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

Params:

Name	Type	Default	Description
padding	number	0.4	Value to set.

Returns:

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

Try it:

Usage sample

baseline

baseline()Since version 8.3.0

Getter for the chart baseline.

Returns:

number - The baseline value by the Y-Scale.

See listing

var chart = anychart.line();
var baseline = chart.baseline();

baseline(value)Since version 8.3.0

Setter for the chart baseline.
The baseline is the line relative to which the series with the negative or positive value is drawn and painted over.

Params:

Name	Type	Description
value	number	Y-Scale value for the baseline.

Returns:

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

Try it:

Usage sample

bottom

bottom()

Getter for the chart's bottom bound setting.

Returns:

number | string | undefined - Chart's bottom bound setting.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var bottom = chart.bottom();

bottom(value)

Setter for the chart's bottom bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for the chart bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var bounds = chart.bounds();

bounds(bounds)

Setter for the chart bounds using one parameter.

Params:

Name	Type	Description
bounds	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of teh chart.

Returns:

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

Try it:

Usage sample

bounds(x, y, width, height)

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

Try it:

Usage sample

box

box(data, csvSettings)

Adds Box series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

bubble

bubble(data, csvSettings)

Adds Bubble series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

cancelMarquee

cancelMarquee()

Stops marquee action if any.

Returns:

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

candlestick

candlestick(data, csvSettings)

Adds Candlestick series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

categorizedBySeries

categorizedBySeries()Since version 8.4.2

Getter for the way series are distributed on the axis with the ordinal scale.

Returns:

boolean - Categorize by series names or by point names.

See listing

var categorizedBySeries = chart.categorizedBySeries();

categorizedBySeries(enabled)Since version 8.4.2

Setter for the way series are categorized on the axis with the ordinal scale

Detailed description

The categorizedBySeries() allows distribute series on the X-axis by series names instead. The default (false) distributes by point names.
If you use categorizedBySeries(true) you should make sure series names are unique, otherwise it might lead to the unexpected behavior.
Note: works only with the ordinal scale.

Params:

Name	Type	Default	Description
enabled	boolean	false	Whether to enable distribution by series or no.

Returns:

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

Try it:

Usage sample

column

column(data, csvSettings)

Adds Column series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

container

container()

Getter for the chart container.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - Chart container.

container(element)

Setter for the chart container.

Params:

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

Returns:

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

Try it:

Usage sample

contextMenu

contextMenu()

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.

Try it:

Usage sample

contextMenu(settings)

Setter for the context menu.

Detailed description

Sets context menu settings depending on parameter type:

null/boolean - disable or enable context menu.
object - sets context menu settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Context menu settings

Returns:

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

Try it:

credits

credits()

Getter for chart credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Usage sample

credits(settings)

Setter for chart credits. Learn more about credits settings.

Detailed description

Note: You can't customize credits without your licence key. To buy licence key go to Buy page.
Sets chart credits settings depending on parameter type:

null/boolean - disable or enable chart credits.
object - sets chart credits settings.

Params:

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

Returns:

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

Try it:

crosshair

crosshair()Since version 7.6.0

Getter for the crosshair settings.

Returns:

anychart.core.ui.Crosshair - Crosshair settings.

Try it:

Usage sample

crosshair(settings)Since version 7.6.0

Setter for the crosshair settings.

Detailed description

Sets chart crosshair settings depending on parameter type:

null/boolean - disable or enable chart crosshair.
object - sets chart crosshair settings.

Params:

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

Returns:

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

Try it:

data

data()Since version 7.11.1

Getter for the data.

Returns:

anychart.data.View - The data view.

Try it:

Usage sample

data(data)Since version 7.11.1

Setter for the data.

Params:

Name	Type	Description
data	anychart.data.Set \| anychart.data.DataSettings \| Array	Data to set

Returns:

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

Try it:

dataArea

dataArea()Since version 8.3.0

Getter for the data area settings.

Returns:

anychart.core.ui.DataArea - Data area settings.

Try it:

Usage sample

dataArea(settings)Since version 8.3.0

Setter for the data area settings.
The data area is drawn along the data bounds.

Detailed description

Sets data area settings depending on parameter type:

boolean - disable or enable data area.
object - sets data area settings.

Params:

Name	Type	Description
settings	Object \| boolean	Data area settings to set.

Returns:

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

Try it:

defaultSeriesType

defaultSeriesType()Since version 7.8.0

Getter for the default series type.

Returns:

anychart.enums.CartesianSeriesType | string - Default series type.

Try it:

Usage sample

defaultSeriesType(type)Since version 7.8.0

Setter for the default series type.

Detailed description

Setting the default type using this method affects only series created using addSeries() method after the default is set. All series created prior to that do not change the type.

Params:

Name	Type	Description
type	anychart.enums.CartesianSeriesType \| string	Default series type.

Returns:

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

Try it:

Usage sample

draw

draw(async)

Starts the rendering of the chart into the container.

Params:

Name	Type	Description
async	boolean	Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

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

Try it:

Usage sample

exports

exports()

Getter for the export charts.

Returns:

anychart.core.utils.Exports - Exports settings.

See listing

var exports = chart.exports();

exports(settings)

Setter for the export charts.

Detailed description

To work with exports you need to reference the exports module from AnyChart CDN (https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for latest or https://cdn.anychart.com/releases/8.13.0/js/anychart-exports.min.js for the versioned file)

Params:

Name	Type	Description
settings	Object	Export settings.

Returns:

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

Try it:

Usage sample

fullScreen

fullScreen()

Getter for the fullscreen mode.

Returns:

boolean - Full screen state (enabled/disabled).

See listing

var fullScreen = chart.fullScreen();

fullScreen(enabled)

Setter for the fullscreen mode.

Params:

Name	Type	Default	Description
enabled	boolean	false	Enable/Disable fullscreen mode.

Returns:

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

Try it:

Usage sample

getJpgBase64String

getJpgBase64String(onSuccessOrOptions, onError, width, height, quality, forceTransparentWhite)

Returns JPG as base64 string.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
forceTransparentWhite	boolean	Force transparent to white or not.

Try it:

Usage sample

getPdfBase64String

getPdfBase64String(onSuccessOrOptions, onError, paperSizeOrWidth, landscapeOrWidth, x, y)

Returns PDF as base64 string.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
paperSizeOrWidth	number \| string	Any paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidth	number \| boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.

Try it:

Usage sample

getPixelBounds

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.

Try it:

Usage sample

getPlotBounds

getPlotBounds()Since version 7.8.0

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

Returns:

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

Try it:

Usage sample

getPngBase64String

getPngBase64String(onSuccessOrOptions, onError, width, height, quality)

Returns PNG as base64 string.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.

Try it:

Usage sample

getSelectedPoints

getSelectedPoints()

Getter for the selected points.

Returns:

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

Try it:

Usage sample

getSeries

getSeries(id)

Getter for the series by its id.

Params:

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

Returns:

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

Try it:

Usage sample

getSeriesAt

getSeriesAt(index)Since version 7.8.0

Getter for the series by its index.

Params:

Name	Type	Description
index	number	Index of the series.

Returns:

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

Try it:

Usage sample

getSeriesCount

getSeriesCount()Since version 7.8.0

Returns the number of series in a chart.

Returns:

number - Number of series.

Try it:

Usage sample

getStat

getStat(key)

Getter for a statistical value by the key.

Params:

Name	Type	Description
key	anychart.enums.Statistics \| string	Key.

Returns:

* - Statistics value.

Try it:

Usage sample

getSvgBase64String

getSvgBase64String(onSuccessOrOptions, onError, paperSizeOrWidth, landscapeOrHeight)

Returns SVG as base64 string.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
paperSizeOrWidth	string \| number	Paper Size or width.
landscapeOrHeight	boolean \| string	Landscape or height.

Try it:

Usage sample

getType

getType()

Returns chart type.

Returns:

string - Chart type.

Try it:

Usage sample

getXAxesCount

getXAxesCount()Since version 7.11.0

Returns the number of X-axes.

Returns:

number - Number of X-axes.

getXScales

getXScales()Since version 7.14.0

Returns chart X scales.

Returns:

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

getYAxesCount

getYAxesCount()Since version 7.11.0

Returns the number of Y-axes.

Returns:

number - Number of Y-axes.

getYScales

getYScales()Since version 7.14.0

Returns chart Y scales.

Returns:

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

Try it:

Usage sample

globalToLocal

globalToLocal(xCoord, yCoord)

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

Detailed description

Converts global coordinates of the global document into local coordinates of the container or stage.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).

Params:

Name	Type	Description
xCoord	number	Global X coordinate.
yCoord	number	Global Y coordinate.

Returns:

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

Try it:

Usage sample

hatchFillPalette

hatchFillPalette()

Getter for the hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Chart hatch fill palette.

Try it:

Usage sample

hatchFillPalette(settings)

Setter for hatch fill palette settings.

Params:

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

Returns:

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

Try it:

Usage sample

height

height()

Getter for the chart's height setting.

Returns:

number | string | undefined - Chart's height setting.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var height = chart.height();

height(value)

Setter for the chart's height setting.

Params:

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

Returns:

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

Try it:

Usage sample

hilo

hilo(data, csvSettings)Since version 7.14.0

Adds HiLo series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

hovered

hovered()Since version 8.0.0

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Usage sample

hovered(settings)Since version 8.0.0

Setter for hovered state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

id

id()

Getter for chart id.

Returns:

string - Return chart id.

Try it:

Usage sample

id(id)

Setter for chart id.

Params:

Name	Type	Description
id	string	Chart id.

Returns:

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

Try it:

Usage sample

inMarquee

inMarquee()

Gets marquee process running value.

Returns:

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

interactivity

interactivity()

Getter for the interactivity settings.

Returns:

anychart.core.utils.Interactivity - Interactivity settings.

Try it:

Usage sample

interactivity(settings)

Setter for the interactivity settings.

Params:

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

Returns:

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

Try it:

Usage sample

isFullScreenAvailable

isFullScreenAvailable()

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

Try it:

Usage sample

isVertical

isVertical()Since version 7.13.0

Getter for the layout direction.

Returns:

boolean - The flag of the series layout direction.

See listing

var flag = chart.isVertical();

isVertical(enabled)Since version 7.13.0

Setter for the layout direction.

Params:

Name	Type	Default	Description
enabled	boolean \| null	false	Whether to change the chart layout direction to vertical.

Returns:

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

Try it:

Usage sample

jumpLine

jumpLine(data, csvSettings)

Adds Jump Line series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

label

label(index)

Getter for the 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:

Usage sample

label(settings)

Setter for the chart label.

Detailed description

Sets chart label settings depending on parameter type:

null/boolean - disable or enable chart label.
string - sets chart label text value.
object - sets chart label settings.

Params:

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

Returns:

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

Try it:

label(index, settings)

Setter for chart label using index.

Detailed description

Sets chart label settings by index depending on parameter type:

null/boolean - disable or enable chart label.
string - sets chart label text value.
object - sets chart label settings.

Params:

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

Returns:

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

Try it:

labels

labels()Since version 7.13.1

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

labels(settings)Since version 7.13.1

Setter for series data labels.

Detailed description

Sets chart labels settings depending on parameter type:

null/boolean - disable or enable chart labels.
object - sets chart labels settings.

Params:

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

Returns:

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

Try it:

left

left()

Getter for the chart's left bound setting.

Returns:

number | string | undefined - Chart's left bound setting.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var left = chart.left();

left(value)

Setter for the chart's left bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

legend

legend()

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.

Try it:

Usage sample

legend(settings)

Setter for the chart legend setting.

Detailed description

Sets chart legend settings depending on parameter type:

null/boolean - disable or enable chart legend.
object - sets chart legend settings.

Params:

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

Returns:

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

Try it:

line

line(data, csvSettings)

Adds Line series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

lineMarker

lineMarker(index)

Getter for the 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 the array.

Returns:

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

Try it:

Usage sample

lineMarker(settings)

Setter for the line marker settings.

Detailed description

Sets chart line marker settings depending on parameter type:

null/boolean - disable or enable chart line marker.
object - sets chart line marker settings.

Params:

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

Returns:

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

Try it:

lineMarker(index, settings)

Setter for the line marker settings by index.

Detailed description

Sets chart line marker settings by index depending on parameter type:

null/boolean - disable or enable chart line marker by index.
object - sets chart line marker settings by index.

Params:

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

Returns:

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

Try it:

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note: Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method. Function that looks like: function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note: In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

Usage sample

localToGlobal

localToGlobal(xCoord, yCoord)

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

Detailed description

Converts local coordinates of the container or stage into global coordinates of the global document.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).

Params:

Name	Type	Description
xCoord	number	Local X coordinate.
yCoord	number	Local Y coordinate.

Returns:

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

Try it:

Usage sample

margin

margin()

Getter for the chart margin.

Detailed description

Also, you can use anychart.core.utils.Margin#bottom, anychart.core.utils.Margin#left, anychart.core.utils.Margin#right, anychart.core.utils.Margin#top methods to setting paddings.

Returns:

anychart.core.utils.Margin - Chart margin.

Try it:

Usage sample

margin(margin)

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

Params:

Name	Type	Default	Description
margin	Array.<(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));

Try it:

Usage sample

margin(value1, value2, value3, value4)

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

Params:

Name	Type	Description
value1	string \| number	Top or top-bottom space.
value2	string \| number	Right or right-left space.
value3	string \| number	Bottom space.
value4	string \| number	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);

Try it:

Usage sample

marker

marker(data, csvSettings)

Adds Marker series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

markerPalette

markerPalette()

Getter for the chart markers palette settings.

Returns:

anychart.palettes.Markers - Chart markers palette.

Try it:

Usage sample

markerPalette(settings)

Setter for the chart markers palette settings.

Params:

Name	Type	Description
settings	anychart.palettes.Markers \| Object \| Array.<(anychart.enums.MarkerType\|string)>	Chart marker palette settings to set.

Returns:

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

Try it:

Usage sample

maxBubbleSize

maxBubbleSize()Since version 7.5.1

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

Returns:

number | string - Maximum size all of the bubbles.

Try it:

Usage sample

maxBubbleSize(size)Since version 7.5.1

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

Params:

Name	Type	Default	Description
size	number \| string	'20%'	Maximum size to set.

Returns:

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

Try it:

Usage sample

maxHeight

maxHeight()

Getter for the chart's maximum height.

Returns:

number | string | null - Chart's maximum height.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var maxHeight = chart.maxHeight();

maxHeight(value)

Setter for the chart's maximum height.

Params:

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

Returns:

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

Try it:

Usage sample

maxLabels

maxLabels()Since version 8.2.0

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

maxLabels(settings)Since version 8.2.0

Setter for maximum labels.

Detailed description

Sets chart labels settings depending on parameter type:

null/boolean - disable or enable maximum labels.
object - sets maximum labels settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Maximum labels settings.

Returns:

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

Try it:

maxPointWidth

maxPointWidth()Since version 8.0.0

Getter for the maximum point width.

Returns:

string | number - The maximum point width pixel value.

See listing

var maxPointWidth = chart.maxPointWidth();

maxPointWidth(maxWidth)Since version 8.0.0

Setter for the maximum point width.

Params:

Name	Type	Description
maxWidth	number \| string	Point width pixel value.

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for the chart's maximum width.

Returns:

number | string | null - Chart's maximum width.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var maxWidth = chart.maxWidth();

maxWidth(value)

Setter for the chart's maximum width.

Params:

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

Returns:

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

Try it:

Usage sample

minBubbleSize

minBubbleSize()Since version 7.5.1

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

Returns:

number | string - Minimum size of the all bubbles.

Try it:

Usage sample

minBubbleSize(size)Since version 7.5.1

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

Params:

Name	Type	Default	Description
size	number \| string	'5%'	Minimum size to set.

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for the chart's minimum height.

Returns:

number | string | null - Chart's minimum height.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var minHeight = chart.minHeight();

minHeight(value)

Setter for the chart's minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

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

Returns:

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

Try it:

Usage sample

minLabels

minLabels()Since version 8.2.0

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

minLabels(settings)Since version 8.2.0

Setter for minimum labels.

Detailed description

Sets chart labels settings depending on parameter type:

null/boolean - disable or enable minimum labels.
object - sets minimum labels settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Minimum labels settings.

Returns:

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

Try it:

minPointLength

minPointLength()Since version 8.0.0

Getter for the minimum point length.

Returns:

string | number - The minimum point length pixel value.

See listing

var minPointLength = chart.minPointLength();

minPointLength(length)Since version 8.0.0

Setter for the minimum point length.

Params:

Name	Type	Description
length	number \| string	Minimum point length pixel value.

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for the chart's minimum width.

Returns:

number | string | null - Chart's minimum width.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var minWidth = chart.minWidth();

minWidth(value)

Setter for the chart's minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

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

Returns:

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

Try it:

Usage sample

noData

noData()

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.

Try it:

Usage sample

noData(settings)

Setter for noData settings.
Learn more about "No data" feature

Params:

Name	Type	Description
settings	Object	NoData settings.

Returns:

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

Try it:

Usage sample

normal

normal()Since version 8.0.0

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)Since version 8.0.0

Setter for normal state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

ohlc

ohlc(data, csvSettings)

Adds OHLC series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

padding

padding()

Getter for the chart padding.

Detailed description

Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.

Returns:

anychart.core.utils.Padding - Chart padding.

Try it:

Usage sample

padding(padding)

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

Params:

Name	Type	Default	Description
padding	Array.<(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%"}});

Try it:

Usage sample

padding(value1, value2, value3, value4)

Setter for the chart paddings in pixels using several numbers.

Params:

Name	Type	Description
value1	string \| number	Top or top-bottom space.
value2	string \| number	Right or right-left space.
value3	string \| number	Bottom space.
value4	string \| number	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);

Try it:

Usage sample

palette

palette()

Getter for the chart colors palette.

Returns:

anychart.palettes.RangeColors | anychart.palettes.DistinctColors - Colors palette.

Try it:

Usage sample

palette(settings)

Setter for the chart colors palette.

Detailed description

Note: You can use predefined palettes from anychart.palettes.

Params:

Name	Type	Description
settings	anychart.palettes.RangeColors \| anychart.palettes.DistinctColors \| Object \| Array.<string>	Chart colors palette settings to set.

Returns:

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

Try it:

pointWidth

pointWidth()Since version 8.0.0

Getter for the point width settings.

Returns:

string | number - The point width pixel value.

See listing

var pointWidth = chart.pointWidth();

pointWidth(width)Since version 8.0.0

Setter for the point width settings.

Params:

Name	Type	Description
width	number \| string	Point width pixel value.

Returns:

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

Try it:

Usage sample

print

print(paperSize, landscape)

Prints chart.

Params:

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

Try it:

Usage sample

rangeArea

rangeArea(data, csvSettings)

Adds Range Area series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

rangeBar

rangeBar(data, csvSettings)

Adds Range Bar series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

rangeColumn

rangeColumn(data, csvSettings)

Adds Range Column series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

rangeMarker

rangeMarker(index)

Getter for the 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 the array.

Returns:

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

Try it:

Usage sample

rangeMarker(settings)

Setter for the range marker.

Detailed description

Sets chart range marker settings depending on parameter type:

null/boolean - disable or enable chart range marker.
object - sets chart range marker settings.

Params:

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

Returns:

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

Try it:

rangeMarker(index, settings)

Setter for the range marker by index.

Detailed description

Sets chart range marker settings by index depending on parameter type:

null/boolean - disable or enable chart range marker by index.
object - sets chart range marker settings by index.

Params:

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

Returns:

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

Try it:

rangeSplineArea

rangeSplineArea(data, csvSettings)

Adds Range Spline Area series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

rangeStepArea

rangeStepArea(data, csvSettings)

Adds Range Step Area series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

removeAllSeries

removeAllSeries()Since version 7.8.0

Removes all series from chart.

Returns:

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

Try it:

Usage sample

removeSeries

removeSeries(id)Since version 7.8.0

Removes one of series from chart by its id.

Params:

Name	Type	Description
id	number \| string	Series id.

Returns:

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

Try it:

Usage sample

removeSeriesAt

removeSeriesAt(index)Since version 7.8.0

Removes one of series from chart by its index.

Params:

Name	Type	Description
index	number	Series index.

Returns:

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

Try it:

Usage sample

right

right()

Getter for the chart's right bound setting.

Returns:

number | string | undefined - Chart's right bound setting.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var right = chart.right();

right(value)

Setter for the chart's right bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

saveAsCsv

saveAsCsv(chartDataExportMode, csvSettings, filename)

Saves chart data as a CSV file.

Params:

Name

Type

Description

chartDataExportMode

anychart.enums.ChartDataExportMode | string

Data export mode.

csvSettings

Object.<string, (string|boolean|undefined|function(name:*, value:*))>

CSV settings object:

rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats - Values formatter
headers - Headers formatter

Formatters must be represented as one of:

A function with two arguments such as the field name and value, that returns the formatted value.
The object with the key as the field name, and the value as a format function.

filename

string

File name to save.

Try it:

saveAsJpg

saveAsJpg(width, height, quality, forceTransparentWhite, filename)

Saves the chart as JPEG image.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
forceTransparentWhite	boolean	Define, should we force transparent to white background.
filename	string	File name to save.

Try it:

Usage sample

saveAsJson

saveAsJson(filename)

Saves chart config as JSON document.

Params:

Name	Type	Description
filename	string	File name to save.

Try it:

Usage sample

saveAsPdf

saveAsPdf(paperSize, landscape, x, y, filename)

Saves the chart as PDF image.

Params:

Name	Type	Description
paperSize	string	Any paper format like 'a0', 'tabloid', 'b4', etc.
landscape	boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.
filename	string	File name to save.

Try it:

Usage sample

saveAsPng

saveAsPng(width, height, quality, filename)

Saves the chart as PNG image.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
filename	string	File name to save.

Try it:

Usage sample

saveAsSvg

saveAsSvg(paperSize, landscape, filename)

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

Params:

Name	Type	Description
paperSize	string	Paper Size.
landscape	boolean	Landscape.
filename	string	File name to save.

Try it:

Usage sample

saveAsSvg(width, height)

Saves the stage as SVG image using width and height.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.

Try it:

Usage sample

saveAsXlsx

saveAsXlsx(chartDataExportMode, filename, exportOptions)

Saves chart data as an Excel document.

Params:

Name

Type

Description

chartDataExportMode

anychart.enums.ChartDataExportMode | string

Data export mode.

filename

string

File name to save.

exportOptions

Object.<string, (function(name:*, value:*))>

Export options:

headers - Headers formatter

Formatter must be represented as one of:

A function with two arguments such as the field name and value, that returns the formatted value.
The object with the key as the field name, and the value as a format function.

Try it:

Usage sample

saveAsXml

saveAsXml(filename)

Saves chart config as XML document.

Params:

Name	Type	Description
filename	string	File name to save.

Try it:

Usage sample

selectRectangleMarqueeFill

selectRectangleMarqueeFill()

Getter for the select marquee fill.

Returns:

anychart.graphics.vector.Fill - Select marquee fill.

See listing

var selectRectangleMarqueeFill = chart.selectRectangleMarqueeFill();

selectRectangleMarqueeFill(color)

Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

Name	Type	Description
color	anychart.graphics.vector.Fill \| Array.<(anychart.graphics.vector.GradientKey\|string)>	Color as an object, an array or a string.

Returns:

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

Try it:

selectRectangleMarqueeFill(color, opacity)

Fill color with opacity. Fill as a string or an object.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

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

Returns:

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

Try it:

Usage sample

selectRectangleMarqueeFill(keys, angle, mode, opacity)

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

Try it:

Usage sample

selectRectangleMarqueeFill(keys, cx, cy, mode, opacity, fx, fy)

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

Try it:

Usage sample

selectRectangleMarqueeFill(imageSettings)

Image fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

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

Try it:

Usage sample

selectRectangleMarqueeStroke

selectRectangleMarqueeStroke()

Getter for the select marquee stroke.

Returns:

anychart.graphics.vector.Stroke - Select marquee stroke.

See listing.

var selectRectangleMarqueeStroke = chart.selectRectangleMarqueeStroke();

selectRectangleMarqueeStroke(color, thickness, dashpattern, lineJoin, lineCap)

Setter for the select marquee stroke. Learn more about stroke settings.

Params:

Name	Type	Default	Description
color	anychart.graphics.vector.Stroke \| anychart.graphics.vector.ColoredFill \| string \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

selected

selected()Since version 8.0.0

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)Since version 8.0.0

Setter for selected state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

shareAsJpg

shareAsJpg(onSuccessOrOptions, onError, asBase64, width, height, quality, forceTransparentWhite, filename)

Shares a chart as a JPG file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
forceTransparentWhite	boolean	Force transparent to white or not.
filename	string	File name to save.

Try it:

Usage sample

shareAsPdf

shareAsPdf(onSuccessOrOptions, onError, asBase64, paperSizeOrWidth, landscapeOrWidth, x, y, filename)

Shares a chart as a PDF file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
paperSizeOrWidth	number \| string	Any paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidth	number \| boolean	Define, is landscape.
x	number	Offset X.
y	number	Offset Y.
filename	string	File name to save.

Try it:

Usage sample

shareAsPng

shareAsPng(onSuccessOrOptions, onError, asBase64, width, height, quality, filename)

Shares a chart as a PNG file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
width	number	Image width.
height	number	Image height.
quality	number	Image quality in ratio 0-1.
filename	string	File name to save.

Try it:

Usage sample

shareAsSvg

shareAsSvg(onSuccessOrOptions, onError, asBase64, paperSizeOrWidth, landscapeOrHeight, filename)

Shares a chart as a SVG file and returns a link to the shared image.

Params:

Name	Type	Description
onSuccessOrOptions	function(response:string) \| Object	Function that is called when sharing is complete or object with options.
onError	function(response:string)	Function that is called if sharing fails.
asBase64	boolean	Share as base64 file.
paperSizeOrWidth	string \| number	Paper Size or width.
landscapeOrHeight	boolean \| string	Landscape or height.
filename	string	File name to save.

Try it:

Usage sample

shareWithFacebook

shareWithFacebook(captionOrOptions, link, name, description)

Opens Facebook sharing dialog.

Params:

Name	Type	Description
captionOrOptions	string \| Object	Caption for the main link or object with options.
link	string	The URL is attached to the publication.
name	string	The title for the attached link.
description	string	Description for the attached link.

Try it:

Usage sample

shareWithLinkedIn

shareWithLinkedIn(captionOrOptions, description)

Opens LinkedIn sharing dialog.

Params:

Name	Type	Description
captionOrOptions	string \| Object	Caption for publication or object with options. If not set 'AnyChart' will be used.
description	string	Description.

Try it:

Usage sample

shareWithPinterest

shareWithPinterest(linkOrOptions, description)

Opens Pinterest sharing dialog.

Params:

Name	Type	Description
linkOrOptions	string \| Object	Attached link or object with options. If not set, the image URL will be used.
description	string	Description.

Try it:

Usage sample

shareWithTwitter

shareWithTwitter()

Opens Twitter sharing dialog.

Try it:

Usage sample

spline

spline(data, csvSettings)

Adds Spline series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

splineArea

splineArea(data, csvSettings)

Adds Spline Area series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

startSelectRectangleMarquee

startSelectRectangleMarquee(repeat)

Starts select marquee drawing. Note: Works only after anychart.charts.Cartesian#draw is called.

Params:

Name	Type	Description
repeat	boolean	Whether to start select marquee drawing.

Returns:

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

Try it:

Usage sample

stepArea

stepArea(data, csvSettings)

Adds Step Area series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

stepLine

stepLine(data, csvSettings)

Adds Step Line series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

stick

stick(data, csvSettings)

Adds Stick series.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the series.
csvSettings	anychart.enums.TextParsingMode \| string \| anychart.data.TextParsingSettings	If 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.

Try it:

Usage sample

textMarker

textMarker(index)

Getter for the 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 the array.

Returns:

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

Try it:

Usage sample

textMarker(settings)

Setter for the text marker.

Detailed description

Sets chart text marker settings depending on parameter type:

null/boolean - disable or enable chart text marker.
object - sets chart text marker settings.

Params:

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

Returns:

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

Try it:

textMarker(index, settings)

Setter for the text marker by index.

Detailed description

Sets chart text marker settings by index depending on parameter type:

null/boolean - disable or enable chart text marker by index.
object - sets chart text marker settings by index.

Params:

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

Returns:

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

Try it:

title

title()

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.

Try it:

Usage sample

title(settings)

Setter for the chart title.

Detailed description

Sets chart title settings depending on parameter type:

null/boolean - disable or enable chart title.
string - sets chart title text value.
object - sets chart title settings.

Params:

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

Returns:

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

Try it:

toA11yTable

toA11yTable(title, asString)

Creates and returns the chart represented as an invisible HTML table.

Detailed description

This method generates an invisible HTML table for accessibility purposes. The table is only available for Screen Readers.

Params:

Name	Type	Description
title	string	Title to set.
asString	boolean	Defines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance with a11y style (invisible), HTML string or null if parsing chart to table fails.

Try it:

Usage sample

toCsv

toCsv(chartDataExportMode, csvSettings)

Returns CSV string with the chart data.

Params:

Name	Type	Description
chartDataExportMode	anychart.enums.ChartDataExportMode \| string	Data export mode.
csvSettings	Object.<string, (string\|boolean\|undefined\|function(name:, value:)\|Object)>	CSV settings. CSV settings object: rowsSeparator - string or undefined (default is '\n') columnsSeparator - string or undefined (default is ',') ignoreFirstRow - boolean or undefined (default is 'false') formats - 1) a function with two arguments such as the field name and value, that returns the formatted value or 2) the object with the key as the field name, and the value as a format function. (default is 'undefined').

Returns:

string - CSV string.

Try it:

toHtmlTable

toHtmlTable(title, asString)

Creates and returns a chart as HTML table.

Detailed description

This method generates an HTML table which contains chart data.

Params:

Name	Type	Description
title	string	Title to set.
asString	boolean	Defines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance, HTML string or null if parsing chart to table fails.

Try it:

Usage sample

toJson

toJson(stringify)

Returns chart configuration as JSON object or string.

Params:

Name	Type	Default	Description
stringify	boolean	false	Returns JSON as string.

Returns:

Object | string - Chart configuration.

Try it:

toSvg

toSvg(paperSize, landscape)

Returns SVG string using paper size and landscape.

Detailed description

Returns SVG string if type of content is SVG otherwise returns empty string.

Params:

Name	Type	Description
paperSize	string	Paper Size.
landscape	boolean	Landscape.

Returns:

string - SVG content or empty string.

Try it:

Usage sample

toSvg(width, height)

Returns SVG string using width and height.

Detailed description

Returns SVG string if type of content is SVG otherwise returns empty string.

Params:

Name	Type	Description
width	number	Image width.
height	number	Image height.

Returns:

string - SVG content or empty string.

Try it:

Usage sample

toXml

toXml(asXmlNode)

Returns chart configuration as XML string or XMLNode.

Params:

Name	Type	Default	Description
asXmlNode	boolean	false	Return XML as XMLNode.

Returns:

string | Node - Chart configuration.

Try it:

tooltip()

tooltip(settings)

Setter for the chart tooltip.

Detailed description

Params:

Name	Type	Default	Description
settings	Object \| boolean \| null	false	Chart tooltip settings.

Returns:

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

Try it:

top

top()

Getter for the chart's top bound setting.

Returns:

number | string | undefined - Chart's top bound setting.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var top = chart.top();

top(value)

Setter for the chart's top bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

unlisten

unlisten(type, listener, useCapture, listenerScope)

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

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function(e:Object)		Callback method.
useCapture	boolean	false	Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope	Object		Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

Usage sample

unlistenByKey

unlistenByKey(key)

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:

Usage sample

width

width()

Getter for the chart's width setting.

Returns:

number | string | undefined - Chart's width setting.

See listing

var chart = anychart.cartesian();
chart.line([10, 4, 17, 20, 16, 35, 6, 15]);
var width = chart.width();

width(value)

Setter for the chart's width setting.

Params:

Name	Type	Default	Description
value	number \| string \| null	null	Width settings for the chart.

Returns:

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

Try it:

Usage sample

xAxis

xAxis(index)

Getter for the 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 the array.

Returns:

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

Try it:

Usage sample

xAxis(settings)

Setter for the chart X-axis.

Detailed description

You can use multiple axes for a chart. Sets chart X-axis settings depending on parameter type:

null/boolean - disable or enable chart X-axis.
object - sets chart X-axis settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Chart axis settings to set.

Returns:

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

Try it:

xAxis(index, settings)

Setter for the chart X-axis by index.

Detailed description

Sets chart X-axis settings by index depending on parameter type:

null/boolean - disable or enable chart X-axis by index.
object - sets chart X-axis settings by index.

Params:

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

Returns:

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

Try it:

xGrid

xGrid(index)Since version 8.0.0

Getter for the chart grid by X-scale.

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 the array.

Returns:

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

Try it:

Usage sample

xGrid(settings)Since version 8.0.0

Setter for the chart grid by X-scale.

Detailed description

Sets chart xGrid settings depending on parameter type:

null/boolean - disable or enable chart xGrid.
object - sets chart xGrid settings.

Params:

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

Returns:

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

Try it:

xGrid(index, settings)Since version 8.0.0

Setter for chart grid by index.

Detailed description

Sets chart xGrid settings by index depending on parameter type:

null/boolean - disable or enable chart xGrid by index.
object - sets chart xGrid settings by index.

Params:

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

Returns:

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

Try it:

xMinorGrid

xMinorGrid(index)

Getter for the chart minor grid by X-scale.

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 the array.

Returns:

anychart.core.grids.Linear - Minor grid instance by index.

xMinorGrid(settings)

Setter for the chart minor grid by X-scale.

Detailed description

Sets chart minor grid settings depending on parameter type:

null/boolean - disable or enable chart minor grid.
object - sets chart minor grid settings.

Params:

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

Returns:

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

xMinorGrid(index, settings)

Setter for the chart minor grid by index.

Detailed description

Sets chart minor grid settings by index depending on parameter type:

null/boolean - disable or enable chart minor grid by index.
object - sets chart minor grid settings by index.

Params:

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

Returns:

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

xScale

xScale()

Getter for the chart X-scale.

Returns:

anychart.scales.Base - Default chart scale value.

Try it:

Usage sample

xScale(settings)

Setter for the chart X-scale.

Detailed description

Note: This scale is passed to all scale dependent chart elements if they don't have their own scales.

Params:

Name	Type	Default	Description
settings	Object \| anychart.enums.ScaleTypes \| string \| anychart.scales.Base	anychart.scales.Ordinal	X-scale to set.

Returns:

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

Try it:

Usage sample

xScroller

xScroller()Since version 7.8.0

Getter for the scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller settings.

Try it:

Usage sample

xScroller(settings)Since version 7.8.0

Setter for the scroller.

Detailed description

Sets chart scroller settings depending on parameter type:

null/boolean - disable or enable chart scroller.
object - sets chart scroller settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Chart scroller settings.

Returns:

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

Try it:

xZoom

xZoom()Since version 7.8.0

Getter for the zoom settings.

Returns:

anychart.core.utils.OrdinalZoom - Zoom settings.

Try it:

Usage sample

xZoom(settings)Since version 7.8.0

Setter for the zoom settings.

Params:

Name	Type	Description
settings	number \| boolean \| null \| Object	Value 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.

Try it:

yAxis

yAxis(index)

Getter for the 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 the array.

Returns:

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

Try it:

Usage sample

yAxis(settings)

Setter for the chart Y-axis.

Detailed description

You can use multiple axes for a chart.
Sets chart Y-axis settings depending on parameter type:

null/boolean - disable or enable chart Y-axis.
object - sets chart Y-axis settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Chart axis settings to set.

Returns:

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

Try it:

yAxis(index, settings)

Setter for the chart Y-axis by index.

Detailed description

Sets chart Y-axis settings by index depending on parameter type:

null/boolean - disable or enable chart Y-axis by index.
object - sets chart Y-axis settings by index.

Params:

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

Returns:

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

Try it:

yGrid

yGrid(index)Since version 8.0.0

Getter for the chart grid by Y-scale.

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 the array.

Returns:

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

Try it:

Usage sample

yGrid(settings)Since version 8.0.0

Setter for the chart grid by Y-scale.

Detailed description

Sets chart yGrid settings depending on parameter type:

null/boolean - disable or enable chart yGrid.
object - sets chart yGrid settings.

Params:

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

Returns:

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

Try it:

yGrid(index, settings)Since version 8.0.0

Setter for chart Y-grid by index.

Detailed description

Sets chart yGrid settings by index depending on parameter type:

null/boolean - disable or enable chart yGrid by index.
object - sets chart yGrid settings by index.

Params:

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

Returns:

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

Try it:

yMinorGrid

yMinorGrid(index)

Getter for the chart minor grid by Y-scale.

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 the array.

Returns:

anychart.core.grids.Linear - Minor grid instance by index.

Try it:

Usage sample

yMinorGrid(settings)

Setter for the chart minor grid by Y-scale.

Detailed description

Sets chart minor grid settings depending on parameter type:

null/boolean - disable or enable chart minor grid.
object - sets chart minor grid settings.

Params:

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

Returns:

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

Try it:

yMinorGrid(index, settings)

Setter for the chart minor grid by index.

Detailed description

Sets chart minor grid settings by index depending on parameter type:

null/boolean - disable or enable chart minor grid by index.
object - sets chart minor grid settings by index.

Params:

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

Returns:

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

Try it:

yScale

yScale()

Getter for the chart Y-scale.

Returns:

anychart.scales.Linear - Default chart scale value.

Try it:

Usage sample

yScale(settings)

Setter for the chart Y-scale.

Detailed description

Note: This scale is passed to all scale dependent chart elements if they don't have their own scales.

Params:

Name	Type	Default	Description
settings	Object \| anychart.enums.ScaleTypes \| string \| anychart.scales.Base	anychart.scales.Linear	Y-scale settings to set.

Returns:

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

Try it:

Usage sample

yScroller

yScroller()Since version 8.4.2

Getter for the Y scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller settings.

Try it:

Usage sample

yScroller(settings)Since version 8.4.2

Setter for the Y scroller.

Detailed description

Sets chart scroller settings depending on parameter type:

null/boolean - disable or enable Y scroller.
object - sets Y scroller settings.

Params:

Name	Type	Description
settings	Object \| boolean \| null	Chart Y scroller settings.

Returns:

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

Try it:

yZoom

yZoom()Since version 8.4.2

Getter for Y zoom settings.

Returns:

anychart.core.utils.OrdinalZoom - Zoom settings.

Try it:

Usage sample

yZoom(settings)Since version 8.4.2

Setter for Y zoom settings.

Params:

Name	Type	Description
settings	number \| boolean \| null \| Object	Zoom settings to set. If you pass null, true, false or a number less than 1, then the value is converted to 1.

Returns:

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

Try it:

zIndex

zIndex()

Getter for the Z-index of the chart.

Returns:

number - Chart Z-index.

See listing

var chart = anychart.line([1, 2, 3, 4], [2, 3, 4, 1], [3, 4, 1, 2], [4, 1, 2, 3]);
var zIndex = chart.zIndex();

zIndex(zIndex)

Setter for the Z-index of the chart.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
zIndex	number	0	Value to set.

Returns:

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

Try it:

Usage sample