AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.charts.Pareto Improve this Doc

Methods Overview

Specific settings
a11y()Accessibility setting.
annotations()Creates annotations.
getType()Definition of the chart type.
globalToLocal()Converts the global coordinates to local coordinates.
maxPointWidth()Maximum point width settings.
minPointLength()Minimum point length settings.
pointWidth()Point width settings.
toA11yTable()Creates and returns the chart represented as an invisible HTML table.
toHtmlTable()Creates and returns a chart as HTML table.
Axes and Scales
baseline()Set the baseline by the Y-Scale value.
getXAxesCount()Returns X-axes count.
getXScales()Returns chart X scales.
getYAxesCount()Returns Y-axes count.
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
dataArea()Data area settings.
hatchFillPalette()Hatch fill palette settings.
markerPalette()Markers palette settings.
palette()Palette settings.
Chart Controls
credits()Credits settings
label()Label settings.
legend()Legend settings.
title()Title settings.
xScroller()Scroller settings.
yScroller()Y scroller settings.
Coloring
background()Background settings.
selectMarqueeFill()Select marquee fill settings.
selectMarqueeStroke()Stroke settings.
Data
data()Data 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
unlisten()Removes the listener
unlistenByKey()Removes the listener by the key.
Export
exports()Exports settings
getJpgBase64String()Returns JPG as base64 string.
getPdfBase64String()Returns PDF as base64 string.
getPngBase64String()Returns PNG as base64 string.
getSvgBase64String()Returns SVG as base64 string.
saveAsCsv()Saves chart data as a CSV file.
saveAsJpg()Saves the chart as JPEG image.
saveAsJson()Saves chart config as JSON document.
saveAsPdf()Saves the chart as PDF image.
saveAsPng()Saves the chart as PNG image.
saveAsSvg()Saves the chart as SVG image.
saveAsXlsx()Saves chart data as an Excel document.
saveAsXml()Saves chart config as XML document.
shareAsJpg()Shares a chart as a JPG file and returns a link to the shared image.
shareAsPdf()Shares a chart as a PDF file and returns a link to the shared image.
shareAsPng()Shares a chart as a PNG file and returns a link to the shared image.
shareAsSvg()Shares a chart as a SVG file and returns a link to the shared image.
shareWithFacebook()Opens Facebook sharing dialog.
shareWithLinkedIn()Opens LinkedIn sharing dialog.
shareWithPinterest()Opens Pinterest sharing dialog.
shareWithTwitter()Opens Twitter sharing dialog.
toCsv()Returns CSV string with the chart data.
toSvg()Returns SVG string.
Interactivity
crosshair()Crosshair settings.
hovered()Hovered state settings.
normal()Normal state settings.
selected()Selected state settings.
startSelectMarquee()Starts select marquee drawing.
tooltip()Tooltip settings.
xZoom()Zoom settings.
yZoom()Y zoom settings.
Point Elements
labels()Labels settings.
maxLabels()Maximum labels settings.
minLabels()Minimum labels settings.
Size and Position
bottom()Bottom bound settings.
bounds()Bounds settings.
getPixelBounds()Returns pixel bounds of the chart.
getPlotBounds()Returns data bounds of the chart.
height()Height setting.
left()Left bound setting.
top()Top bound settings.
width()Width setting.
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 series count.
maxBubbleSize()The maximum size for all bubbles on the charts.
minBubbleSize()The 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
autoRedraw()Redraw chart after changes or not.
cancelMarquee()Stops marquee action if any.
container()Chart container
draw()Chart drawing.
fullScreen()Fullscreen mode.
id()Chart id.
inMarquee()Gets marquee process running value.
isFullScreenAvailable()Whether the fullscreen mode available in the browser or not.
isVertical()Getter for the layout direction.

Methods Description

a11y

Getter for the accessibility settings.

Returns:

anychart.core.utils.ChartA11y - Accessibility settings object.
See listing.
var stateOfAccsessibility = chart.a11y();
Setter for the accessibility settings.

Params:

NameTypeDescription
settingsboolean | ObjectWhether to enable accessibility or object with settings.

Returns:

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

addSeries

Adds series to the chart.

Params:

NameTypeDescription
var_argsanychart.data.View | anychart.data.Set | ArrayChart series data.

Returns:

Array.<anychart.core.cartesian.series.Base> - Array of created series.

annotations

Getter for annotations.

Returns:

anychart.core.annotations.PlotController - The plot annotations.
Setter for annotations.

Params:

NameTypeDescription
annotationsListArrayAnnotations list to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining

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:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.
Setter for the chart background settings.

Params:

NameTypeDescription
settingsstring | Object | null | booleanBackground settings to set.

Returns:

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

barGroupsPadding

Getter for space between bar groups on the ordinal scale by a ratio of bars width.

Returns:

number - Bar groups padding.
Setter for space between bar groups on the ordinal scale by a ratio of bars width.
See illustration at anychart.charts.Pareto#barsPadding.

Params:

NameTypeDefaultDescription
paddingnumber
0.8
Value to set.

Returns:

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

barsPadding

Getter for space between bars on the ordinal scale by ratio of bars width.

Returns:

number - Bars padding.
Setter for space between bars on the ordinal scale by ratio of bars width.

Params:

NameTypeDefaultDescription
paddingnumber
0.4
Value to set.

Returns:

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

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:

NameTypeDescription
valuenumberY-Scale value for the baseline.

Returns:

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

bottom

Getter for the chart's bottom bound setting.

Returns:

number | string | undefined - Chart's bottom bound settings.
See listing
var bottom = chart.bottom();
Setter for the chart's top bound setting.

Params:

NameTypeDescription
bottomnumber | string | nullBottom bound for the chart.

Returns:

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

bounds

Getter for the chart bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
See listing
var bounds = chart.bounds();
Setter for the chart bounds using one parameter.

Params:

NameTypeDescription
boundsanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of teh chart.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for the chart bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

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

cancelMarquee

Stops marquee action if any.

Returns:

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

container

Getter for the chart container.
Setter for the chart container.

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementThe value to set.

Returns:

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

credits

Getter for chart credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.
Setter for chart credits. Learn more about credits settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Credits settings

Returns:

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

crosshair

Getter for crosshair settings.

Returns:

anychart.core.ui.Crosshair - Crosshair settings.
Setter for crosshair settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Crosshair settings.

Returns:

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

data

Getter for the data.

Returns:

anychart.data.View - The data view.
Setter for the data.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | anychart.data.DataSettings | Array | stringValue to set.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

dataArea

Getter for the data area settings.

Returns:

anychart.core.ui.DataArea - Data area settings.
Setter for the data area settings.
The data area is drawn along the data bounds.

Params:

NameTypeDescription
settingsObject | booleanData area settings to set.

Returns:

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

defaultSeriesType

Getter for the default series type.

Returns:

anychart.enums.CartesianSeriesType | string - Default series type.
Setter for the series type.

Params:

NameTypeDescription
typeanychart.enums.CartesianSeriesType | stringDefault series type.

Returns:

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

draw

Starts the rendering of the chart into the container.

Params:

NameTypeDescription
asyncbooleanWhether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

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

NameTypeDescription
settingsObjectExport settings.

Returns:

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

fullScreen

Getter for the fullscreen mode.

Returns:

boolean - Full screen state (enabled/disabled).
See listing
var fullScreen = chart.fullScreen();
Setter for the fullscreen mode.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enable/Disable fullscreen mode.

Returns:

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

getJpgBase64String

Returns JPG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.

getPdfBase64String

Returns PDF as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.

getPixelBounds

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

Returns:

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

getPlotBounds

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

Returns:

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

getPngBase64String

Returns PNG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.

getSeries

Getter for the series by its id.

Params:

NameTypeDefaultDescription
idnumber | string
index
Id of the series.

Returns:

anychart.core.cartesian.series.Base - An instance of the class for method chaining.

getSeriesAt

Getter for the series by its index.

Params:

NameTypeDescription
indexnumberIndex of the series.

Returns:

anychart.core.cartesian.series.Base - An instance of the class for method chaining.

getSeriesCount

Returns series count.

Returns:

number - Number of series.

getStat

Getter for a statistical value by the key.

Params:

NameTypeDescription
keyanychart.enums.Statistics | stringKey.

Returns:

* - Statistics value.

getSvgBase64String

Returns SVG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.

getType

Returns chart type.

Returns:

string - Chart type.

getXAxesCount

Returns X-axes count.

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 Y-axes count.

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.charts.Pareto#draw is called.

Params:

NameTypeDescription
xCoordnumberGlobal X coordinate.
yCoordnumberGlobal Y coordinate.

Returns:

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

hatchFillPalette

Getter for 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:

NameTypeDescription
settingsArray.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFillsChart hatch fill palette settings to set.

Returns:

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

height

Getter for the chart's height setting.

Returns:

number | string | undefined - Chart's height setting.
See listing
var height = chart.height();
Setter for the chart's height setting.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the chart.

Returns:

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

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

id

Getter for chart id.

Returns:

string - Return chart id.
Setter for chart id.

Params:

NameTypeDescription
idstringChart id.

Returns:

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

inMarquee

Gets marquee process running value.

Returns:

boolean - Returns true if there is a marquee process running.

isFullScreenAvailable

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

isVertical

Getter for the layout direction.

Returns:

boolean - The flag of the series layout direction.
See listing
var flag = chart.isVertical();
Setter for the layout direction.

Params:

NameTypeDefaultDescription
enabledboolean | null
false
Whether to change the chart layout direction to vertical.

Returns:

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

label

Getter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.
Setter for the chart label.

Params:

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

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for chart label using index.

Params:

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

Returns:

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

labels

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for series data labels.

Params:

NameTypeDescription
settingsObject | boolean | nullSeries data labels settings.

Returns:

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

left

Getter for the chart's left bound setting.

Returns:

number | string | undefined - Chart's left bound setting.
See listing
var left = chart.left();
Setter for the chart's left bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the chart.

Returns:

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

legend

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.
Setter for the chart legend settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Legend settings.

Returns:

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

lineMarker

Getter for the line marker.

Params:

NameTypeDefaultDescription
indexnumber
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.
Setter for the line marker settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart line marker settings to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for the line marker settings by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart line marker index.
settingsObject | boolean | null
Chart line marker settings to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(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
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

markerPalette

Getter for chart markers palette settings.

Returns:

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

Params:

NameTypeDescription
settingsanychart.palettes.Markers | Object | Array.<(anychart.enums.MarkerType|string)>Chart marker palette settings to set.

Returns:

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

maxBubbleSize

Getter for the maximum size for all bubbles on the charts.

Returns:

number | string - The maximum size all of the bubbles.
Setter for the maximum size for all bubbles on the charts.

Params:

NameTypeDescription
sizenumber | stringMaximum size to set.

Returns:

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

maxLabels

Getter for maximum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for maximum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMaximum labels settings.

Returns:

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

NameTypeDescription
widthnumber | stringPoint width pixel value.

Returns:

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

minBubbleSize

Getter for the minimum size for all bubbles on the charts.

Returns:

number | string - The minimum size of the all bubbles.
Setter for the minimum size for all bubbles on the charts.

Params:

NameTypeDescription
sizenumber | stringMinimum size to set.

Returns:

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

minLabels

Getter for minimum labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for minimum labels.

Params:

NameTypeDescription
settingsObject | boolean | nullMinimum labels settings.

Returns:

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

NameTypeDescription
lengthnumber | stringMinimum point length pixel value.

Returns:

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

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.
Setter for noData settings.
Learn more about "No data" feature

Params:

NameTypeDescription
settingsObjectNoData settings.

Returns:

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

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

palette

Getter for the chart colors palette.
See listing
var palette = chart.palette();
Setter for the chart colors palette.

Params:

NameTypeDescription
settingsanychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string>Chart colors palette settings to set.

Returns:

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

NameTypeDescription
widthnumber | stringPoint width pixel value.

Returns:

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

rangeMarker

Getter for the range marker.

Params:

NameTypeDefaultDescription
indexnumber
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.
Setter for the range marker.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart range marker settings to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for the range marker by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart range marker index.
settingsObject | boolean | null
Chart range marker settings to set.

Returns:

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

removeAllSeries

Removes all series from chart.

Returns:

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

removeSeries

Removes one of series from chart by its id.

Params:

NameTypeDescription
idnumber | stringSeries id.

Returns:

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

removeSeriesAt

Removes one of series from chart by its index.

Params:

NameTypeDescription
indexnumberSeries index.

Returns:

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

saveAsCsv

Saves chart data as a CSV file.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<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').
filenamestringFile name to save.

saveAsJpg

Saves the chart as JPEG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanDefine, should we force transparent to white background.

saveAsJson

Saves chart config as JSON document.

Params:

NameTypeDescription
filenamestringFile name to save.

saveAsPdf

Saves the chart as PDF image.

Params:

NameTypeDescription
paperSizestringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.

saveAsPng

Saves the chart as PNG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.

saveAsSvg

Saves the chart as SVG image using paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.
Saves the stage as SVG image using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

saveAsXlsx

Saves chart data as an Excel document.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
filenamestringFile name to save.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
filenamestringFile name to save.

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, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array or a string.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

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:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings
Setter for selected state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

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

shareAsJpg

Shares a chart as a JPG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.
filenamestringFile name to save.

shareAsPdf

Shares a chart as a PDF file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

shareAsPng

Shares a chart as a PNG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

shareAsSvg

Shares a chart as a SVG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.
filenamestringFile name to save.

shareWithFacebook

Opens Facebook sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for the main link or object with options.
linkstringThe URL is attached to the publication.
namestringThe title for the attached link.
descriptionstringDescription for the attached link.

shareWithLinkedIn

Opens LinkedIn sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for publication or object with options. If not set 'AnyChart' will be used.
descriptionstringDescription.

shareWithPinterest

Opens Pinterest sharing dialog.

Params:

NameTypeDescription
linkOrOptionsstring | ObjectAttached link or object with options. If not set, the image URL will be used.
descriptionstringDescription.

shareWithTwitter

Opens Twitter sharing dialog.

startSelectMarquee

Starts select marquee drawing. Note: Works only after anychart.charts.Pareto#draw is called.

Params:

NameTypeDescription
repeatbooleanWhether to start select marquee drawing.

Returns:

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

textMarker

Getter for the text marker.

Params:

NameTypeDefaultDescription
indexnumber
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.
Setter for the text marker.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart text marker settings to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for the text marker by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart text marker index.
settingsObject | boolean | null
Chart text marker settings to set.

Returns:

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

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.
Setter for the chart title.

Params:

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

Returns:

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

toA11yTable

Creates and returns the chart represented as an invisible HTML table.

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance with a11y style (invisible), HTML string or null if parsing chart to table fails.

toCsv

Returns CSV string with the chart data.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<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.

toHtmlTable

Creates and returns a chart as HTML table.

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance, HTML string or null if parsing chart to table fails.

toJson

Returns chart configuration as JSON object or string.

Params:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.

Returns:

Object | string - Chart configuration.

toSvg

Returns SVG string using paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.

Returns:

string - SVG content or empty string.
Returns SVG string using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

Returns:

string - SVG content or empty string.

toXml

Returns chart configuration as XML string or XMLNode.

Params:

NameTypeDefaultDescription
asXmlNodeboolean
false
Return XML as XMLNode.

Returns:

string | Node - Chart configuration.

tooltip

Getter for the tooltip settings.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for tooltip settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Tooltip settings.

Returns:

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

top

Getter for the chart's top bound setting.

Returns:

number | string | undefined - Chart's top bound settings.
See listing
var top = chart.top();
Setter for the chart's top bound setting.

Params:

NameTypeDescription
topnumber | string | nullTop bound for the chart.

Returns:

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

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

width

Getter for the chart's width setting.

Returns:

number | string | undefined - Chart's width setting.
See listing
var width = chart.width();
Setter for the chart's width setting.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the chart.

Returns:

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

xAxis

Getter for the chart X-axis.

Params:

NameTypeDefaultDescription
indexnumber
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.
Setter for the chart X-axis.

Params:

NameTypeDescription
settingsObject | boolean | nullChart axis settings to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for the chart X-axis by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart axis index.
settingsObject | boolean | null
Chart axis settings to set.

Returns:

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

xGrid

Getter for the chart grid by X-scale.

Params:

NameTypeDefaultDescription
indexnumber
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.
Setter for the chart grid by X-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart grid settings to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for chart grid by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart grid index.
settingsObject | boolean | null
false
Chart grid settings to set.

Returns:

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

xMinorGrid

Getter for the chart minor grid by X-scale.

Params:

NameTypeDefaultDescription
indexnumber
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.
Setter for the chart minor grid by X-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart minor grid settings to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for the chart minor grid by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart minor grid index.
settingsObject | boolean | null
false
Chart minor grid settings to set.

Returns:

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

xScale

Getter for the chart X-scale.

Returns:

anychart.scales.Base - Default chart scale value.
Setter for the chart X-scale.

Params:

NameTypeDefaultDescription
settingsObject | anychart.enums.ScaleTypes | string | anychart.scales.Base
anychart.scales.Ordinal
X-scale to set.

Returns:

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

xScroller

Getter for the scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller settings.
Setter for the scroller.

Params:

NameTypeDescription
settingsObject | boolean | nullChart scroller settings.

Returns:

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

xZoom

Getter for zoom settings.

Returns:

anychart.core.utils.OrdinalZoom - Zoom settings.
Setter for the zoom settings.

Params:

NameTypeDescription
settingsnumber | boolean | null | ObjectValue to set. If you will pass null, true, false or number less than 1, then value will be converted in 1.

Returns:

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

yAxis

Getter for the chart Y-axis.

Params:

NameTypeDefaultDescription
indexnumber
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.
Setter for the chart Y-axis.

Params:

NameTypeDescription
settingsObject | boolean | nullChart axis settings to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for the chart Y-axis by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart axis index.
settingsObject | boolean | null
Chart axis settings to set.

Returns:

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

yGrid

Getter for the chart grid by Y-scale.

Params:

NameTypeDefaultDescription
indexnumber
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.
Setter for the chart grid by Y-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart grid settings to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for chart grid by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart grid index.
settingsObject | boolean | null
false
Chart grid settings to set.

Returns:

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

yMinorGrid

Getter for the chart minor grid by Y-scale.

Params:

NameTypeDefaultDescription
indexnumber
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.
Setter for the chart minor grid by Y-scale.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart minor grid settings to set.

Returns:

anychart.charts.Pareto - Self instance for method chaining.
Setter for the chart minor grid by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart minor grid index.
settingsObject | boolean | null
false
Chart minor grid settings to set.

Returns:

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

yScale

Getter for the chart Y-scale.

Returns:

anychart.scales.Base - Default chart scale value.
Setter for the chart Y-scale.

Params:

NameTypeDefaultDescription
settingsObject | anychart.enums.ScaleTypes | string | anychart.scales.Base
anychart.scales.Linear
Y-scale to set.

Returns:

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

yScroller

Getter for the Y scroller.

Returns:

anychart.core.ui.ChartScroller - Scroller settings.
Setter for the Y scroller.

Params:

NameTypeDescription
settingsObject | boolean | nullChart Y scroller settings.

Returns:

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

yZoom

Getter for Y zoom settings.

Returns:

anychart.core.utils.OrdinalZoom - Zoom settings.
Setter for Y zoom settings.

Params:

NameTypeDescription
settingsnumber | boolean | null | ObjectZoom settings to set. If you pass null, true, false or a number less than 1, then the value is converted to 1.

Returns:

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