Top
You are looking at an outdated 7.14.0 version of this document. Switch to the 7.14.3 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:

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.

annotations

Getter for annotations.

Returns:

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

Params:

Name Type Description
annotationsList Array Annotations 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.

Try it:

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

Params:

Name Type Default Description
value number
0.8
Value to set.

Returns:

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

Try it:

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:

Name Type Default Description
value number
0.4
Value to set.

Returns:

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

cancelMarquee

Stops current marquee action if any.

Returns:

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

crosshair

Getter for crosshair settings.

Returns:

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

Params:

Name Type Default Description
value Object | 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.

Try it:

Setter for the data.

Params:

Name Type Description
value anychart.data.View | anychart.data.Set | anychart.data.DataSettings | Array | string Value to set.
csvSettings anychart.enums.TextParsingMode | anychart.data.TextParsingSettings If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

Name Type Description
value string | anychart.enums.CartesianSeriesType Default 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:

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

Returns:

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

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 class for method chaining.

Try it:

getSeriesCount

Returns series count.

Returns:

number - Number of series.

Try it:

getStat

Getter for a statistical value by the key.

Params:

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

Returns:

* - Statistics value.

Try it:

getType

Returns chart type.

Returns:

string - Chart type.

Try it:

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

Try it:

grid

Getter for the chart grid.

Params:

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

Returns:

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

Try it:

Setter for the chart grid.

Params:

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

Returns:

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

Name Type Description
value Array.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFills Chart hatch fill palette settings to set.

Returns:

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

Try it:

hoverLabels

Getter for series data hover labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for series data hover labels.

Params:

Name Type Description
value Object | boolean | null Series 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.

Try it:

Setter for series data labels.

Params:

Name Type Description
value Object | boolean | null Series data labels settings.

Returns:

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

lineMarker

Getter for the current line marker.

Params:

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

Returns:

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

Try it:

Setter for the line marker settings.

Params:

Name Type Default Description
value Object | 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:

Name Type Default Description
index number
0
Chart line marker index.
value Object | 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:

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

Returns:

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

Try it:

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:

Name Type Default Description
value number | 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:

Name Type Default Description
value number | string
"5%"
Minimum size to set.

Returns:

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

minorGrid

Getter for the chart minor grid.

Params:

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

Returns:

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

Try it:

Setter for the chart minor grid.

Params:

Name Type Default Description
value Object | 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:

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

Name Type Description
value anychart.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:

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

Returns:

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

Try it:

Setter for the range marker.

Params:

Name Type Default Description
value Object | 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:

Name Type Default Description
index number
0
Chart range marker index.
value Object | 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:

Name Type Description
id number | string Series id.

Returns:

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

removeSeriesAt

Removes one of series from chart by its index.

Params:

Name Type Description
index number Series index.

Returns:

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

selectLabels

Getter for series select data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for series select data labels.

Params:

Name Type Description
value Object | boolean | null Series data labels settings.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

selectMarqueeFill

Getter for the select marquee fill.

Returns:

anychart.graphics.vector.Fill - Select marquee fill.
See listing
var selectMarqueeFill = chart.selectMarqueeFill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an object or a string.

Returns:

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

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

selectMarqueeStroke

Getter for the select marquee stroke.

Returns:

anychart.graphics.vector.Stroke - Select marquee stroke.
See listing.
var selectMarqueeStroke = chart.selectMarqueeStroke();
Setter for the select marquee stroke. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

Try it:

startSelectMarquee

Starts select marquee drawing. Note: Works only after anychart.core.Chart#draw is called.

Params:

Name Type Description
repeat boolean Whether to start select marquee drawing.

Returns:

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

Try it:

textMarker

Getter for the text marker.

Params:

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

Returns:

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

Try it:

Setter for the text marker.

Params:

Name Type Default Description
value Object | 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:

Name Type Default Description
index number
0
Chart text marker index.
value Object | 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:

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

Returns:

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

Try it:

Setter for the chart X-axis.

Params:

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

Returns:

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

xScale

Getter for the chart X-scale.

Returns:

anychart.scales.Base - Default chart scale value.

Try it:

Setter for the chart X-scale.

Params:

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

Returns:

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

Try it:

xScroller

Getter for the scroller.

Returns:

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

Params:

Name Type Description
value Object | boolean | null Chart 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:

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

yAxis

Getter for the chart Y-axis.

Params:

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

Returns:

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

Try it:

Setter for the chart Y-axis.

Params:

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

Returns:

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

yScale

Getter for the chart Y-scale.

Returns:

anychart.scales.Base - Default chart scale value.

Try it:

Setter for the chart Y-scale.

Params:

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

Returns:

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

Try it: