Trait/Object

io.udash.wrappers.highcharts.config.series.pie

SeriesPie

Related Docs: object SeriesPie | package pie

Permalink

trait SeriesPie extends Object with PieLikeSeries

Annotations
@ScalaJSDefined() @RawJSType()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SeriesPie
  2. PieLikeSeries
  3. StandardSeries
  4. Series
  5. Object
  6. Any
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Data = Array[|[SeriesPieData, Double]]

    Permalink
    Definition Classes
    SeriesPieSeries
  2. type DataLabels = SeriesConnectorDataLabels

    Permalink
    Definition Classes
    SeriesPieSeries
  3. type States = SeriesAreaStates

    Permalink
    Definition Classes
    SeriesPieStandardSeries

Abstract Value Members

  1. abstract val type: String

    Permalink
    Definition Classes
    Series

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val allowPointSelect: UndefOr[Boolean]

    Permalink

    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.

    Definition Classes
    StandardSeries
    Annotations
    @JSOptional()
    Example:
    1. Line, column, pie

  5. val animation: UndefOr[|[Boolean, Object]]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  6. val animationLimit: UndefOr[Double]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val borderColor: UndefOr[|[String, Object]]

    Permalink

    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.

    Definition Classes
    PieLikeSeries
    Annotations
    @JSOptional()
    Example:
    1. Black border

  9. val borderWidth: UndefOr[Double]

    Permalink

    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.

    Definition Classes
    PieLikeSeries
    Annotations
    @JSOptional()
    Example:
    1. 3px border

  10. val center: UndefOr[Array[|[String, Double]]]

    Permalink

    The center of the series.

    The center of the series. By default, it is centered in the middle of the plot area, so it fills the plot area height.

    Definition Classes
    PieLikeSeries
    Annotations
    @JSOptional()
  11. val className: UndefOr[String]

    Permalink

    A class name to apply to the series' graphical elements.

    A class name to apply to the series' graphical elements.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. val color: UndefOr[|[String, Object]]

    Permalink

    The main color or the series.

    The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  14. val colors: UndefOr[Array[|[String, Object]]]

    Permalink

    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.

    Definition Classes
    PieLikeSeries
    Annotations
    @JSOptional()
  15. val cursor: UndefOr[String]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
    Example:
    1. Pointer cursor on line graph, on columns, on scatter markers

  16. val data: UndefOr[Data]

    Permalink

    An array of data points for the series.

    An array of data points for the series. For the area series type, points can be given in the following ways:

    • An array of numerical values. In this case, the numerical values will be interpreted as y options. The x values will be automatically calculated, either starting at 0 and incremented by 1, or from pointStart and pointInterval given in the series options. If the axis has categories, these will be used. Example:
      data: [0, 5, 3, 5]
      

    -

    An array of arrays with 2 values. In this case, the values correspond to x,y. If the first value is a string, it is applied as the name of the point, and the x value is inferred.

    data: [
    [0, 9],
    [1, 7],
    [2, 6]
    ]
    

    -

    An array of objects with named values. The objects are point configuration objects as seen below. If the total number of data points exceeds the series' turboThreshold, this option is not available.

    data: [{
    x: 1,
    y: 9,
    name: "Point2",
    color: "#00FF00"
    }, {
    x: 1,
    y: 6,
    name: "Point1",
    color: "#FF00FF"
    }]
    

    Definition Classes
    Series
    Annotations
    @JSOptional()
    Example:
    1. The demos use a line series, but the principle is the same for all types.

  17. val dataLabels: UndefOr[DataLabels]

    Permalink

    Options for the series data labels, appearing next to each data point.

    Options for the series data labels, appearing next to each data point.

    In styled mode, the data labels can be styled wtih the .highcharts-data-label-box and .highcharts-data-label class names (see example).

    Definition Classes
    Series
    Annotations
    @JSOptional()
  18. val depth: UndefOr[Double]

    Permalink

    The thickness of a 3D pie.

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

    Definition Classes
    PieLikeSeries
    Annotations
    @JSOptional()
  19. val description: UndefOr[String]

    Permalink

    Requires Accessibility module

    Requires Accessibility module

    A description of the series to add to the screen reader information about the series.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  20. val enableMouseTracking: UndefOr[Boolean]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  21. val endAngle: UndefOr[Double]

    Permalink

    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.

    Annotations
    @JSOptional()
  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  24. val events: UndefOr[SeriesEvents]

    Permalink
    Definition Classes
    Series
    Annotations
    @JSOptional()
  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  27. val getExtremesFromAll: UndefOr[Boolean]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  28. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. val id: UndefOr[String]

    Permalink

    An id for the series.

    An id for the series. This can be used after render time to get a pointer to the series object through chart.get().

    Definition Classes
    Series
    Annotations
    @JSOptional()
  31. val ignoreHiddenPoint: UndefOr[Boolean]

    Permalink

    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.

    Annotations
    @JSOptional()
  32. val index: UndefOr[Double]

    Permalink

    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.

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  33. val innerSize: UndefOr[|[String, Double]]

    Permalink

    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.

    Annotations
    @JSOptional()
  34. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  35. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  36. val keys: UndefOr[Array[String]]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  37. val legendIndex: UndefOr[Double]

    Permalink

    The sequential index of the series in the legend.

    The sequential index of the series in the legend.

    Try it:

    Legend in opposite order .

    Definition Classes
    Series
    Annotations
    @JSOptional()
  38. val linkedTo: UndefOr[String]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
    Example:
    1. Linked series

  39. val minSize: UndefOr[Double]

    Permalink

    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.

    Definition Classes
    PieLikeSeries
    Annotations
    @JSOptional()
  40. val name: UndefOr[String]

    Permalink

    The name of the series as shown in the legend, tooltip etc.

    The name of the series as shown in the legend, tooltip etc.

    Definition Classes
    Series
    Annotations
    @JSOptional()
    Example:
    1. Series name

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

    Permalink
    Definition Classes
    AnyRef
  42. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  43. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  44. val point: UndefOr[SeriesPoint]

    Permalink

    Properties for each single point

    Properties for each single point

    Definition Classes
    Series
    Annotations
    @JSOptional()
  45. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  46. val selected: UndefOr[Boolean]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  47. val shadow: UndefOr[|[Boolean, Object]]

    Permalink

    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.

    Definition Classes
    StandardSeries
    Annotations
    @JSOptional()
    Example:
    1. Shadow enabled

  48. val showCheckbox: UndefOr[Boolean]

    Permalink

    If true, a checkbox is displayed next to the legend item to allow selecting the series.

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
    Example:
    1. Show select box

  49. val showInLegend: UndefOr[Boolean]

    Permalink

    Whether to display this particular series or series type in the legend.

    Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  50. val size: UndefOr[|[String, Double]]

    Permalink

    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%".

    Annotations
    @JSOptional()
    Example:
    1. Smaller pie

  51. val slicedOffset: UndefOr[Double]

    Permalink

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

    Definition Classes
    PieLikeSeries
    Annotations
    @JSOptional()
    Example:
    1. 20px offset

  52. val startAngle: UndefOr[Double]

    Permalink

    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.

    Annotations
    @JSOptional()
  53. val states: UndefOr[States]

    Permalink

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

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

    Definition Classes
    StandardSeries
    Annotations
    @JSOptional()
  54. val stickyTracking: UndefOr[Boolean]

    Permalink

    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. Defaults to true for line and area type series, but to false for columns, pies etc.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  55. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  56. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  57. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  58. val tooltip: UndefOr[SeriesTooltip]

    Permalink

    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.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  59. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  60. val visible: UndefOr[Boolean]

    Permalink

    Set the initial visibility of the series.

    Set the initial visibility of the series.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  61. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. val zIndex: UndefOr[Int]

    Permalink

    Define the visual z index of the series.

    Define the visual z index of the series.

    Definition Classes
    Series
    Annotations
    @JSOptional()
  65. val zoneAxis: UndefOr[String]

    Permalink

    Defines the Axis on which the zones are applied.

    Defines the Axis on which the zones are applied.

    Definition Classes
    StandardSeries
    Annotations
    @JSOptional()
  66. val zones: UndefOr[Array[SeriesZone]]

    Permalink

    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.

    Definition Classes
    StandardSeries
    Annotations
    @JSOptional()
    Example:
    1. Color zones

Inherited from PieLikeSeries

Inherited from StandardSeries

Inherited from Series

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped