class anychart.charts.Cartesian Improve this Doc
Extends: anychart.core.SeparateChart
Cartesian chart class.
To get the chart use any of these methods:
Methods Overview
| Specific settings | |
| annotations() | Creates annotations. |
| getType() | Definition of the chart type. |
| globalToLocal() | Converts the global coordinates to local coordinates. |
| localToGlobal() | Converts the local coordinates to global coordinates. |
| Axes and Scales | |
| getXAxesCount() | Returns the number of X-axes. |
| getXScales() | Returns chart X scales. |
| getYAxesCount() | Returns the number of Y-axes. |
| getYScales() | Returns chart Y scales. |
| grid() | Grid settings. |
| lineMarker() | Line marker settings. |
| minorGrid() | Minor grid settings. |
| rangeMarker() | Range marker settings. |
| textMarker() | Text marker settings. |
| xAxis() | X-axis settings. |
| xScale() | X-scale settings. |
| yAxis() | Y-axis settings. |
| yScale() | Y-scale settings. |
| Chart Coloring | |
| animation() | Animation settings |
| background() | Background 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. |
| 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 chart. |
| saveAsCsv() | Saves chart data as CSV file. |
| saveAsJpg() | Saves the current chart as JPEG image. |
| saveAsJson() | Saves chart config as JSON document. |
| saveAsPng() | Saves the current chart as PNG image. |
| saveAsSvg() | Saves the current chart as SVG image. |
| saveAsXlsx() | Saves chart data as Excel document. |
| saveAsXml() | Saves chart config as XML document. |
| toCsv() | Returns CSV string with series data. |
| toSvg() | Returns SVG string. |
| Interactivity | |
| crosshair() | Crosshair settings. |
| interactivity() | Interactivity settings. |
| startSelectMarquee() | Starts select marquee drawing. |
| tooltip() | Tooltip settings. |
| xZoom() | Zoom settings. |
| Point Elements | |
| hoverLabels() | Labels settings. |
| labels() | Labels settings. |
| selectLabels() | 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 | |
| cancelMarquee() | Stops current marquee action if any. |
| container() | Chart container |
| data() | Getter for the data. |
| draw() | Drawing of cartesian chart. |
| inMarquee() | Gets marquee process running value. |
| saveAsPdf() | Saves the current chart as PDF image. |
Methods Description
addSeries
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:
animation
Getter for the current animation settings.
Returns:
anychart.core.utils.Animation - Returns true if the animation is enabled.Try it:
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.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | Object | false | Whether to enable animation. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.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:
annotations
Getter for the annotations.
Returns:
anychart.core.annotations.PlotController - The plot annotations.Try it:
Setter for the annotations.
Params:
| Name | Type | Description |
|---|---|---|
| annotationsList | Array | Annotations list to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chainingTry it:
area
Adds Area series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | Data for the series. |
| 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.core.cartesian.series.Area - An instance of the created series.Try it:
background
Getter for the current chart background.
Returns:
anychart.core.ui.Background - The current chart background.Try it:
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 |
|---|---|---|
| value | string | Object | null | boolean | Background settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.bar
Adds Bar series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Bar - An instance of the created series.Try it:
barGroupsPadding
Getter for the current space between bar groups on the ordinal scale by ratio of bars width.
Returns:
number - Current bar groups padding.Try it:
Setter for the space between bar groups on the ordinal scale by ratio of bars width.
See illustration at anychart.charts.Cartesian#barsPadding.
See illustration at anychart.charts.Cartesian#barsPadding.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0.8 | Value to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
barsPadding
Getter for the space between bars on the ordinal scale by ratio of bars width.
Returns:
number - Current bars padding.Try it:
Setter for the space between bars on the ordinal scale by ratio of bars width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0.4 | Value to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
bottom
Getter for the current chart's bottom bound setting.
Returns:
number | string | undefined - Current chart's bottom bound setting. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.bottom();
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 - Returns self for method chaining.Try it:
bounds
Getter for the current chart bounds settings.
Returns:
anychart.core.utils.Bounds - Current bounds of the element. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.bounds();
Setter for the chart bounds using one parameter.
Params:
| Name | Type | Description |
|---|---|---|
| value | 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:
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:
box
Adds Box series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Box - An instance of the created series.Try it:
bubble
Adds Bubble series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Bubble - An instance of the created series.Try it:
cancelMarquee
Stops current marquee action if any.
Returns:
anychart.charts.Cartesian - Self instance for method chaining.candlestick
Adds Candlestick series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Candlestick - An instance of the created series.Try it:
column
Adds Column series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Column - An instance of the created series.Try it:
container
Getter for the chart container.
Setter for the chart container.
Params:
| Name | Type | Description |
|---|---|---|
| value | 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:
contextMenu
Getter for the current context menu.
Returns:
anychart.ui.ContextMenu - The current context menu.Try it:
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.charts.Cartesian - Self instance for method chaining.credits
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:
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.charts.Cartesian - Self instance for method chaining.crosshair
Getter for the current crosshair settings.
Returns:
anychart.core.ui.Crosshair - The current crosshair settings.Try it:
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 |
|---|---|---|---|
| value | Object | boolean | null | false | Crosshair settings. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.data
Setter for the data.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.data.Set | anychart.data.DataSettings | Array | Value to set |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.defaultSeriesType
Getter for the current default series type.
Returns:
string | anychart.enums.CartesianSeriesType - Default series type.Try it:
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 |
|---|---|---|
| value | string | anychart.enums.CartesianSeriesType | Default series type. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
draw
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:
getPixelBounds
Returns pixel bounds of the chart.
Returns pixel bounds of the chart due to parent bounds and self bounds settings.
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:
getPlotBounds
Getter for the current data bounds of the chart.
Note: Works only after anychart.charts.Cartesian#draw is called.
Note: Works only after anychart.charts.Cartesian#draw is called.
Returns:
anychart.math.Rect - The current data bounds of the chart.Try it:
getSelectedPoints
Getter for the selected points.
Returns:
Array.<anychart.core.Point> - An array of the selected points.Try it:
getSeries
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:
getSeriesAt
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:
getSeriesCount
getStat
Getter for a statistical value by the key.
Params:
| Name | Type | Description |
|---|---|---|
| key | string | anychart.enums.Statistics | Key. |
Returns:
* - Statistics value.Try it:
getType
getXAxesCount
Returns the number of X-axes.
Returns:
number - Number of X-axes.getXScales
Returns chart X scales.
Returns:
Array - An array of all X scales (including axes, grids, and axis markers scales).getYAxesCount
Returns the number of Y-axes.
Returns:
number - Number of Y-axes.getYScales
Returns chart Y scales.
Returns:
Array - An array of all Y scales (including axes, grids, and axis markers scales).Try it:
globalToLocal
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).
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:
grid
Getter for the current chart grid.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart grid index. If don't set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.grids.Linear - Grid instance by index.Try it:
Setter for the chart grid.
Detailed description
Sets chart grid settings depending on parameter type:
- null/boolean - disable or enable chart grid.
- object - sets chart grid settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | false | Chart grid settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Setter for chart grid by index.
Detailed description
Sets chart grid settings by index depending on parameter type:
- null/boolean - disable or enable chart grid by index.
- object - sets chart grid settings by index.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart grid index. |
| value | Object | boolean | null | false | Chart grid settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.hatchFillPalette
Getter for the current hatch fill palette settings.
Returns:
anychart.palettes.HatchFills - Current chart hatch fill palette.Try it:
Setter for hatch fill palette settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | 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:
height
Getter for the current chart's height setting.
Returns:
number | string | undefined - Current chart's height setting. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.height();
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 - Returns self for method chaining.Try it:
hilo
Adds HiLo series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Hilo - An instance of the created series.Try it:
hoverLabels
Getter for series data hover labels.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for series data hover labels.
Detailed description
Sets chart hover labels settings depending on parameter type:
- null/boolean - disable or enable chart hover labels.
- object - sets chart hover labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Series data labels settings. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.inMarquee
Gets marquee process running value.
Returns:
boolean - Returns true if there is a marquee process running.interactivity
Getter for the current interactivity settings.
Returns:
anychart.core.utils.Interactivity - The current interactivity settings.Try it:
Setter for the interactivity settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | anychart.enums.HoverMode | Settings object or boolean value like enabled state. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
jumpLine
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 | 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:
label
Getter for the current 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:
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 |
|---|---|---|---|
| value | null | boolean | Object | string | false | Chart label instance to add by index 0. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.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. |
| value | null | boolean | Object | string | false | Chart label settings. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.labels
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 |
|---|---|---|
| value | Object | boolean | null | Series data labels settings. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.left
Getter for the current chart's left bound setting.
Returns:
number | string | undefined - Current chart's left bound setting. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.left();
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 - Returns self for method chaining.Try it:
legend
Getter for the current chart legend.
Returns:
anychart.core.ui.Legend - An instance of the class for method chaining.Try it:
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 |
|---|---|---|---|
| value | Object | boolean | null | false | Legend settings. |
Returns:
anychart.charts.Cartesian - An instance of the class for method chaining.line
Adds Line series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Line - An instance of the created series.Try it:
lineMarker
Getter for the current line marker.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart line marker index. If don't set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axisMarkers.Line - Line marker instance by index.Try it:
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 |
|---|---|---|---|
| value | Object | boolean | null | false | Chart line marker settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.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. |
| value | Object | boolean | null | Chart line marker settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.listen
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.
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. | |
| 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
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).
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
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).
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
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:
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.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:
Setter for the chart margin in pixels using several simple values.
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.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:
marker
Adds Marker series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Marker - An instance of the created series.Try it:
markerPalette
Getter for the current chart markers palette settings.
Returns:
anychart.palettes.Markers - Current chart markers palette.Try it:
Setter for the chart markers palette settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.palettes.Markers | Object | Array.<anychart.enums.MarkerType> | Chart marker palette settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
maxBubbleSize
Getter for the current maximum size for all bubbles on the charts.
Returns:
number | string - The current maximum size all of the bubbles.Try it:
Setter for the maximum size for all bubbles on the charts.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | "20%" | Maximum size to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
maxHeight
Getter for the current chart's maximum height.
Returns:
number | string | null - Current chart's maximum height. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.maxHeight();
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:
maxWidth
Getter for the current chart's maximum width.
Returns:
number | string | null - Current chart's maximum width. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.maxWidth();
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:
minBubbleSize
Getter for the current minimum size for all bubbles on the charts.
Returns:
number | string - The current minimum size of the all bubbles.Try it:
Setter for the minimum size for all bubbles on the charts.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | "5%" | Minimum size to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
minHeight
Getter for the current chart's minimum height.
Returns:
number | string | null - Current chart's minimum height. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.minHeight();
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:
minWidth
Getter for the current chart's minimum width.
Returns:
number | string | null - Current chart's minimum width. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.minWidth();
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:
minorGrid
Getter for the current chart minor grid.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart minor grid index. If don't set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.grids.Linear - Minor grid instance by index.Try it:
Setter for the chart minor grid.
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 |
|---|---|---|---|
| value | Object | boolean | null | false | Chart minor grid settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.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. |
| value | Object | boolean | null | false | Chart minor grid settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.ohlc
Adds OHLC series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.OHLC - An instance of the created series.Try it:
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:
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.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:
Setter for the chart paddings in pixels using several numbers.
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.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:
palette
Getter for the current series colors palette.
Try it:
Setter for the current series colors palette.
Detailed description
Note: You can use predefined palettes from anychart.palettes.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> | Series colors palette settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Prints chart.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| paperSize | anychart.graphics.vector.PaperSize | Paper size. | |
| landscape | boolean | false | Flag of landscape. |
Try it:
rangeArea
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 | 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:
rangeBar
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 | 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:
rangeColumn
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 | 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:
rangeMarker
Getter for the current range marker.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart range marker index. If don't set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axisMarkers.Range - Range marker instance by index.Try it:
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 |
|---|---|---|---|
| value | Object | boolean | null | false | Chart range marker settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.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. |
| value | Object | boolean | null | Chart range marker settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.rangeSplineArea
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 | 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:
rangeStepArea
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 | 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:
removeAllListeners
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:
removeAllSeries
Removes all series from chart.
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
removeSeries
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:
removeSeriesAt
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:
right
Getter for the current chart's right bound setting.
Returns:
number | string | undefined - Current chart's right bound setting. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.right();
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 - Returns self for method chaining.Try it:
saveAsCsv
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:
saveAsJpg
Saves the current 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. |
Try it:
saveAsJson
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:
saveAsPdf
Saves the current 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. |
Try it:
saveAsPng
Saves the current chart as PNG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
Try it:
saveAsSvg
Saves the current chart as SVG image using paper size and landscape.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Paper Size. |
| landscape | boolean | Landscape. |
Try it:
Saves the stage as SVG image using width and height.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Try it:
saveAsXlsx
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:
saveAsXml
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:
selectLabels
Getter for series select data labels.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for series select data labels.
Detailed description
Sets chart select labels settings depending on parameter type:
- null/boolean - disable or enable chart select labels.
- object - sets chart hover labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Series data labels settings. |
Returns:
anychart.core.ui.LabelsFactory - Labels instance.selectMarqueeFill
Getter for the select marquee fill.
Returns:
anychart.graphics.vector.Fill - Select marquee fill. See listing
var selectMarqueeFill = chart.selectMarqueeFill();
Setter for fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
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:
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:
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:
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:
selectMarqueeStroke
Getter for the select marquee stroke.
Returns:
anychart.graphics.vector.Stroke - Select marquee stroke. See listing.
var selectMarqueeStroke = chart.selectMarqueeStroke();
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 | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
spline
Adds Spline series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Spline - An instance of the created series.Try it:
splineArea
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 | 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:
startSelectMarquee
Starts select marquee drawing.
Note: Works only after anychart.core.Chart#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:
stepArea
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 | 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:
stepLine
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 | 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:
stick
Adds Stick series.
Params:
| Name | Type | Description |
|---|---|---|
| data | anychart.data.View | anychart.data.Set | Array | string | Data for the series. |
| 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.core.cartesian.series.Stick - An instance of the created series.Try it:
textMarker
Getter for the current text marker.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart text marker index. If don't set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axisMarkers.Text - Text marker instance by index.Try it:
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 |
|---|---|---|---|
| value | Object | boolean | null | false | Chart text marker settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.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. |
| value | Object | boolean | null | Chart text marker settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.title
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.charts.Cartesian - Self instance for method chaining.toCsv
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:
toJson
Returns 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.toSvg
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:
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:
toXml
Returns 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.tooltip
Getter for the current chart tooltip.
Returns:
anychart.core.ui.Tooltip - An instance of the class for method chaining. See listing.
chart.tooltip();
Setter for the chart tooltip.
Detailed description
Sets tooltip settings depending on parameter type:
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.top
Getter for the current chart's top bound setting.
Returns:
number | string | undefined - Current chart's top bound setting. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.top();
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 - Returns self for method chaining.Try it:
unlisten
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. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
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:
width
Getter for the current chart's width setting.
Returns:
number | string | undefined - Current chart's width setting. See listing
var chart = anychart.cartesian(); chart.line([10, 4, 17, 20, 16, 35, 6, 15]); chart.width();
Setter for the chart's width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Width setting for the chart. |
Returns:
anychart.charts.Cartesian - Returns self for method chaining.Try it:
xAxis
Getter for the current chart X-axis.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart axis index. If don't set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axes.Linear - Axis instance by index.Try it:
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 |
|---|---|---|
| value | Object | boolean | null | Chart axis settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.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. |
| value | Object | boolean | null | Chart axis settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.xScale
Getter for the current chart X-scale.
Returns:
anychart.scales.Ordinal - Default chart scale value.Try it:
Setter for the chart X-scale.
Detailed description
Note: This scale will be passed to all scale dependent chart elements if they don't have their own scales.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.enums.ScaleTypes | anychart.scales.Base | X-scale to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
xScroller
Getter for the current scroller.
Returns:
anychart.core.ui.ChartScroller - The current scroller settings.Try it:
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 |
|---|---|---|
| value | Object | boolean | null | Chart scroller settings. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.xZoom
Getter for the current zoom settings.
Returns:
anychart.core.utils.OrdinalZoom - The current zoom settings.Try it:
Setter for the zoom settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | 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
Getter for the current chart Y-axis.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart axis index. If don't set - creates a new instance and adds it to the end of array. |
Returns:
anychart.core.axes.Linear - Axis instance by index.Try it:
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:
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 |
|---|---|---|
| value | Object | boolean | null | Chart axis settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.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. |
| value | Object | boolean | null | Chart axis settings to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.yScale
Getter for the current chart Y-scale.
Returns:
anychart.scales.Linear - Default chart scale value.Try it:
Setter for the chart Y-scale.
Detailed description
Note: This scale will be passed to all scale dependent chart elements if they don't have their own scales.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.enums.ScaleTypes | anychart.scales.Base | Y-scale to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it:
zIndex
Getter for the current Z-index of the chart.
Returns:
number - The current Z-index. See listing
var chart = anychart.line([1, 2, 3, 4], [2, 3, 4, 1], [3, 4, 1, 2], [4, 1, 2, 3]); chart.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 |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.charts.Cartesian - Self instance for method chaining.Try it: