HighchartsPieSeriesOptions class

A pie series. If the type option is not specified, it is inherited from chart.type.

Configuration options for the series are given in three levels:

  1. Options for all series in a chart are defined in the plotOptions.series object.
  2. Options for all pie series are defined in plotOptions.pie.
  3. Options for one single series are given in the series instance array.

API Docs: https://api.highcharts.com/highcharts/series.pie

Inheritance

Constructors

HighchartsPieSeriesOptions.new({HighchartsSeriesAccessibilityOptions? accessibility, bool? allowPointSelect, dynamic animation, String? borderColor, Map<String, dynamic>? borderRadius, double? borderWidth, List? center, String? className, bool? clip, String? color, dynamic colorAxis, double? colorIndex, String? colorKey, List? colors, bool? crisp, String? cursor, Map<String, dynamic>? custom, HighchartsPieSeriesDataLabelsOptions? dataLabels, double? depth, String? description, bool? enableMouseTracking, double? endAngle, HighchartsPieSeriesEventsOptions? events, String? fillColor, String? id, bool? ignoreHiddenPoint, HighchartsPieSeriesInactiveOtherPointsOptions? inactiveOtherPoints, bool? includeInDataExport, double? index, dynamic innerSize, List<String>? keys, double? legendIndex, String? legendSymbol, String? legendSymbolColor, String? linecap, dynamic mapData, dynamic minSize, bool? nullInteraction, HighchartsSeriesOnPointOptions? onPoint, double? opacity, HighchartsPieSeriesPointOptions? point, dynamic pointDescriptionFormat, dynamic pointDescriptionFormatter, bool? relativeXValue, bool? selected, Map<String, dynamic>? shadow, bool? showCheckbox, bool? showInLegend, dynamic size, bool? skipKeyboardNavigation, double? slicedOffset, HighchartsSeriesSonificationOptions? sonification, double? startAngle, HighchartsPieSeriesStatesOptions? states, bool? stickyTracking, double? thickness, HighchartsPieSeriesTooltipOptions? tooltip, bool? visible, double? zIndex})
A pie series. If the type option is not specified, it is inherited from chart.type.

Properties

accessibility ↔ HighchartsSeriesAccessibilityOptions?
Accessibility options for a series.
getter/setter pair
allowPointSelect ↔ bool?
Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
getter/setter pair
animation ↔ dynamic
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported:
getter/setter pair
borderColor ↔ String?
The color of the border surrounding each slice. When null, the border takes the same color as the slice fill. This can be used together with a borderWidth to fill drawing gaps created by antialiazing artefacts in borderless pies.
getter/setter pair
borderRadius ↔ Map<String, dynamic>?
The corner radius of the border surrounding each slice. A number signifies pixels. A percentage string, like for example 50%, signifies a size relative to the radius and the inner radius.
getter/setter pair
borderWidth ↔ double?
The width of the border surrounding each slice.
getter/setter pair
center ↔ List?
The center of the pie chart relative to the plot area. Can be percentages or pixel values. The default behaviour (as of 3.0) is to center the pie so that all slices and data labels are within the plot area. As a consequence, the pie may actually jump around in a chart with dynamic values, as the data labels move. In that case, the center should be explicitly set, for example to ["50%", "50%"].
getter/setter pair
className ↔ String?
An additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element. Changes to the series' color will also be reflected in a chart's legend and tooltip.
getter/setter pair
clip ↔ bool?
Highcharts Options Widget.
getter/setter pair
color ↔ String?
The color of the pie series. A pie series is represented as an empty circle if the total sum of its values is 0. Use this property to define the color of its border.
getter/setter pair
colorAxis ↔ dynamic
When using dual or multiple color axes, this number defines which colorAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the colorAxis array, with 0 being the first. Set this option to false to prevent a series from connecting to the default color axis.
getter/setter pair
colorIndex ↔ double?
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
getter/setter pair
colorKey ↔ String?
Determines what data value should be used to calculate point color if colorAxis is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to 'sum'.
getter/setter pair
colors ↔ List?
A series specific or series type specific color set to use instead of the global colors.
getter/setter pair
crisp ↔ bool?
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry.
getter/setter pair
cursor ↔ String?
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
getter/setter pair
custom ↔ Map<String, dynamic>?
A reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.
getter/setter pair
dataLabels ↔ HighchartsPieSeriesDataLabelsOptions?
Highcharts Options Widget.
getter/setter pair
depth ↔ double?
The thickness of a 3D pie.
getter/setter pair
description ↔ String?
A description of the series to add to the screen reader information about the series.
getter/setter pair
enableMouseTracking ↔ bool?
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
getter/setter pair
endAngle ↔ double?
The end angle of the pie in degrees where 0 is top and 90 is right. Defaults to startAngle plus 360.
getter/setter pair
events ↔ HighchartsPieSeriesEventsOptions?
Highcharts Options Widget.
getter/setter pair
fillColor ↔ String?
If the total sum of the pie's values is 0, the series is represented as an empty circle . The fillColor option defines the color of that circle. Use pie.borderWidth to set the border thickness.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
getter/setter pair
ignoreHiddenPoint ↔ bool?
Equivalent to chart.ignoreHiddenSeries, this option tells whether the series shall be redrawn as if the hidden point were null.
getter/setter pair
inactiveOtherPoints ↔ HighchartsPieSeriesInactiveOtherPointsOptions?
Highcharts Options Widget.
getter/setter pair
includeInDataExport ↔ bool?
When set to false will prevent the series data from being included in any form of data export.
getter/setter pair
index ↔ double?
The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
getter/setter pair
innerSize ↔ dynamic
The size of the inner diameter for the pie. A size greater than 0 renders a donut chart. Can be a percentage or pixel value. Percentages are relative to the pie size. Pixel values are given as integers. Setting overridden by thickness.
getter/setter pair
keys ↔ List<String>?
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
getter/setter pair
legendIndex ↔ double?
The sequential index of the series in the legend.
getter/setter pair
legendSymbol ↔ String?
What type of legend symbol to render for this series. Can be one of areaMarker, lineMarker or rectangle.
getter/setter pair
legendSymbolColor ↔ String?
Defines the color of the legend symbol for this series. Defaults to undefined, in which case the series color is used. Does not work with styled mode.
getter/setter pair
linecap ↔ String?
The SVG value used for the stroke-linecap and stroke-linejoin of a line graph. Round means that lines are rounded in the ends and bends.
getter/setter pair
mapData ↔ dynamic
An array of objects containing a geometry or path definition and optionally additional properties to join in the data as per the joinBy option. GeoJSON and TopoJSON structures can also be passed directly into mapData.
getter/setter pair
minSize ↔ dynamic
The minimum size for a pie in response to auto margins. The pie will try to shrink to make room for data labels in side the plot area, but only to this size.
getter/setter pair
nullInteraction ↔ bool?
Whether or not data-points with the value of null should be interactive. When this is set to true, tooltips may highlight these points, and this option also enables keyboard navigation for such points. Format options for such points include nullFormat and nullFormater. Works for these series: line, spline, area, area-spline, column, bar, and* timeline.
getter/setter pair
onPoint ↔ HighchartsSeriesOnPointOptions?
Options for the Series on point feature. Only pie and sunburst series are supported at this moment.
getter/setter pair
opacity ↔ double?
Opacity of a series parts: line, fill (e.g. area) and dataLabels.
getter/setter pair
point ↔ HighchartsPieSeriesPointOptions?
Highcharts Options Widget.
getter/setter pair
pointDescriptionFormat ↔ dynamic
Same as accessibility.point.descriptionFormat, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
pointDescriptionFormatter ↔ dynamic
Same as accessibility.series.descriptionFormatter, but for an individual series. Overrides the chart wide configuration.
getter/setter pair
relativeXValue ↔ bool?
When true, X values in the data set are relative to the current pointStart, pointInterval and pointIntervalUnit settings. This allows compression of the data for datasets with irregular X values.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selected ↔ bool?
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name in the legend will be checked for a selected series.
getter/setter pair
shadow ↔ Map<String, dynamic>?
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
getter/setter pair
showCheckbox ↔ bool?
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
getter/setter pair
showInLegend ↔ bool?
Whether to display this particular series or series type in the legend. Since 2.1, pies are not shown in the legend by default.
getter/setter pair
size ↔ dynamic
The diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as integers. The default behaviour (as of 3.0) is to scale to the plot area and give room for data labels within the plot area. slicedOffset is also included in the default size calculation. As a consequence, the size of the pie may vary when points are updated and data labels more around. In that case it is best to set a fixed value, for example "75%".
getter/setter pair
skipKeyboardNavigation ↔ bool?
If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
getter/setter pair
slicedOffset ↔ double?
If a point is sliced, moved out from the center, how many pixels should it be moved?.
getter/setter pair
sonification ↔ HighchartsSeriesSonificationOptions?
Sonification/audio chart options for a series.
getter/setter pair
startAngle ↔ double?
The start angle of the pie slices in degrees where 0 is top and 90 right.
getter/setter pair
states ↔ HighchartsPieSeriesStatesOptions?
Highcharts Options Widget.
getter/setter pair
stickyTracking ↔ bool?
Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.
getter/setter pair
thickness ↔ double?
Thickness describing the ring size for a donut type chart, overriding innerSize.
getter/setter pair
tooltip ↔ HighchartsPieSeriesTooltipOptions?
Highcharts Options Widget.
getter/setter pair
visible ↔ bool?
Set the initial visibility of the series.
getter/setter pair
zIndex ↔ double?
Define the visual z index of the series.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited