AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

class anychart.charts.Pareto Improve this Doc

Extends: anychart.core.SeparateChart

Pareto chart class.

Methods Overview

Specific settings
annotations()Creates annotations.
getType()Definition of the chart type.
Axes and Scales
getXAxesCount()Returns X-axes count.
getXScales()Returns chart X scales.
getYAxesCount()Returns Y-axes count.
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
hatchFillPalette()Hatch fill palette settings.
markerPalette()Markers palette settings.
palette()Palette settings.
Chart Controls
xScroller()Scroller settings.
Coloring
selectMarqueeFill()Select marquee fill settings.
selectMarqueeStroke()Stroke settings.
Data
data()Data settings.
getStat()Getter for a statistical value by the key.
Interactivity
crosshair()Crosshair settings.
startSelectMarquee()Starts select marquee drawing.
xZoom()Zoom settings.
Point Elements
hoverLabels()Labels settings.
labels()Labels settings.
selectLabels()Labels settings.
Size and Position
getPlotBounds()Returns data bounds 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 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.
Miscellaneous
cancelMarquee()Stops current marquee action if any.
inMarquee()Gets marquee process running value.

Methods Description

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

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.Cartesian#barsPadding.

Params:

NameTypeDefaultDescription
valuenumber
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
valuenumber
0.4
Value to set.

Returns:

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

cancelMarquee

Stops current marquee action if any.

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
valueObject | 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
valueanychart.data.View | anychart.data.Set | anychart.data.DataSettings | Array | stringValue to set.
csvSettingsanychart.enums.TextParsingMode | 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.

defaultSeriesType

Getter for the default series type.

Returns:

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

Params:

NameTypeDescription
valuestring | anychart.enums.CartesianSeriesTypeDefault series type.

Returns:

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

getPlotBounds

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

Returns:

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

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
keystring | anychart.enums.StatisticsKey.

Returns:

* - Statistics value.

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

grid

Getter for the chart grid.

Params:

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

Params:

NameTypeDefaultDescription
valueObject | 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.
valueObject | boolean | null
false
Chart grid settings to set.

Returns:

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

hatchFillPalette

Getter for hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Chart hatch fill palette.
See listing
var currentHatchFillPalette = chart.hatchFillPalette();
Setter for hatch fill palette settings.

Params:

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

Returns:

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

hoverLabels

Getter for series data hover labels.

Returns:

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

Params:

NameTypeDescription
valueObject | boolean | nullSeries data labels settings.

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.

labels

Getter for series data labels.

Returns:

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

Params:

NameTypeDescription
valueObject | boolean | nullSeries data labels settings.

Returns:

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

lineMarker

Getter for the current line marker.

Params:

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

Params:

NameTypeDefaultDescription
valueObject | 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.
valueObject | boolean | null
Chart line marker settings to set.

Returns:

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

markerPalette

Getter for chart markers palette settings.

Returns:

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

Params:

NameTypeDescription
valueanychart.palettes.Markers | Object | Array.<anychart.enums.MarkerType>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:

NameTypeDefaultDescription
valuenumber | string
"20%"
Maximum size to set.

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:

NameTypeDefaultDescription
valuenumber | string
"5%"
Minimum size to set.

Returns:

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

minorGrid

Getter for the chart minor grid.

Params:

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

Params:

NameTypeDefaultDescription
valueObject | 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.
valueObject | boolean | null
false
Chart minor grid settings to set.

Returns:

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

palette

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

Params:

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

Returns:

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

rangeMarker

Getter for the current range marker.

Params:

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

Params:

NameTypeDefaultDescription
valueObject | 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.
valueObject | 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.

selectLabels

Getter for series select data labels.

Returns:

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

Params:

NameTypeDescription
valueObject | boolean | nullSeries 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:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object 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.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

startSelectMarquee

Starts select marquee drawing. Note: Works only after anychart.core.Chart#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 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.
Setter for the text marker.

Params:

NameTypeDefaultDescription
valueObject | 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.
valueObject | boolean | null
Chart text marker settings to set.

Returns:

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

xAxis

Getter for the chart X-axis.

Params:

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

Params:

NameTypeDescription
valueObject | 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.
valueObject | boolean | null
Chart axis 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:

NameTypeDescription
valueanychart.enums.ScaleTypes | anychart.scales.BaseX-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
valueObject | 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
valuenumber | 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 don't set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axes.Linear - Axis instance by index.
Setter for the chart Y-axis.

Params:

NameTypeDescription
valueObject | 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.
valueObject | boolean | null
Chart axis 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:

NameTypeDescription
valueanychart.enums.ScaleTypes | anychart.scales.BaseY-scale to set.

Returns:

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