class anychart.core.ChartWithCredits Improve this Doc

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

Methods Overview

Specific settings
globalToLocal()	Converts the global coordinates to local coordinates.
localToGlobal()	Converts the local coordinates to global coordinates.
Chart Coloring
animation()	Animation settings
background()	Background settings.
Chart Controls
contextMenu()	Context menu settings.
credits()	Credits settings
label()	Label settings.
title()	Title 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.
toCsv()	Returns CSV string with series data.
Interactivity
enabled()	Element state (enabled or disabled).
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
container()	Getter for the element's container.
draw()	Drawing of the chart.
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.
toSvg()	Returns SVG string.

Methods Description

animation

animation()

Getter for the current animation setting.

Returns:

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

Try it:

Usage sample

animation(value)

Setter for the animation setting 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
value	boolean \| Object	false	Whether to enable animation.

Returns:

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

Try it:

animation(enabled, duration)

Setter for the animation settings using 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.core.ChartWithCredits - Self instance for method chaining.

Try it:

Usage sample

background

background()

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current chart background.

Try it:

Usage sample

background(value)

Setter for the chart background.

Params:

Name	Type	Default	Description
value	Object	{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}	Background object to set.

Returns:

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

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound setting.

Returns:

number | string | undefined - Current element's bottom bound setting.

bottom(value)

Sets element bottom bound setting.

Params:

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

Returns:

anychart.core.ChartWithCredits - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

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

bounds(value)

Sets bounds of the element using one parameter.

Params:

Name	Type	Description
value	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

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

Try it:

Usage sample

bounds(x, y, width, height)

Setter for the element 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.core.ChartWithCredits - Self instance for method chaining.

Try it:

Usage sample

container

container()

Getter for the element's container.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - The current container.

container(value)

Setter for the element's container.

Detailed description

Each element appends all its content to this 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.ChartWithCredits - 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.standalones.title();
 element.container( fwElement.container() );

Try it:

Usage sample

contextMenu

contextMenu()Since version 7.10.0

Getter for the current context menu.

Returns:

anychart.ui.ContextMenu - The current context menu.

Try it:

Usage sample

contextMenu(value)Since version 7.10.0

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
value	Object \| boolean \| null	Context menu settings

Returns:

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

Try it:

credits

credits()

Getter for the current credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Usage sample

credits(value)

Setter for the 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
value	Object \| boolean \| null	true	Credits settings

Returns:

anychart.core.ChartWithCredits - An instance of the class for method chaining.

Try it:

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.core.ChartWithCredits - Self instance for method chaining.

Try it:

enabled

enabled()

Getter for the current element state (enabled or disabled).

Returns:

boolean - The current element state.

Try it:

Usage sample

enabled(value)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
value	boolean	true	Value to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

Try it:

Usage sample

getPixelBounds

getPixelBounds()

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

Returns:

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

getSelectedPoints

getSelectedPoints()Since version 7.10.0

Getter for the selected points.

Returns:

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

Try it:

Usage sample

getStat

getStat(key)Since version 7.10.0

Getter for a statistical value by the key.

Params:

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

Returns:

* - Statistics value.

Try it:

Usage sample

globalToLocal

globalToLocal(xCoord, yCoord)Since version 7.9.1

Converts the global coordinates to local coordinates. Note: Works only after anychart.core.Chart#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

height

height()

Getter for element height setting.

Returns:

number | string | undefined - Current element's height setting.

height(value)

Sets element height setting.

Params:

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

Returns:

anychart.core.ChartWithCredits - Returns self for method chaining.

Try it:

Usage sample

label

label(index)

Getter for 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(value)

Setter for 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
value	null \| boolean \| Object \| string	false	Chart label instance to add by index 0.

Returns:

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

Try it:

label(index, value)

Setter for chart label.

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		Label index.
value	null \| boolean \| Object \| string	false	Chart label settings.

Returns:

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

Try it:

left

left()

Getter for element left bound setting.

Returns:

number | string | undefined - Current element's left bound setting.

left(value)

Sets element left bound setting.

Params:

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

Returns:

anychart.core.ChartWithCredits - Returns self for method chaining.

Try it:

Usage sample

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		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		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)Since version 7.9.1

Converts the local coordinates to global coordinates. Note: Works only after anychart.core.Chart#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 current 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(value)

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

Params:

Name	Type	Default	Description
value	Array.<(number\|string)> \| Object	{top: 0, right: 0, bottom: 0, left: 0}	Value to set.

Returns:

anychart.core.ChartWithCredits - 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.core.ChartWithCredits - 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

maxHeight

maxHeight()

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.

maxHeight(value)

Setter for maximum height.

Params:

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

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.

maxWidth(value)

Setter for maximum width.

Params:

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

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.

minHeight(value)

Setter for 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.core.ChartWithCredits - Self instance for method chaining.

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.

minWidth(value)

Setter for 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.core.ChartWithCredits - Self instance for method chaining.

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(value)

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

Params:

Name	Type	Default	Description
value	Array.<(number\|string)> \| Object	{top: 0, right: 0, bottom: 0, left: 0}	Value to set.

Returns:

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

Example.

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.core.ChartWithCredits - 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

print

print(paperSizeOrOptions, landscape)

Prints all elements on related stage.

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:

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

right

right()

Getter for element right bound setting.

Returns:

number | string | undefined - Current element's right bound setting.

right(value)

Sets element right bound setting.

Params:

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

Returns:

anychart.core.ChartWithCredits - Returns self for method chaining.

Try it:

Usage sample

saveAsCsv

saveAsCsv(chartDataExportMode, csvSettings, filename)Since version 7.10.0

Saves chart data as CSV file.

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:

Usage sample

saveAsJpg

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

Saves the current chart as JPEG image.

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:

Usage sample

saveAsJson

saveAsJson(includeTheme, filename)Since version 7.10.0

Saves chart config as JSON document.

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:

Usage sample

saveAsPdf

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

Saves the current chart as PDF image.

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:

Usage sample

saveAsPng

saveAsPng(width, height, quality, filename)

Saves the current chart as PNG image.

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:

Usage sample

saveAsSvg

saveAsSvg(paperSize, landscape, filename)

Saves the current chart as SVG image.

Params:

Name	Type	Description
paperSize	string \| Object	Paper Size or object with options.
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)Since version 7.10.0

Saves chart data as Excel document.

Params:

Name	Type	Description
chartDataExportMode	string \| anychart.enums.ChartDataExportMode	Data export mode.
filename	string	File name to save.

Try it:

Usage sample

saveAsXml

saveAsXml(includeTheme, filename)Since version 7.10.0

Saves chart config as XML document.

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:

Usage sample

title

title()

Getter for chart title.

Returns:

anychart.core.ui.Title - The current chart title.

Try it:

Usage sample

title(value)

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
value	null \| boolean \| Object \| string	false	Chart title text or title instance for copy settings from.

Returns:

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

Try it:

toCsv

toCsv(chartDataExportMode, csvSettings)Since version 7.10.0

Returns CSV string with series data.

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:

Usage sample

toJson

toJson(stringify, includeTheme)

Return chart configuration as JSON object or string.

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.

Try it:

toSvg

toSvg(paperSize, landscape)Since version 7.5.1

Returns SVG string with 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 \| Object	Paper Size or object of options.
landscape	boolean	Landscape.

Returns:

string - SVG content or empty string.

Try it:

Usage sample

toSvg(width, height)Since version 7.5.1

Returns SVG string with with determined the 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, includeTheme)

Return chart configuration as XML string or XMLNode.

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.

Try it:

tooltip()Since version 7.7.0

tooltip(value)Since version 7.7.0

Setter for chart tooltip.

Detailed description

Params:

Name	Type	Description
value	Object \| boolean \| null

Returns:

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

Try it:

top

top()

Getter for element top bound setting.

Returns:

number | string | undefined - Current element's top bound setting.

top(value)

Sets element top bound setting.

Params:

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

Returns:

anychart.core.ChartWithCredits - Returns self 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		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.