namespace anychart Improve this Doc

Core space for all anychart components.

Constants Overview


DEVELOP	Defines if it is developer edition.
VERSION	Current version of the framework.

Functions Overview


appendTheme()	Append theme for anychart globally.
area()	Creates and returns an Area Chart.
area3d()	Creates and returns an Area 3D Chart.
bar()	Creates and returns a Bar Chart.
bar3d()	Creates and returns a Bar 3D Chart.
barmekko()	Creates and returns a Barmekko Chart.
box()	Creates and returns a Box Chart.
bubble()	Creates and returns a Bubble Chart.
bubbleMap()	Creates and returns a Bubble Map.
bullet()	Creates and returns a Bullet Chart.
cartesian()	Creates and returns a Cartesian chart.
cartesian3d()	Creates and returns a Cartesian 3D chart.
choropleth()	Creates and returns a Choropleth Map.
column()	Creates and returns a Column Chart.
column3d()	Creates and returns an Column 3D Chart.
connector()	Creates and returns a Connector Map.
financial()	Creates and returns a Financial Chart.
fromJson()	Creates an element by JSON config.
fromJsonFile()	Creates a chart from JSON configuration.
fromXml()	Creates an element by XML config.
fromXmlFile()	Creates a chart using XML configuration.
funnel()	Creates and returns a Funnel Chart.
ganttProject()	Creates and returns a Gantt Project Chart.
ganttResource()	Creates and returns a Gantt Resource Chart.
ganttToolbar()	Constructor function for Gantt chart toolbar.
heatMap()	Creates and returns a Heat Map.
hilo()	Creates and returns a HiLo Chart
licenseKey()	Setter for AnyChart license key.
line()	Creates and returns a Line Chart.
map()	Creates and returns a Map.
marker()	Creates and returns a Marker Chart.
markerMap()	Creates and returns a Marker Map.
mekko()	Creates and returns a Mekko Chart.
mosaic()	Creates and returns a Mosaic Chart.
onDocumentLoad()	Adds callback for the document load event.
onDocumentReady()	Adds callback for the document ready event.
pareto()	Creates and returns a Pareto Chart.
pert()	Creates and returns a Pert Chart.
pie()	Creates and returns a Pie Chart.
pie3d()	Creates and returns a 3D Pie Chart.
polar()	Creates and returns a Polar Chart.
pyramid()	Creates and returns a Pyramid Chart.
quadrant()	Creates and returns a Quadrant Chart.
radar()	Creates and returns a Radar chart.
resource()	Creates and returns a Resource Chart.
scatter()	Creates and returns a Scatter Chart.
seatMap()	Creates and returns a Seat map.
sparkline()	Creates and returns a Sparkline Chart.
stock()	Creates and returns a Stock Chart.
tagCloud()	Creates and returns a Tag Cloud.
theme()	Sets the theme for or gets the current theme.
treeMap()	Creates and returns a Tree Map.
venn()	Creates and returns a Venn Chart.
vertical()	Creates and returns a Vertical Chart.
verticalArea()	Creates and returns a Vertical Area Chart.
verticalLine()	Creates and returns a Vertical Line chart.
waterfall()	Creates and returns a Waterfall chart.

Classes Overview


anychart.SignalEvent	Special event for changes in dirty states.

Constants Description

DEVELOP

Defines if it is developer edition.

Type: boolean

Try it:

Usage sample

VERSION

Current version of the framework.

Type: string

Try it:

Usage sample

Functions Description

appendTheme

appendTheme(value)Since version 7.11.1

Append theme for anychart globally.
This method applies the theme or theme settings over the existing theme.

Params:

Name	Type	Description
value	string \| Object	Object with theme settings or name of the theme.

Try it:

Usage sample

area

Creates and returns an Area Chart. Each passed parameter is considered as a set of data which is to become a base for the Area Series. To create an Area Chart with no predefined settings, see anychart#cartesian

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Area chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for area series.

Try it:

Usage sample

area3d

area3d(var_args)Since version 7.9.0

Creates and returns an Area 3D Chart. Each passed parameter is considered as a set of data which is to become a base for the Area Series.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Area chart data.

Returns:

anychart.charts.Cartesian3d - Chart with defaults for area series.

Try it:

Usage sample

bar

bar(var_args)

Creates and returns a Bar Chart. Each passed parameter is considered as a set of data which is to become a base for the Bar Series. To create an Bar Chart with no predefined settings, see anychart#cartesian

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Bar chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for bar series.

Try it:

Usage sample

bar3d

bar3d(var_args)Since version 7.9.0

Creates and returns a Bar 3D Chart. Each passed parameter is considered as a set of data which is to become a base for the Bar Series.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Bar chart data.

Returns:

anychart.charts.Cartesian3d - Chart with defaults for bar series.

Try it:

Usage sample

barmekko

barmekko(var_args)Since version 7.14.0

Creates and returns a Barmekko Chart. A linear scale is used for Y-axis by default. Also, uses stack mode set to 'value'.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Mekko chart data.

Returns:

anychart.charts.Mekko - Chart with defaults for mekko series.

Try it:

Usage sample

box

box(var_args)

Creates and returns a Box Chart. Each passed parameter is considered as a set of data which is to become a base for the Box Series. To create an Box Chart with no predefined settings, see anychart#cartesian

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Box chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for box series.

Try it:

Usage sample

bubble

bubble(var_args)

Creates and returns a Bubble Chart. Each passed parameter is considered as a set of data which is to become a base for the Bubble Series. To create a Bubble Chart with no predefined settings, see anychart#scatter

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Bubble chart data.

Returns:

anychart.charts.Scatter - Chart with defaults for bubble series.

Try it:

Usage sample

bubbleMap

bubbleMap(var_args)Since version 7.7.0

Creates and returns a Bubble Map.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Data for creating a Bubble Map.

Returns:

anychart.charts.Map - New map instance with a set of predefined settings suitable for bubble series.

Try it:

Usage sample

bullet

bullet(data)

Creates and returns a Bullet Chart.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Bullet Chart data.

Returns:

anychart.charts.Bullet - Bullet chart.

Try it:

Usage sample

cartesian

cartesian()

Creates and returns a Cartesian chart. Has no predefined settings such as axes, grids, legends settings, etc.

Detailed description

To get a chart with initial settings use:

If you need the Bar Chart mode you have to swap axes using anychart.core.axes.Linear#orientation method.

Returns:

anychart.charts.Cartesian - Empty chart.

Try it:

Usage sample

cartesian3d

cartesian3d(barChartMode)Since version 7.9.0

Creates and returns a Cartesian 3D chart. Has no predefined settings such as grids, legends, titles settings, etc.

Detailed description

To get a chart with initial settings use:

Params:

Name	Type	Description
barChartMode	boolean	If true, sets the chart to Bar Chart mode, swapping default chart elements behaviour to horizontal-oriented (setting default layout to VERTICAL, swapping axes, etc).

Returns:

anychart.charts.Cartesian3d - Empty chart.

Try it:

Usage sample

choropleth

choropleth(var_args)Since version 7.7.0

Creates and returns a Choropleth Map.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Data for creating a Choropleth Map.

Returns:

anychart.charts.Map - New map instance with a set of predefined settings suitable for choropleth series.

Try it:

Usage sample

column

column(var_args)

Creates and returns a Column Chart. Each passed parameter is considered as a set of data which is to become a base for the Column Series. To create an Column Chart with no predefined settings, see anychart#cartesian

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Column chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for column series.

Try it:

Usage sample

column3d

column3d(var_args)Since version 7.9.0

Creates and returns an Column 3D Chart. Each passed parameter is considered as a set of data which is to become a base for the Column Series.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Column chart data.

Returns:

anychart.charts.Cartesian3d - Chart with defaults for column series.

Try it:

Usage sample

connector

connector(var_args)

Creates and returns a Connector Map.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Data for creating a Connector Map.

Returns:

anychart.charts.Map - New map instance with a set of predefined settings suitable for connector series.

Try it:

Usage sample

financial

financial(var_args)

Creates and returns a Financial Chart. Each passed parameter is considered as a set of data which is to become a base for the Financial Series. To create an Financial Chart with no predefined settings, see anychart#cartesian

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Finance chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for ohlc and candlestick series.

Try it:

Usage sample

fromJson

fromJson(jsonConfig)

Creates an element by JSON config.

Params:

Name	Type	Description
jsonConfig	Object \| string	Config.

Returns:

* - Element created by config.

Try it:

Usage sample

fromJsonFile

fromJsonFile(url, onSuccessOrContainer, onError, method, content, headers, timeoutInterval, withCredentials, context)Since version 7.11.1

Creates a chart from JSON configuration.

Params:

Name	Type	Description
url	string	Link to JSON file
onSuccessOrContainer	string \| function	The function that is launched after chart is successfully loaded
onError	function	The function that is launched if chart loading fails
method	string	Send method
content	ArrayBuffer \| ArrayBufferView \| Blob \| Document \| FormData \| string	Data
headers	Object	Headers to add to the request
timeoutInterval	number	Number of milliseconds after which an incomplete request will be aborted
withCredentials	boolean	Whether to send credentials with the request
context	*	Context for handler function

Try it:

Usage sample

fromXml

fromXml(xmlConfig)

Creates an element by XML config.

Params:

Name	Type	Description
xmlConfig	string \| Node	Config.

Returns:

* - Element created by config.

Try it:

Usage sample

fromXmlFile

fromXmlFile(url, onSuccessOrContainer, onError, method, content, headers, timeoutInterval, withCredentials, context)Since version 7.11.1

Creates a chart using XML configuration.

Params:

Name	Type	Description
url	string	Link to XML file
onSuccessOrContainer	string \| function	The function that is launched after chart is successfully loaded
onError	function	The function that is launched if chart loading fails
method	string	Send method
content	ArrayBuffer \| ArrayBufferView \| Blob \| Document \| FormData \| string	Data
headers	Object	Headers to add to the request
timeoutInterval	number	Number of milliseconds after which an incomplete request will be aborted
withCredentials	boolean	Whether to send credentials with the request
context	*	Context for handler function

Try it:

Usage sample

funnel

funnel(data, csvSettings)

Creates and returns a Funnel Chart. Contains the predefined settings for the tooltip.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the chart.
csvSettings	anychart.enums.TextParsingMode \| anychart.data.TextParsingSettings	If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.charts.Funnel -

Try it:

Usage sample

ganttProject

ganttProject()

Creates and returns a Gantt Project Chart.

Returns:

anychart.charts.Gantt - Gantt Project Chart

Try it:

Usage sample

ganttResource

ganttResource()

Creates and returns a Gantt Resource Chart.

Returns:

anychart.charts.Gantt - Gantt Resource Chart

Try it:

Usage sample

ganttToolbar

ganttToolbar()

Constructor function for Gantt chart toolbar.

Returns:

anychart.ui.GanttToolbar -

heatMap

heatMap(data, csvSettings)

Creates and returns a Heat Map.
Note: Contains predefined settings for axes and grids.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the chart.
csvSettings	anychart.enums.TextParsingMode \| anychart.data.TextParsingSettings	If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.charts.HeatMap - Heat map chart.

Try it:

Usage sample

hilo

hilo(var_args)Since version 7.14.0

Creates and returns a HiLo Chart

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	HiLo chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for HiLo series.

Try it:

Usage sample

licenseKey

licenseKey(value)

Setter for AnyChart license key.
To purchase a license proceed to Buy AnyChart page.

Params:

Name	Type	Description
value	string	Your licence key.

Returns:

string - Current licence key.

Try it:

Usage sample

line

line(var_args)

Creates and returns a Line Chart. Each passed parameter is considered as a set of data which is to become a base for the Line Series. To create an Line Chart with no predefined settings, see anychart#cartesian

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Line chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for line series.

Try it:

Usage sample

map

map()

Creates and returns a Map.

Returns:

anychart.charts.Map - Map.

Try it:

Usage sample

marker

marker(var_args)

Creates and returns a Marker Chart. Each passed parameter is considered as a set of data which is to become a base for the Marker Series. To create a Marker Chart with no predefined settings, see anychart#scatter

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Marker chart data.

Returns:

anychart.charts.Scatter - Chart with defaults for marker series.

Try it:

Usage sample

markerMap

markerMap(var_args)

Creates and returns a Marker Map.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Data for creating a Marker Map.

Returns:

anychart.charts.Map - New map instance with a set of predefined settings suitable for marker series.

Try it:

Usage sample

mekko

mekko(var_args)Since version 7.14.0

Creates and returns a Mekko Chart. A linear scale is used for Y-axis by default. Points padding is set to 0.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Mekko chart data.

Returns:

anychart.charts.Mekko - Chart with defaults for mekko series.

Try it:

Usage sample

mosaic

mosaic(var_args)Since version 7.14.0

Creates and returns a Mosaic Chart. A ordinal scale is used for Y-axis by default.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Mekko chart data.

Returns:

anychart.charts.Mekko - Chart with defaults for mekko series.

Try it:

Usage sample

onDocumentLoad

onDocumentLoad(func, scope)

Adds callback for the document load event.
It is fired when the entire page loads, including its content (images, css, scripts, etc.).

Params:

Name	Type	Description
func	function	Function which will be called on document load event.
scope	*	Function call context.

onDocumentReady

onDocumentReady(func, scope)

Adds callback for the document ready event.
It is called when the DOM is ready, this can happen prior to loading images and other external content.

Params:

Name	Type	Description
func	function	Function which is called on the document load event.
scope	*	Function call context.

Try it:

Usage sample

pareto

pareto(data)Since version 7.13.0

Creates and returns a Pareto Chart.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array	Pareto chart data.

Returns:

anychart.charts.Pareto - Chart with defaults for line and column series.

Try it:

Usage sample

pert

pert()Since version 7.11.0

Creates and returns a Pert Chart.

Returns:

anychart.charts.Pert - Pert chart.

Try it:

Usage sample

pie

pie(data)

Creates and returns a Pie Chart.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the chart.

Returns:

anychart.charts.Pie - Default pie chart.

Try it:

Usage sample

pie3d

pie3d(data, csvSettings)Since version 7.5.1

Creates and returns a 3D Pie Chart.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the chart.
csvSettings	anychart.enums.TextParsingMode \| anychart.data.TextParsingSettings	If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.charts.Pie - Chart with defaults for 3D Pie.

Try it:

Usage sample

polar

polar(var_args)

Creates and returns a Polar Chart.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Marker chart data.

Returns:

anychart.charts.Polar - Chart with defaults for marker series.

Try it:

Usage sample

pyramid

pyramid(data, csvSettings)

Creates and returns a Pyramid Chart. Contains the predefined settings for the tooltip.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Data for the chart.
csvSettings	anychart.enums.TextParsingMode \| anychart.data.TextParsingSettings	If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.charts.Pyramid -

Try it:

Usage sample

quadrant

quadrant(var_args)Since version 7.14.0

Creates and returns a Quadrant Chart. Each passed parameter is considered as a set of data which is to become a base for the Marker Series. To create a Quadrant Chart with no predefined settings, see anychart#scatter

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Marker chart data.

Returns:

anychart.charts.Scatter - Chart with defaults for marker series.

Try it:

Usage sample

radar

radar(var_args)

Creates and returns a Radar chart.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Line chart data.

Returns:

anychart.charts.Radar - Chart with defaults for line series.

Try it:

Usage sample

resource

resource(data, csvSettings)Since version 7.12.0

Creates and returns a Resource Chart.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Resource chart data.
csvSettings	anychart.enums.TextParsingMode \| anychart.data.TextParsingSettings	If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.charts.Resource - New resource instance.

Try it:

Usage sample

scatter

scatter(var_args)

Creates and returns a Scatter Chart. By default creates marker series if arguments is set.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Marker chart data.

Returns:

anychart.charts.Scatter - Chart with defaults for scatter series.

Try it:

Usage sample

seatMap

seatMap(var_args)Since version 7.11.0

Creates and returns a Seat map.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Data for creating a Seat Map.

Returns:

anychart.charts.Map - New map instance with a set of predefined settings suitable for seatMap series.

Try it:

Usage sample

sparkline

sparkline(data, csvSettings)

Creates and returns a Sparkline Chart.

Params:

Name	Type	Description
data	anychart.data.View \| anychart.data.Set \| Array \| string	Value to set.
csvSettings	anychart.enums.TextParsingMode \| anychart.data.TextParsingSettings	If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.charts.Sparkline - Chart with defaults for marker series.

Try it:

Usage sample

stock

stock(allowPointSettings)Since version 7.7.0

Creates and returns a Stock Chart.

Params:

Name	Type	Description
allowPointSettings	boolean	Allows to set point settings from data.

Returns:

anychart.charts.Stock - New stock chart instance.

Try it:

Usage sample

theme

theme(value)Since version 7.6.0

Sets the theme for or gets the current theme. Learn more about themes.

Detailed description

Note: If it doesn't set the theme, you will get the current theme.

For example, to use theme name "pastel" you have to connect special theme file with the name pastel.js.
This file, as well as other files, can be found at https://cdn.anychart.com/#themes.
After referencing the file you can use theme() method with "pastel" parameter to apply pastel theme: anychart.theme("pastel");

To disable installed themes - pass null.

Sets theme settings depending on parameter type:

null - disable passed theme settings.
object - sets theme settings.
string - sets theme name.
array - sets theme name and theme settings.

Params:

Name	Type	Default	Description
value	string \| Object \| Array.<(string\|Object)> \| null	"defaultTheme"	Object with theme settings or name of the theme or array of objects/names of the themes.

Returns:

string | Object | Array.<(string|Object)> - Object with theme settings.

Try it:

treeMap

treeMap(data, fillMethod)Since version 7.10.0

Creates and returns a Tree Map.

Params:

Name	Type	Description
data	anychart.data.Tree \| anychart.data.TreeView \| Array.<Object>	Data tree or raw data.
fillMethod	anychart.enums.TreeFillingMethod	Fill method.

Returns:

anychart.charts.TreeMap - Tree map chart with defaults.

Try it:

Usage sample

venn

venn(data, csvSettings)Since version 7.14.0

Creates and returns a Venn Chart.

Params:

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

Returns:

anychart.charts.Venn - Venn chart.

Try it:

Usage sample

vertical

vertical(var_args)

Creates and returns a Vertical Chart. Each passed parameter is considered as a set of data which is to become a base for the Bar Series. To create an Vertical Chart with no predefined settings, see anychart#cartesian

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Vertical chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for bar series.

Try it:

Usage sample

verticalArea

verticalArea(var_args)Since version 7.13.0

Creates and returns a Vertical Area Chart. Each passed parameter is considered as a set of data which is to become a data set for an Area Series.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Vertical Area chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for vertical area series.

Try it:

Usage sample

verticalLine

verticalLine(var_args)Since version 7.13.0

Creates and returns a Vertical Line chart. Each passed parameter is considered as a set of data which is to become a data set for a Line Series.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Vertical Line chart data.

Returns:

anychart.charts.Cartesian - Chart with defaults for vertical line series.

Try it:

Usage sample

waterfall

waterfall(var_args)Since version 7.14.0

Creates and returns a Waterfall chart.

Params:

Name	Type	Description
var_args	anychart.data.View \| anychart.data.Set \| Array	Waterfall chart data.

Returns:

anychart.charts.Waterfall - Chart with defaults for waterfall series.

Try it:

Usage sample

namespace anychart Improve this Doc

Constants Overview

Functions Overview

Classes Overview

Constants Description

Functions Description

appendTheme

area

area3d

bar

bar3d

barmekko

box

bubble

bubbleMap

bullet

cartesian

cartesian3d

choropleth

column

column3d

connector

financial

fromJson

fromJsonFile

fromXml

fromXmlFile

funnel

ganttProject

ganttResource

ganttToolbar

heatMap

hilo

licenseKey

line

map

marker

markerMap

mekko

mosaic

onDocumentLoad

onDocumentReady

pareto

pert

pie

pie3d

polar

pyramid

quadrant

radar

resource

scatter

seatMap

sparkline

stock

tagCloud

theme

treeMap

venn

vertical

verticalArea

verticalLine

waterfall