Object/Class

com.highcharts.config

SeriesPyramid

Related Docs: class SeriesPyramid | package config

Permalink

object SeriesPyramid

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SeriesPyramid
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def apply(allowPointSelect: UndefOr[Boolean] = js.undefined, animationLimit: UndefOr[Double] = js.undefined, borderColor: UndefOr[|[String, Object]] = js.undefined, borderWidth: UndefOr[Double] = js.undefined, center: UndefOr[Array[|[String, Double]]] = js.undefined, className: UndefOr[String] = js.undefined, colorIndex: UndefOr[Double] = js.undefined, colors: UndefOr[Array[|[String, Object]]] = js.undefined, cursor: UndefOr[String] = js.undefined, data: UndefOr[Array[|[CleanJsObject[SeriesPyramidData], Double]]] = js.undefined, dataLabels: UndefOr[CleanJsObject[SeriesPyramidDataLabels]] = js.undefined, depth: UndefOr[Double] = js.undefined, description: UndefOr[String] = js.undefined, enableMouseTracking: UndefOr[Boolean] = js.undefined, events: UndefOr[CleanJsObject[SeriesPyramidEvents]] = js.undefined, exposeElementToA11y: UndefOr[Boolean] = js.undefined, findNearestPointBy: UndefOr[String] = js.undefined, getExtremesFromAll: UndefOr[Boolean] = js.undefined, height: UndefOr[|[Double, String]] = js.undefined, id: UndefOr[String] = js.undefined, index: UndefOr[Double] = js.undefined, keys: UndefOr[Array[String]] = js.undefined, legendIndex: UndefOr[Double] = js.undefined, linkedTo: UndefOr[String] = js.undefined, minSize: UndefOr[Double] = js.undefined, name: UndefOr[String] = js.undefined, point: UndefOr[CleanJsObject[SeriesPyramidPoint]] = js.undefined, pointDescriptionFormatter: UndefOr[Function] = js.undefined, reversed: UndefOr[Boolean] = js.undefined, selected: UndefOr[Boolean] = js.undefined, shadow: UndefOr[|[Boolean, Object]] = js.undefined, showInLegend: UndefOr[Boolean] = js.undefined, skipKeyboardNavigation: UndefOr[Boolean] = js.undefined, slicedOffset: UndefOr[Double] = js.undefined, states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]] = js.undefined, stickyTracking: UndefOr[Boolean] = js.undefined, tooltip: UndefOr[CleanJsObject[SeriesPyramidTooltip]] = js.undefined, type: String = "pyramid", visible: UndefOr[Boolean] = js.undefined, width: UndefOr[|[Double, String]] = js.undefined, zIndex: UndefOr[Double] = js.undefined, zoneAxis: UndefOr[String] = js.undefined, zones: UndefOr[Array[CleanJsObject[SeriesPyramidZones]]] = js.undefined): SeriesPyramid

    Permalink

    allowPointSelect

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

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

    borderColor

    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.

    borderWidth

    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.

    center

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

    className

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

    colorIndex

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

    colors

    A series specific or series type specific color set to use instead of the global colors.

    cursor

    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.

    data

    An array of data points for the series. For the pyramid 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. Example:.
      data: [0, 5, 3, 5]
      
      - 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: [{.     y: 6,.     name: "Point2",.     color: "#00FF00". }, {.     y: 7,.     name: "Point1",.     color: "#FF00FF". }]
      
    depth

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

    description

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

    enableMouseTracking

    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.

    exposeElementToA11y

    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.

    findNearestPointBy

    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.

    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. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.

    height

    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.

    id

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

    index

    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.

    keys

    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.

    legendIndex

    The sequential index of the series in the legend. Try it: Legend in opposite order .

    linkedTo

    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.

    minSize

    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.

    name

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

    point

    Properties for each single point

    pointDescriptionFormatter

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

    reversed

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

    selected

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

    shadow

    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.

    showInLegend

    Whether to display this particular series or series type in the legend. Since 2.1, pies are not shown in the legend by default.

    skipKeyboardNavigation

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

    slicedOffset

    If a point is sliced, moved out from the center, how many pixels should it be moved?.

    states

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

    stickyTracking

    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.

    tooltip

    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.

    visible

    Set the initial visibility of the series.

    width

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

    zIndex

    Define the visual z index of the series.

    zoneAxis

    Defines the Axis on which the zones are applied.

    zones

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

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped