class PlotOptionsPie extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
plotOptions-pie
- Alphabetic
- By Inheritance
- PlotOptionsPie
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new PlotOptionsPie()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
allowPointSelect: UndefOr[Boolean]
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
-
val
animation: UndefOr[Boolean]
Enable or disable the initial animation when a series is displayed.
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: <dl> <dt>duration</dt>
- The duration of the animation in milliseconds.
<dt>easing</dt>- A string reference to an easing function set on the
</dl>Mathobject. See the easing demo.Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
Example: -
val
animationLimit: UndefOr[Double]
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 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, set
animationLimittoInfinity. -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
borderColor: UndefOr[|[String, Object]]
The color of the border surrounding each slice.
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 aborderWidthto fill drawing gaps created by antialiazing artefacts in borderless pies.In styled mode, the border stroke is given in the
.highcharts-pointclass.Example: -
val
borderWidth: UndefOr[Double]
The width of the border surrounding each slice.
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
borderColortonullinstead.In styled mode, the border stroke width is given in the
.highcharts-pointclass.Example: -
val
center: UndefOr[Array[|[String, Double]]]
The center of the pie chart relative to the plot area.
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%"].Example: -
val
className: UndefOr[String]
A class name to apply to the series' graphical elements.
A class name to apply to the series' graphical elements.
- Since
5.0.0
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
colors: UndefOr[Array[|[String, Object]]]
A series specific or series type specific color set to use instead of the global colors.
A series specific or series type specific color set to use instead of the global colors.
- Since
3.0
Example: -
val
cursor: UndefOr[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.
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.
Pointer cursor on line graph, on columns, on scatter markers
Example: - val dataLabels: UndefOr[CleanJsObject[PlotOptionsPieDataLabels]]
-
val
depth: UndefOr[Double]
The thickness of a 3D pie.
The thickness of a 3D pie. Requires
highcharts-3d.js- Since
4.0
Example: -
val
description: UndefOr[String]
Requires Accessibility module
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
- Since
5.0.0
Example: -
val
enableMouseTracking: UndefOr[Boolean]
Enable or disable the mouse tracking for a specific series.
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.
Example: -
val
endAngle: UndefOr[Double]
The end angle of the pie in degrees where 0 is top and 90 is right.
The end angle of the pie in degrees where 0 is top and 90 is right. Defaults to
startAngleplus 360.- Since
1.3.6
Example: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val events: UndefOr[CleanJsObject[PlotOptionsPieEvents]]
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
val
getExtremesFromAll: UndefOr[Boolean]
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.
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.
- Since
4.1.6
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
val
ignoreHiddenPoint: UndefOr[Boolean]
Equivalent to chart.ignoreHiddenSeries, this option tells whether the series shall be redrawn as if the hidden point were
null.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
falsetotruewith Highcharts 3.0.- Since
2.3.0
Example: -
val
innerSize: UndefOr[|[String, Double]]
The size of the inner diameter for the pie.
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.
- Since
2.0
Example: -
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
val
keys: UndefOr[Array[String]]
An array specifying which option maps to which key in the data point array.
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.
- Since
4.1.6
Example: -
val
linkedTo: UndefOr[String]
The id of another series to link to.
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.
- Since
3.0
Example: -
val
minSize: UndefOr[Double]
The minimum size for a pie in response to auto margins.
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.
- Since
3.0
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
point: UndefOr[CleanJsObject[PlotOptionsPiePoint]]
Properties for each single point
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
selected: UndefOr[Boolean]
Whether to select the series initially.
Whether to select the series initially. If
showCheckboxis true, the checkbox next to the series name will be checked for a selected series.- Since
1.2.0
Example: -
val
shadow: UndefOr[|[Boolean, Object]]
Whether to apply a drop shadow to the graph line.
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing
color,offsetX,offsetY,opacityandwidth.Example: -
val
showInLegend: UndefOr[Boolean]
Whether to display this particular series or series type in the legend.
Whether to display this particular series or series type in the legend. Since 2.1, pies are not shown in the legend by default.
Example: -
val
size: UndefOr[|[String, Double]]
The diameter of the pie relative to the plot area.
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%".Example: -
val
slicedOffset: UndefOr[Double]
If a point is sliced, moved out from the center, how many pixels should it be moved?.
If a point is sliced, moved out from the center, how many pixels should it be moved?.
Example: -
val
startAngle: UndefOr[Double]
The start angle of the pie slices in degrees where 0 is top and 90 right.
The start angle of the pie slices in degrees where 0 is top and 90 right.
- Since
2.3.4
Example: -
val
states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]
A wrapper object for all the series options in specific states.
-
val
stickyTracking: UndefOr[Boolean]
Sticky tracking of mouse events.
Sticky tracking of mouse events. When true, the
mouseOutevent on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOutevent on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTrackingis false andtooltip.sharedis false, the tooltip will be hidden when moving the mouse between series. -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
tooltip: UndefOr[CleanJsObject[PlotOptionsPieTooltip]]
A configuration object for the tooltip rendering of each single series.
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.
- Since
2.3
-
def
valueOf(): Any
- Definition Classes
- Object
-
val
visible: UndefOr[Boolean]
Set the initial visibility of the series.
Set the initial visibility of the series.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
zoneAxis: UndefOr[String]
Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
- Since
4.1.0
Example: -
val
zones: UndefOr[Array[CleanJsObject[PlotOptionsPieZones]]]
An array defining zones within a series.
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
zoneAxisoption.In styled mode, the color zones are styled with the
.highcharts-zone-{n}class, or custom classed from theclassNameoption (view live demo).- Since
4.1.0
Example: