Class PlotOptionsPie
- All Implemented Interfaces:
Serializable
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds color to the colors arrayvoid
Adds key to the keys arrayvoid
Adds zone to the zones arrayString[]
getClip()
Color[]
getCrisp()
getDepth()
String[]
getKeys()
getSize()
Zones[]
getZones()
void
removeColor
(Color color) Removes first occurrence of color in colors arrayvoid
Removes first occurrence of key in keys arrayvoid
removeZone
(Zones zone) Removes first occurrence of zone in zones arrayvoid
setAllowPointSelect
(Boolean allowPointSelect) Allow this series' points to be selected by clicking on the markers, bars or pie slices.void
setAnimation
(Boolean animation) Enable or disable the initial animation when a series is displayed.void
setAnimationLimit
(Number animationLimit) For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.void
setBorderColor
(Color borderColor) The color of the border surrounding each slice.void
setBorderWidth
(Number borderWidth) The width of the border surrounding each slice.void
The center of the pie chart relative to the plot area.void
void
setClassName
(String className) A class name to apply to the series' graphical elements.void
Disable this option to allow series rendering in the whole plotting area.void
setColorIndex
(Number colorIndex) Styled mode only.void
setColorKey
(String colorKey) Determines what data value should be used to calculate point color ifcolorAxis
is used.void
A series specific or series type specific color set to use instead of the global colors.void
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen.void
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.void
setDataLabels
(DataLabels dataLabels) void
The thickness of a 3D pie.void
setDescription
(String description) Requires Accessibility modulevoid
setEnableMouseTracking
(Boolean enableMouseTracking) Enable or disable the mouse tracking for a specific series.void
setEndAngle
(Number endAngle) The end angle of the pie in degrees where 0 is top and 90 is right.void
setExposeElementToA11y
(Boolean exposeElementToA11y) By default, series are exposed to screen readers as regions.void
setFindNearestPointBy
(Dimension findNearestPointBy) Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.void
setGetExtremesFromAll
(Boolean getExtremesFromAll) Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.void
setIgnoreHiddenPoint
(Boolean ignoreHiddenPoint) Equivalent to chart.ignoreHiddenSeries, this option tells whether the series shall be redrawn as if the hidden point werenull
.void
setInnerSize
(String innerSize) The size of the inner diameter for the pie.void
An array specifying which option maps to which key in the data point array.void
setLinkedTo
(String linkedTo) The id of another series to link to.void
setMinSize
(Number minSize) The minimum size for a pie in response to auto margins.void
setOpacity
(Number opacity) Opacity of a series parts: line, fill (e.g.void
setPointDescriptionFormatter
(String _fn_pointDescriptionFormatter) void
setSelected
(Boolean selected) Whether to select the series initially.void
Whether to apply a drop shadow to the graph line.void
setShowInLegend
(Boolean showInLegend) Whether to display this particular series or series type in the legend.void
The diameter of the pie relative to the plot area.void
setSkipKeyboardNavigation
(Boolean skipKeyboardNavigation) If set toTrue
, the accessibility module will skip past the points in this series for keyboard navigation.void
setSlicedOffset
(Number slicedOffset) If a point is sliced, moved out from the center, how many pixels should it be moved?.void
setStartAngle
(Number startAngle) The start angle of the pie slices in degrees where 0 is top and 90 right.void
A wrapper object for all the series options in specific states.void
setStickyTracking
(Boolean stickyTracking) Sticky tracking of mouse events.void
setTooltip
(SeriesTooltip tooltip) A configuration object for the tooltip rendering of each single series.void
setVisible
(Boolean visible) Set the initial visibility of the series.void
setZoneAxis
(ZoneAxis zoneAxis) Defines the Axis on which the zones are applied.void
An array defining zones within a series.
-
Constructor Details
-
PlotOptionsPie
public PlotOptionsPie()
-
-
Method Details
-
getChartType
- Overrides:
getChartType
in classAbstractPlotOptions
-
getAllowPointSelect
- See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers, bars or pie slices.Defaults to: false
-
getAnimation
- See Also:
-
setAnimation
Enable or disable the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, seeChartModel.setAnimation(Boolean)
-
getAnimationLimit
- See Also:
-
setAnimationLimit
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, setanimationLimit
toInfinity
. -
getBorderColor
- See Also:
-
setBorderColor
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 aborderWidth
to fill drawing gaps created by antialiazing artefacts in borderless pies.In styled mode, the border stroke is given in the
.highcharts-point
class.Defaults to: #ffffff
-
getBorderWidth
- See Also:
-
setBorderWidth
The width of the border surrounding each slice.
When setting the border width to 0, there may be small gaps between the slices due to SVG antialiasing artefacts. To work around this, keep the border width at 0.5 or 1, but set the
borderColor
tonull
instead.In styled mode, the border stroke width is given in the
.highcharts-point
class.Defaults to: 1
-
setCenter
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%"]
.Defaults to: [null, null]
-
getClassName
- See Also:
-
setClassName
A class name to apply to the series' graphical elements. -
getClip
- See Also:
-
setClip
Disable this option to allow series rendering in the whole plotting area. Note that clipping should be always enabled when chart.zoomType is setDefaults to
false
.- Parameters:
clip
-
-
getColorIndex
- See Also:
-
setColorIndex
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class namehighcharts-color-{n}
. -
getColorKey
- See Also:
-
setColorKey
Determines what data value should be used to calculate point color ifcolorAxis
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'
.Defaults to
y
.- Parameters:
colorKey
-
-
getColors
- See Also:
-
setColors
A series specific or series type specific color set to use instead of the global colors. -
addColor
Adds color to the colors array- Parameters:
color
- to add- See Also:
-
removeColor
Removes first occurrence of color in colors array- Parameters:
color
- to remove- See Also:
-
getCrisp
- See Also:
-
setCrisp
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, settingcrisp
tofalse
may look better, even though each column is rendered blurry.Defaults to
true
. -
getCursor
- See Also:
-
setCursor
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. -
getDataLabels
- See Also:
-
setDataLabels
-
getDepth
- See Also:
-
setDepth
The thickness of a 3D pie. Requireshighcharts-3d.js
Defaults to: 0
-
getDescription
- See Also:
-
setDescription
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
-
getEnableMouseTracking
- See Also:
-
setEnableMouseTracking
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.Defaults to: true
-
getEndAngle
- See Also:
-
setEndAngle
The end angle of the pie in degrees where 0 is top and 90 is right. Defaults tostartAngle
plus 360.Defaults to: null
-
getExposeElementToA11y
- See Also:
-
setExposeElementToA11y
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Defaults to: undefined
-
getFindNearestPointBy
- See Also:
-
setFindNearestPointBy
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to
'xy'
for scatter series and'x'
for most other series. If the data has duplicate x-values, it is recommended to set this to'xy'
to allow hovering over all points.Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
-
getGetExtremesFromAll
- See Also:
-
setGetExtremesFromAll
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.Defaults to: false
-
getIgnoreHiddenPoint
- See Also:
-
setIgnoreHiddenPoint
Equivalent to chart.ignoreHiddenSeries, this option tells whether the series shall be redrawn as if the hidden point were
null
.The default value changed from
false
totrue
with Highcharts 3.0.Defaults to: true
-
getInnerSize
- See Also:
-
setInnerSize
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.
Note: in Highcharts < 4.1.2, the percentage was relative to the plot area, not the pie size.
Defaults to: 0
-
getKeys
- See Also:
-
setKeys
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. -
addKey
Adds key to the keys array- Parameters:
key
- to add- See Also:
-
removeKey
Removes first occurrence of key in keys array- Parameters:
key
- to remove- See Also:
-
getLinkedTo
- See Also:
-
setLinkedTo
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series. -
getMinSize
- See Also:
-
setMinSize
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.Defaults to: 80
-
getOpacity
- See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.Defaults to
1
. -
getPointDescriptionFormatter
-
setPointDescriptionFormatter
-
getSelected
- See Also:
-
setSelected
Whether to select the series initially. IfshowCheckbox
is true, the checkbox next to the series name will be checked for a selected series.Defaults to: false
-
getShadow
- See Also:
-
setShadow
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor
,offsetX
,offsetY
,opacity
andwidth
.Defaults to: false
-
getShowInLegend
- See Also:
-
setShowInLegend
Whether to display this particular series or series type in the legend. Since 2.1, pies are not shown in the legend by default.Defaults to: false
-
getSize
- See Also:
-
setSize
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. 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%"
.Defaults to:
-
getSlicedOffset
- See Also:
-
setSlicedOffset
If a point is sliced, moved out from the center, how many pixels should it be moved?.Defaults to: 10
-
getStartAngle
- See Also:
-
setStartAngle
The start angle of the pie slices in degrees where 0 is top and 90 right.Defaults to: 0
-
getStates
- See Also:
-
setStates
A wrapper object for all the series options in specific states. -
getStickyTracking
- See Also:
-
setStickyTracking
Sticky tracking of mouse events. When true, themouseOut
event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOut
event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTracking
is false andtooltip.shared
is false, the tooltip will be hidden when moving the mouse between series.Defaults to: false
-
getTooltip
- See Also:
-
setTooltip
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level. -
getVisible
- See Also:
-
setVisible
Set the initial visibility of the series.Defaults to: true
-
getZoneAxis
- See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.Defaults to: y
-
getZones
- See Also:
-
setZones
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the
zoneAxis
option.In styled mode, the color zones are styled with the
.highcharts-zone-{n}
class, or custom classed from theclassName
option (view live demo). -
addZone
Adds zone to the zones array- Parameters:
zone
- to add- See Also:
-
removeZone
Removes first occurrence of zone in zones array- Parameters:
zone
- to remove- See Also:
-
setCenter
-
getCenter
-