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

class anychart.core.Chart Improve this Doc

Extends: anychart.core.VisualBaseWithBounds

Base class for all charts, contains the margins, the background and the title.

Methods Overview

Chart Coloring
animation()Animation settings
background()Background settings.
Chart Controls
label()Label settings.
title()Title settings.
Interactivity
tooltip()Tooltip settings.
Size and Position
margin()Margin settings.
padding()Padding settings.
XML/JSON
toJson()Return chart configuration as JSON object or string.
toXml()Return chart configuration as XML string or XMLNode.
Miscellaneous
container()Getter for the element current container.
draw()Drawing of the chart.

Methods Description

animation

Getter for the current animation setting.

Returns:

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

Params:

NameTypeDefaultDescription
valueboolean | Object
false
Whether to enable animation.

Returns:

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

Params:

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

Returns:

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

background

Getter for the current chart background.

Returns:

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

Params:

NameTypeDefaultDescription
valueObject
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

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

container

Getter for the element current container.

Returns:

anychart.graphics.vector.ILayer - The current container.
Setter for the element container.

Params:

NameTypeDescription
valueanychart.graphics.vector.ILayer | string | ElementThe value to set.

Returns:

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

draw

Starts the rendering of the chart into the container.

Returns:

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

label

Getter for chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

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

Params:

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

Returns:

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

Params:

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

Returns:

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

margin

Getter for the current chart margin.

Returns:

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

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.space(5, 15));
Setter for the chart margin in pixels using several simple values.

Params:

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

Returns:

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

padding

Getter for the current chart padding.

Returns:

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

Params:

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

Returns:

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

Params:

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

Returns:

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

title

Getter for chart title.

Returns:

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

Params:

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

Returns:

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

toJson

Return chart configuration as JSON object or string.

Params:

NameTypeDescription
stringifyobject | stringReturn as JSON as string.

Returns:

* - Chart JSON.

toXml

Return chart configuration as XML string or XMLNode.

Params:

NameTypeDescription
asXmlNodebooleanReturn XML as XMLNode.

Returns:

string | Node - Chart configuration.

tooltip

Getter for current chart tooltip.

Returns:

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

Params:

NameTypeDescription
valueObject | boolean | null

Returns:

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