AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.charts.Waterfall Improve this Doc

Extends: anychart.core.SeparateChart

Waterfall chart class.
To get the chart use these method:

Methods Overview

Specific settings
annotations()Creates annotations.
getType()Definition of the chart type.
globalToLocal()Converts the global coordinates to local coordinates.
labels()Labels settings.
localToGlobal()Converts the local coordinates to global coordinates.
maxPointWidth()Maximum point width settings.
minPointLength()Minimum point length settings.
pointWidth()Point width settings.
Axes and Scales
baseline()Set the baseline by the Y-Scale value.
getXAxesCount()Returns the number of X-axes.
getXScales()Returns chart X scales.
getYAxesCount()Returns the number of Y-axes.
getYScales()Returns chart Y scales.
lineMarker()Line marker settings.
rangeMarker()Range marker settings.
textMarker()Text marker settings.
xAxis()X-axis settings.
xGrid()Grid settings by X-scale.
xMinorGrid()Minor grid settings by X-scale.
xScale()X-scale settings.
yAxis()Y-axis settings.
yGrid()Grid settings by Y-scale.
yMinorGrid()Minor grid settings by Y-scale.
yScale()Y-scale settings.
Chart Coloring
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
connectorStroke()Stroke settings.
Data
data()Data settings.
dataMode()Data mode settings.
getStat()Getter for a statistical value by the key.
noData()NoData settings.
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
exports()Exports settings
print()Prints all elements.
saveAsCsv()Saves chart data as a CSV file.
saveAsJson()Saves chart config as JSON document.
saveAsXlsx()Saves chart data as an Excel document.
saveAsXml()Saves chart config as XML document.
toCsv()Returns CSV string with the chart data.
Interactivity
crosshair()Crosshair settings.
interactivity()Interactivity settings.
tooltip()Tooltip settings.
xZoom()Zoom settings.
Point Elements
maxLabels()Maximum labels settings.
minLabels()Minimum labels settings.
Series
waterfall()Adds Waterfall series.
Size and Position
bottom()Bottom bound settings.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds.
getPlotBounds()Returns data bounds of the chart.
height()Height settings.
left()Left bound settings.
margin()Margin settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings.
right()Right bound settings.
top()Top bound settings.
width()Width settings.
zIndex()Z-index of the element.
Specific Series Settings
addSeries()Adds series to the chart.
getSeries()Returns series by id.
getSeriesAt()Returns series by index.
getSeriesCount()Returns the number of series in a chart.
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()Return chart configuration as JSON object or string.
toXml()Return chart configuration as XML string or XMLNode.
Miscellaneous
autoRedraw()Redraw chart after changes or not.
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

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:

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

Try it:

autoRedraw

Getter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Returns:

boolean - AutoRedraw flag.
See listing
var autoRedraw = chart.autoRedraw();
Setter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Params:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.

Try it:

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.charts.Waterfall - Self instance for method chaining.

Try it:

baseline

Getter for the chart baseline.

Returns:

number - The baseline value by the Y-Scale.
See listing
var chart = anychart.pareto();
var baseline = chart.baseline();
Setter for the chart baseline.
The baseline is the line relative to which the series with the negative or positive value is drawn and painted over.

Params:

Name Type Description
value number Y-Scale value for the baseline.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

bottom

Getter for element bottom bound settings.

Returns:

number string undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

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

Returns:

anychart.charts.Waterfall - Returns self for method chaining.

Try it:

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for 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.charts.Waterfall - Self instance for method chaining.

Try it:

Setter for 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.charts.Waterfall - Self instance for method chaining.

Try it:

connectorStroke

Getter for the connector stroke.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
See listing
var connectorStroke = chart.connectorStroke();
Setter for the connector stroke.

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 joint style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

container

Getter for the element's container.
Setter for the element's container.

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.charts.Waterfall - 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:

contextMenu

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.

Try it:

Setter for the context menu.

Params:

Name Type Description
value Object | boolean | null Context menu settings

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

credits

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Setter for the chart credits. Learn more about credits settings.

Params:

Name Type Default Description
value Object | boolean | null
true
Credits settings

Returns:

anychart.charts.Waterfall - An instance of the class for method chaining.

crosshair

Getter for crosshair settings.

Returns:

anychart.core.ui.Crosshair - Crosshair settings.

Try it:

Setter for crosshair settings.

Params:

Name Type Default Description
value Object | boolean | null
false
Crosshair settings.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

data

Getter for the data.

Returns:

anychart.data.View - The data view.
See listing
var data = chart.data();
Setter for the data.

Params:

Name Type Description
value anychart.data.Set | anychart.data.DataSettings | Array Value to set

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

dataMode

Getter for the data mode.

Returns:

anychart.enums.WaterfallDataMode string - Data mode.
See listing
var dataMode = chart.dataMode();
Setter for the data mode.

Params:

Name Type Default Description
value anychart.enums.WaterfallDataMode | string
"diff"
Data mode.

Returns:

anychart.charts.Waterfall - 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.Waterfall - Self instance for method chaining.

exports

Getter for the export charts.

Returns:

anychart.core.utils.Exports - Exports settings.
See listing
var exports = chart.exports();
Setter for the export charts.

Params:

Name Type Description
value Object Export settings.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

getPixelBounds

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

Returns:

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

getPlotBounds

Getter for the data bounds of the chart.
Note: Works only after anychart.charts.Waterfall#draw is called.

Returns:

anychart.math.Rect - Data bounds of the chart.

Try it:

getSeries

Gets the series by its id.

Params:

Name Type Default Description
id number | string
index
Id of the series.

Returns:

anychart.core.waterfall.series.Waterfall - 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

Returns the number of series in a chart.

Returns:

number - Number of series.

Try it:

getStat

Getter for a statistical value by the key.

Params:

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

Returns:

* - Statistics value.

Try it:

getType

Returns chart type.

Returns:

string - Chart type.

Try it:

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).

globalToLocal

Converts the global coordinates to local coordinates. Note: Works only after anychart.core.Chart#draw is called.

Params:

Name Type Description
xCoord number Global X coordinate.
yCoord number Global Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

Try it:

hatchFillPalette

Getter for the hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Chart hatch fill palette.
See listing
var hatchFillPalette = chart.hatchFillPalette();
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.Waterfall - Self instance for method chaining.

Try it:

height

Getter for element height settings.

Returns:

number string undefined - Element's height setting.
Setter for element height setting.

Params:

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

Returns:

anychart.charts.Waterfall - Returns self for method chaining.

Try it:

interactivity

Getter for interactivity settings for the chart.

Returns:

anychart.core.utils.Interactivity - Interactivity settings.
Setter for interactivity settings for the chart.

Params:

Name Type Description
value Object | anychart.enums.HoverMode | string Settings object or boolean value like enabled state.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

label

Getter for the chart label.

Params:

Name Type Default Description
index string | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.

Try it:

Setter for the chart label.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for the chart label.

Params:

Name Type Default Description
index string | number
Label index.
value null | boolean | Object | string
false
Chart label settings.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

labels

Getter for chart labels.

Returns:

anychart.core.ui.LabelsFactory - Axis labels instance.

Try it:

Setter for chart labels.

Params:

Name Type Default Description
value Object | boolean | null
true
Axis labels.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

left

Getter for element left bound settings.

Returns:

number string undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

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

Returns:

anychart.charts.Waterfall - Returns self for method chaining.

Try it:

legend

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.

Try it:

Setter for chart legend settings.

Params:

Name Type Default Description
value Object | boolean | null
false
Legend settings.

Returns:

anychart.charts.Waterfall - An instance of the class for method chaining.

lineMarker

Getter for the line marker.

Params:

Name Type Default Description
index number
0
Chart line marker index. If not set - creates a new instance and adds it to the end of the array.

Returns:

anychart.core.axisMarkers.Line - Line marker instance by index.

Try it:

Setter for the line marker settings.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart line marker settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for the 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.Waterfall - Self instance for method chaining.

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(e:Object)
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

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(e:Object)
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.

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

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.Waterfall - 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.Waterfall - 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:

markerPalette

Getter for the chart markers palette settings.

Returns:

anychart.palettes.Markers - Chart markers palette.
See listing
var markerPalette = chart.markerPalette();
Setter for the chart markers palette settings.

Params:

Name Type Description
value anychart.palettes.Markers | Object | Array.<(anychart.enums.MarkerType|string)> Chart marker palette settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

maxHeight

Getter for the maximum height.

Returns:

number string null - Element's maximum height.
Setter for the maximum height.

Params:

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

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

maxLabels

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for maximum labels.

Params:

Name Type Description
settings Object | boolean | null Maximum labels settings.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

maxPointWidth

Getter for the maximum point width.

Returns:

string number - The maximum point width pixel value.
See listing
var maxPointWidth = chart.maxPointWidth();
Setter for the maximum point width.

Params:

Name Type Description
value number | string Point width pixel value.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

maxWidth

Getter for the maximum width.

Returns:

number string null - Element's maximum width.
Setter for the maximum width.

Params:

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

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

minHeight

Getter for the minimum height.

Returns:

number string null - Element's minimum height.
Setter for the minimum height.

Params:

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

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

minLabels

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for minimum labels.

Params:

Name Type Description
settings Object | boolean | null Minimum labels settings.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

minPointLength

Getter for the minimum point length.

Returns:

string number - The minimum point length pixel value.
See listing
var minPointLength = chart.minPointLength();
Setter for the minimum point length.

Params:

Name Type Description
value number | string Minimum point length pixel value.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

minWidth

Getter for the minimum width.

Returns:

number string null - Element's minimum width.
Setter for the minimum width.

Params:

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

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.

Try it:

Setter for noData settings.
Learn more about "No data" feature

Params:

Name Type Description
value Object NoData settings.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

padding

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.Waterfall - Self instance for method chaining.
Example.
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.Waterfall - 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 series colors palette.
See listing
var palette = chart.palette();
Setter for the current series colors palette.

Params:

Name Type Description
value anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> Series colors palette settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

pointWidth

Getter for the point width settings.

Returns:

string number - The point width pixel value.
See listing
var pointWidth = chart.pointWidth();
Setter for the point width settings.

Params:

Name Type Description
value number | string Point width pixel value.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

print

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:

rangeMarker

Getter for the current range marker.

Params:

Name Type Default Description
index number
0
Chart range marker index. If not set - creates a new instance and adds it to the end of the array.

Returns:

anychart.core.axisMarkers.Range - Range marker instance by index.

Try it:

Setter for the range marker.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart range marker settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for the range marker 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.Waterfall - Self instance for method chaining.

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

Try it:

Getter for element right bound settings.

Returns:

number string undefined - Element's right bound setting.
Setter for element right bound setting.

Params:

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

Returns:

anychart.charts.Waterfall - Returns self for method chaining.

Try it:

saveAsCsv

Saves chart data as a CSV file.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
csvSettings Object.<string, (string|boolean|undefined|function(name:*, value:*))> CSV settings.
CSV settings object:
rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').
filename string File name to save.

saveAsJpg

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:

saveAsJson

Saves chart config as JSON document.

Params:

Name Type Description
filename string File name to save.

Try it:

saveAsPdf

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:

saveAsPng

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:

saveAsSvg

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:

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 an Excel document.

Params:

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

Try it:

saveAsXml

Saves chart config as XML document.

Params:

Name Type Description
filename string File name to save.

Try it:

textMarker

Getter for the text marker.

Params:

Name Type Default Description
index number
0
Chart text marker index. If not set - creates a new instance and adds it to the end of the array.

Returns:

anychart.core.axisMarkers.Text - Text marker instance by index.

Try it:

Setter for the text marker.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart text marker settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for the text marker 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.Waterfall - Self instance for method chaining.

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.

Try it:

Setter for the chart title.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

toCsv

Returns CSV string with the chart data.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
csvSettings Object.<string, (string|boolean|undefined|function(name:*, value:*)|Object)> CSV settings.
CSV settings object:
rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').

Returns:

string - CSV string.

toJson

Return chart configuration as JSON object or string.

Params:

Name Type Default Description
stringify boolean
false
Returns JSON as string.

Returns:

Object string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

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:

Returns SVG string with with determined the width and height.

Params:

Name Type Description
width number Image width.
height number Image height.

Returns:

string - SVG content or empty string.

Try it:

toXml

Return chart configuration as XML string or XMLNode.

Params:

Name Type Default Description
asXmlNode boolean
false
Return XML as XMLNode.

Returns:

string Node - Chart configuration.

tooltip

Getter for the chart tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Example
var tooltipSettings = chart.tooltip();
Setter for the chart tooltip.

Params:

Name Type Description
tooltipSettings Object | boolean | null Tooltip settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

top

Getter for element top bound settings.

Returns:

number string undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

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

Returns:

anychart.charts.Waterfall - 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:

waterfall

Adds Waterfall series.

Params:

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

Returns:

anychart.core.waterfall.series.Waterfall - An instance of the created series.

Try it:

width

Getter for element width settings.

Returns:

number string undefined - Element's width setting.
Setter for element width setting.

Params:

Name Type Default Description
value number | string | null
null
Width settings for the element.

Returns:

anychart.charts.Waterfall - Returns self for method chaining.

Try it:

xAxis

Getter for the chart X-axis.

Params:

Name Type Default Description
index number
0
Chart axis index. If not set - creates a new instance and adds it to the end of the array.

Returns:

anychart.core.axes.Linear - Axis instance by index.

Try it:

Setter for the chart X-axis.

Params:

Name Type Description
value Object | boolean | null Chart axis settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for the chart X-axis 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.Waterfall - Self instance for method chaining.

xGrid

Getter for the chart grid by X-scale.

Params:

Name Type Default Description
index number
0
Chart grid index. If not set - creates a new instance and adds it to the end of the array.

Returns:

anychart.core.grids.Linear - Grid instance by index.

Try it:

Setter for the chart grid by X-scale.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart grid settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for chart grid 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.Waterfall - Self instance for method chaining.

xMinorGrid

Getter for the current chart minor grid by X-scale.

Params:

Name Type Default Description
index number
0
Chart minor grid index. If not set - creates a new instance and adds it to the end of the array.

Returns:

anychart.core.grids.Linear - Minor grid instance by index.

Try it:

Setter for the chart minor grid by X-scale.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart minor grid settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for the chart minor grid 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.Waterfall - Self instance for method chaining.

xScale

Getter for the chart X-scale.

Returns:

anychart.scales.Ordinal - Default chart scale value.

Try it:

Setter for the chart X-scale.

Params:

Name Type Default Description
value Object | anychart.enums.ScaleTypes | string | anychart.scales.Base
anychart.scales.Ordinal
X-scale to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

xScroller

Getter for the scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller settings.

Try it:

Setter for the scroller.

Params:

Name Type Description
value Object | boolean | null Chart scroller settings.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

xZoom

Getter for the zoom settings.

Returns:

anychart.core.utils.OrdinalZoom - 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.Waterfall - Self instance for method chaining.

yAxis

Getter for the chart Y-axis.

Params:

Name Type Default Description
index number
0
Chart axis index. If not set - creates a new instance and adds it to the end of the array.

Returns:

anychart.core.axes.Linear - Axis instance by index.

Try it:

Setter for the chart Y-axis.

Params:

Name Type Description
value Object | boolean | null Chart axis settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for the chart Y-axis 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.Waterfall - Self instance for method chaining.

yGrid

Getter for the chart grid by Y-scale.

Params:

Name Type Default Description
index number
0
Chart grid index. If not set - creates a new instance and adds it to the end of the array.

Returns:

anychart.core.grids.Linear - Grid instance by index.

Try it:

Setter for the chart grid by Y-scale.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart grid settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for chart grid 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.Waterfall - Self instance for method chaining.

yMinorGrid

Getter for the current chart minor grid by Y-scale.

Params:

Name Type Default Description
index number
0
Chart minor grid index. If not set - creates a new instance and adds it to the end of the array.

Returns:

anychart.core.grids.Linear - Minor grid instance by index.

Try it:

Setter for the chart minor grid by Y-scale.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart minor grid settings to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.
Setter for the chart minor grid 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.Waterfall - Self instance for method chaining.

yScale

Getter for the chart Y-scale.

Returns:

anychart.scales.Linear - Default chart scale value.

Try it:

Setter for the chart Y-scale.

Params:

Name Type Default Description
value Object | anychart.enums.ScaleTypes | string | anychart.scales.Base
anychart.scales.Linear
Y-scale to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it:

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.charts.Waterfall - Self instance for method chaining.

Try it: