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
Specific settings | |
a11y() | Accessibility setting. |
globalToLocal() | Converts the global coordinates to local coordinates. |
localToGlobal() | Converts the local coordinates to global coordinates. |
toA11yTable() | Creates and returns the chart represented as an invisible HTML table. |
toHtmlTable() | Creates and returns a chart as HTML table. |
Chart Coloring | |
animation() | Animation settings |
background() | Background settings. |
Chart Controls | |
contextMenu() | Context menu settings. |
label() | Label settings. |
title() | Title settings. |
Coloring | |
selectMarqueeFill() | Select marquee fill settings. |
selectMarqueeStroke() | Stroke settings. |
Data | |
getSelectedPoints() | Getter for the selected points. |
getStat() | Getter for a statistical value by the key. |
Events | |
listen() | Adds an event listener. |
listenOnce() | Adds a single time event listener. |
removeAllListeners() | Removes all listeners. |
unlisten() | Removes the listener. |
unlistenByKey() | Removes the listener by the key. |
Export | |
print() | Prints all elements. |
saveAsCsv() | Saves chart data as CSV file. |
saveAsJson() | Saves chart config as JSON document. |
saveAsXlsx() | Saves chart data as 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 series data. |
Interactivity | |
enabled() | Element state (enabled or disabled). |
startSelectMarquee() | Starts select marquee drawing. |
tooltip() | Tooltip settings. |
Size and Position | |
bottom() | Bottom bound setting. |
bounds() | Bounds settings. |
getPixelBounds() | Returns pixel bounds. |
height() | Height setting. |
left() | Left bound setting. |
margin() | Margin settings. |
maxHeight() | Maximum height. |
maxWidth() | Maximum width. |
minHeight() | Minimum height. |
minWidth() | Minimum width. |
padding() | Padding settings. |
right() | Right bound setting. |
top() | Top bound setting. |
width() | Width setting. |
zIndex() | Z-index of the element. |
XML/JSON | |
toJson() | Return chart configuration as JSON object or string. |
toXml() | Return chart configuration as XML string or XMLNode. |
Miscellaneous | |
cancelMarquee() | Stops current marquee action if any. |
container() | Getter for the element's container. |
draw() | Drawing of the chart. |
getJpgBase64String() | Returns JPG as base64 string. |
getPdfBase64String() | Returns PDF as base64 string. |
getPngBase64String() | Returns PNG as base64 string. |
getSvgBase64String() | Returns SVG as base64 string. |
inMarquee() | Gets marquee process running value. |
saveAsJpg() | Saves the current chart as JPEG image. |
saveAsPdf() | Saves the current chart as PDF image. |
saveAsPng() | Saves the current chart as PNG image. |
saveAsSvg() | Saves the current chart as SVG 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. |
toSvg() | Returns SVG string. |
Methods Description
a11y
Returns:
anychart.core.utils.ChartA11y - Accessibility settings object.var currentStateOfAccsessibility = chart.a11y();
Sets accessibility setting depending on parameter type:
- boolean - disable or enable accessibility.
- object - sets accessibility setting.
Params:
Name | Type | Description |
---|---|---|
value | boolean | Object | Whether to enable accessibility or object with settings. |
Returns:
anychart.core.Chart - Self instance for method chaining.animation
Returns:
anychart.core.utils.Animation - Returns true if the animation is enabled.Try it:
- null/boolean - disable or enable animation.
- object - sets animation settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | Object | false | Whether to enable animation. |
Returns:
anychart.core.Chart - Self instance for method chaining.Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Whether to enable animation. |
duration | number | 1000 | Duration in milliseconds. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
background
Returns:
anychart.core.ui.Background - The current chart background.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | {enabled: true, fill: "#fff", stroke: 'none', zIndex: 1} | Background object to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
bottom
Returns:
number | string | undefined - Current element's bottom bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Bottom bound setting for the element. |
Returns:
anychart.core.Chart - Returns self for method chaining.Try it:
bounds
Returns:
anychart.core.utils.Bounds - Current bounds of the element.Params:
Name | Type | Description |
---|---|---|
value | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
x | number | string | null | X-coordinate. |
y | number | string | null | Y-coordinate. |
width | number | string | null | Width. |
height | number | string | null | Height. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
cancelMarquee
Returns:
anychart.core.Chart - Self instance for method chaining.container
The order of adding is not defined, but usually it will be the order in which elements are drawn for the first time. If you need to specify the order use anychart.core.VisualBase#zIndex.
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.// string element.container('containerIdentifier'); // DOM-element var domElement = document.getElementById('containerIdentifier'); element.container(domElement); // Framework-element var fwElement = anychart.standalones.title(); element.container( fwElement.container() );
Try it:
contextMenu
Returns:
anychart.ui.ContextMenu - The current context menu.Try it:
- null/boolean - disable or enable context menu.
- object - sets context menu settings.
Params:
Name | Type | Description |
---|---|---|
value | Object | boolean | null | Context menu settings |
Returns:
anychart.core.Chart - Self instance for method chaining.draw
Params:
Name | Type | Description |
---|---|---|
async | boolean | Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously. |
Returns:
anychart.core.Chart - Self instance for method chaining.enabled
Returns:
boolean - The current element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | true | Value to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
getJpgBase64String
Params:
Name | Type | Description |
---|---|---|
onSuccessOrOptions | function | Object | Function that is called when sharing is complete or object with options. |
onError | function | 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:
getPdfBase64String
Params:
Name | Type | Description |
---|---|---|
onSuccessOrOptions | function | Object | Function that is called when sharing is complete or object with options. |
onError | function | 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:
getPixelBounds
Returns:
anychart.math.Rect - Pixel bounds of the element.getPngBase64String
Params:
Name | Type | Description |
---|---|---|
onSuccessOrOptions | function | Object | Function that is called when sharing is complete or object with options. |
onError | function | 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:
getSelectedPoints
Returns:
Array.<anychart.core.Point> - An array of the selected points.Try it:
getStat
Params:
Name | Type | Description |
---|---|---|
key | string | anychart.enums.Statistics | Key. |
Returns:
* - Statistics value.Try it:
getSvgBase64String
Params:
Name | Type | Description |
---|---|---|
onSuccessOrOptions | function | Object | Function that is called when sharing is complete or object with options. |
onError | function | Function that is called if sharing fails. |
paperSizeOrWidth | string | number | Paper Size or width. |
landscapeOrHeight | boolean | string | Landscape or height. |
Try it:
globalToLocal
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:
height
Returns:
number | string | undefined - Current element's height setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Height setting for the element. |
Returns:
anychart.core.Chart - Returns self for method chaining.Try it:
inMarquee
Returns:
boolean - Returns true if there is a marquee process running.label
Params:
Name | Type | Default | Description |
---|---|---|---|
index | string | number | 0 | Index of instance. |
Returns:
anychart.core.ui.Label - An instance of class.Try it:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | null | boolean | Object | string | false | Chart label instance to add by index 0. |
Returns:
anychart.core.Chart - Self instance for method chaining.- 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 | Label index. | |
value | null | boolean | Object | string | false | Chart label settings. |
Returns:
anychart.core.Chart - Self instance for method chaining.left
Returns:
number | string | undefined - Current element's left bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.Chart - Returns self for method chaining.Try it:
listen
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 | 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:
listenOnce
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 | 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:
localToGlobal
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:
margin
Returns:
anychart.core.utils.Margin - Chart margin.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.// 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:
Params:
Name | Type | Default | Description |
---|---|---|---|
value1 | string | number | 0 | Top or top-bottom space. |
value2 | string | number | 0 | Right or right-left space. |
value3 | string | number | 0 | Bottom space. |
value4 | string | number | 0 | Left space. |
Returns:
anychart.core.Chart - Self instance for method chaining.// 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:
maxHeight
Returns:
number | string | null - Current element's maximum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
maxWidth
Returns:
number | string | null - Current element's maximum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
minHeight
Returns:
number | string | null - Current element's minimum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
minWidth
Returns:
number | string | null - Current element's minimum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
padding
Returns:
anychart.core.utils.Padding - Chart padding.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.chart.padding([5, 15]); or chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});
Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value1 | string | number | 0 | Top or top-bottom space. |
value2 | string | number | 0 | Right or right-left space. |
value3 | string | number | 0 | Bottom space. |
value4 | string | number | 0 | Left space. |
Returns:
anychart.core.Chart - Self instance for method chaining.// 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:
Params:
Name | Type | Default | Description |
---|---|---|---|
paperSizeOrOptions | anychart.graphics.vector.PaperSize | Object | Paper size or object with options. | |
landscape | boolean | false | Flag of landscape. |
Try it:
removeAllListeners
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:
right
Returns:
number | string | undefined - Current element's right bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.Chart - Returns self for method chaining.Try it:
saveAsCsv
Params:
Name | Type | Description |
---|---|---|
chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
csvSettings | Object.<string, (string|boolean|undefined)> | CSV settings. |
filename | string | File name to save. |
Try it:
saveAsJpg
Params:
Name | Type | Description |
---|---|---|
width | number | Object | Image width or object with options. |
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:
saveAsJson
Params:
Name | Type | Description |
---|---|---|
includeTheme | boolean | If the current theme properties should be included into the result. |
filename | string | File name to save. |
Try it:
saveAsPdf
Params:
Name | Type | Description |
---|---|---|
paperSizeOrWidthOrOptions | number | string | Object | Any paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options. |
landscape | boolean | Define, is landscape. |
x | number | Offset X. |
y | number | Offset Y. |
filename | string | File name to save. |
Try it:
saveAsPng
Params:
Name | Type | Description |
---|---|---|
width | number | Object | Image width or object with options. |
height | number | Image height. |
quality | number | Image quality in ratio 0-1. |
filename | string | File name to save. |
Try it:
saveAsSvg
Params:
Name | Type | Description |
---|---|---|
paperSize | string | Object | Paper Size or object with options. |
landscape | boolean | Landscape. |
filename | string | File name to save. |
Try it:
Params:
Name | Type | Description |
---|---|---|
width | number | Image width. |
height | number | Image height. |
Try it:
saveAsXlsx
Params:
Name | Type | Description |
---|---|---|
chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
filename | string | File name to save. |
Try it:
saveAsXml
Params:
Name | Type | Description |
---|---|---|
includeTheme | boolean | If the current theme properties should be included into the result. |
filename | string | File name to save. |
Try it:
selectMarqueeFill
Returns:
anychart.graphics.vector.Fill - Select marquee fill.var selectMarqueeFill = chart.selectMarqueeFill();
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
color | string | Color as a string. |
opacity | number | Color opacity. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
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.core.Chart - Self instance for method chaining.Try it:
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.core.Chart - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
selectMarqueeStroke
Returns:
anychart.graphics.vector.Stroke - Select marquee stroke.var selectMarqueeStroke = chart.selectMarqueeStroke();
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 | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
shareAsJpg
shareAsPdf
shareAsPng
shareAsSvg
shareWithFacebook
shareWithLinkedIn
shareWithPinterest
shareWithTwitter
startSelectMarquee
Params:
Name | Type | Description |
---|---|---|
repeat | boolean | Whether to start select marquee drawing. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it:
title
- null/boolean - disable or enable chart title.
- string - sets chart title text value.
- object - sets chart title settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | null | boolean | Object | string | false | Chart title text or title instance for copy settings from. |
Returns:
anychart.core.Chart - Self instance for method chaining.toA11yTable
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:
toCsv
Params:
Name | Type | Description |
---|---|---|
chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
csvSettings | Object.<string, (string|boolean|undefined)> | CSV settings. |
Returns:
string - CSV string.Try it:
toHtmlTable
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:
toJson
Params:
Name | Type | Default | Description |
---|---|---|---|
stringify | boolean | false | Returns JSON as string. |
includeTheme | boolean | false | If the current theme properties should be included into the result. |
Returns:
Object | string - Chart configuration.toSvg
Params:
Name | Type | Description |
---|---|---|
paperSize | string | Object | Paper Size or object of options. |
landscape | boolean | Landscape. |
Returns:
string - SVG content or empty string.Try it:
Params:
Name | Type | Description |
---|---|---|
width | number | Image width. |
height | number | Image height. |
Returns:
string - SVG content or empty string.Try it:
toXml
Params:
Name | Type | Default | Description |
---|---|---|---|
asXmlNode | boolean | false | Return XML as XMLNode. |
includeTheme | boolean | false | If the current theme properties should be included into the result. |
Returns:
string | Node - Chart configuration.tooltip
Returns:
anychart.core.ui.Tooltip - An instance of the class for method chaining.var tooltipSettings = chart.tooltip();
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
Name | Type | Description |
---|---|---|
value | Object | boolean | null |
Returns:
anychart.core.Chart - Self instance for method chaining.top
Returns:
number | string | undefined - Current element's top bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.Chart - Returns self for method chaining.Try it:
unlisten
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | 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:
unlistenByKey
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
width
Returns:
number | string | undefined - Current element's width setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Width setting for the element. |
Returns:
anychart.core.Chart - Returns self for method chaining.Try it:
zIndex
Returns:
number - The current zIndex.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 0 | Value to set. |
Returns:
anychart.core.Chart - Self instance for method chaining.Try it: