PlotOptionsPie

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. val allowPointSelect: UndefOr[Boolean]

   

   Allow this series' points to be selected by clicking on the markers, bars or pie slices.

   Allow this series' points to be selected by clicking on the markers, bars or pie slices.

   Example:

   1. Line, column, pie

   Since

   1.2.0

5. 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 Math object. See the easing demo.

   </dl>

   Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.

   Example:

   1. Animation disabled, slower animation, custom easing function.

6. 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 animationLimit to Infinity.

7. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

8. 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 a borderWidth to fill drawing gaps created by antialiazing artefacts in borderless pies.

   In styled mode, the border stroke is given in the .highcharts-point class.

   Example:

   1. Black border. Styled mode.

9. 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 borderColor to null instead.

   In styled mode, the border stroke width is given in the .highcharts-point class.

   Example:

   1. 3px border. Styled mode.

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

    1. Centered at 100, 100

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

12. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

13. val colorIndex: UndefOr[Double]

    

    Styled mode only.

    Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.

    Since

    5.0.0

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

    Example:

    1. Set default colors for all pies

    Since

    3.0

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

    Example:

    1. Pointer cursor on line graph, on columns, on scatter markers

16. val dataLabels: UndefOr[CleanJsObject[PlotOptionsPieDataLabels]]

    

17. val depth: UndefOr[Double]

    

    The thickness of a 3D pie.

    The thickness of a 3D pie. Requires highcharts-3d.js

    Example:

    1. Basic 3D pie chart

    Since

    4.0

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

    Example:

    1. Accessible stock chart

    Since

    5.0.0

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

    1. No mouse tracking

20. 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 startAngle plus 360.

    Example:

    1. Semi-circle donut

    Since

    1.3.6

21. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

22. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

23. val events: UndefOr[CleanJsObject[PlotOptionsPieEvents]]

    

24. val exposeElementToA11y: UndefOr[Boolean]

    

    By default, series are exposed to screen readers as regions.

    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.

    Example:

    1. Accessible data visualization

    Since

    5.0.12

25. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

26. val findNearestPointBy: UndefOr[String]

    

    Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.

    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.

    Example:

    1. Different hover behaviors

    Since

    5.0.10

27. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

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

29. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

30. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

31. 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 false to true with Highcharts 3.0.

    Example:

    1. True, the hiddden point is ignored

    Since

    2.3.0

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

    Example:

    1. 80px inner size, 50% of the plot area, 3D donut.

    Since

    2.0

33. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

34. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

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

    Example:

    1. An extended data array with keys

    Since

    4.1.6

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

    Example:

    1. Linked series

    Since

    3.0

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

38. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

39. final def notify(): Unit

    

    Definition Classes

    AnyRef

40. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

41. val point: UndefOr[CleanJsObject[PlotOptionsPiePoint]]

    

    Properties for each single point

42. val pointDescriptionFormatter: UndefOr[Function]

    

    Same as accessibility.pointDescriptionFormatter, but for an individual series.

    Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.

    Since

    5.0.12

43. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

44. val selected: UndefOr[Boolean]

    

    Whether to select the series initially.

    Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.

    Example:

    1. One out of two series selected

    Since

    1.2.0

45. 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, opacity and width.

    Example:

    1. Shadow enabled

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

    1. One series in the legend, one hidden

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

    1. Smaller pie

48. val skipKeyboardNavigation: UndefOr[Boolean]

    

    If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

    If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

    Since

    5.0.12

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

    1. 20px offset

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

    Example:

    1. Start from right

    Since

    2.3.4

51. val states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]

    

    A wrapper object for all the series options in specific states.

52. val stickyTracking: UndefOr[Boolean]

    

    Sticky tracking of mouse events.

    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.

53. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

54. def toLocaleString(): String

    

    Definition Classes

    Object

55. def toString(): String

    

    Definition Classes

    AnyRef → Any

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

57. def valueOf(): Any

    

    Definition Classes

    Object

58. val visible: UndefOr[Boolean]

    

    Set the initial visibility of the series.

    Set the initial visibility of the series.

    Example:

    1. Two series, one hidden and one visible

59. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

60. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

61. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

62. val zoneAxis: UndefOr[String]

    

    Defines the Axis on which the zones are applied.

    Defines the Axis on which the zones are applied.

    Example:

    1. Zones on the X-Axis

    Since

    4.1.0

63. 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 zoneAxis option.

    In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).

    Example:

    1. Color zones

    Since

    4.1.0