Packages

class PlotOptionsPyramid extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: plotOptions-pyramid

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlotOptionsPyramid
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PlotOptionsPyramid()

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

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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.

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

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

    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.

    Since

    3.0

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

  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. 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

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

  14. val dataLabels: UndefOr[CleanJsObject[PlotOptionsPyramidDataLabels]]
  15. 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

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

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

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. val events: UndefOr[CleanJsObject[PlotOptionsPyramidEvents]]
  21. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  23. 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

  24. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  26. val height: UndefOr[|[Double, String]]

    The height of the funnel or pyramid.

    The height of the funnel or pyramid. If it is a number it defines the pixel height, if it is a percentage string it is the percentage of the plot area height.

    Example:

    1. Funnel demo

    Since

    3.0

  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  29. 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

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

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

  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  35. val point: UndefOr[CleanJsObject[PlotOptionsPyramidPoint]]

    Properties for each single point

  36. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  37. val reversed: UndefOr[Boolean]

    The pyramid is reversed by default, as opposed to the funnel, which shares the layout engine, and is not reversed.

    The pyramid is reversed by default, as opposed to the funnel, which shares the layout engine, and is not reversed.

    Since

    3.0.10

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

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

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

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

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

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

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

  44. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  45. def toLocaleString(): String
    Definition Classes
    Object
  46. def toString(): String
    Definition Classes
    AnyRef → Any
  47. val tooltip: UndefOr[CleanJsObject[PlotOptionsPyramidTooltip]]

    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

  48. def valueOf(): Any
    Definition Classes
    Object
  49. 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

  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. val width: UndefOr[|[Double, String]]

    The width of the funnel compared to the width of the plot area, or the pixel width if it is a number.

    The width of the funnel compared to the width of the plot area, or the pixel width if it is a number.

    Since

    3.0

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

  55. val zones: UndefOr[Array[CleanJsObject[PlotOptionsPyramidZones]]]

    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

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped