Packages

object SeriesErrorbar

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

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. def apply(allowPointSelect: UndefOr[Boolean] = js.undefined, animationLimit: UndefOr[Double] = js.undefined, className: UndefOr[String] = js.undefined, color: UndefOr[|[String, Object]] = js.undefined, colorByPoint: UndefOr[Boolean] = js.undefined, colors: UndefOr[Array[|[String, Object]]] = js.undefined, cursor: UndefOr[String] = js.undefined, data: UndefOr[Array[|[CleanJsObject[SeriesErrorbarData], Array[Any]]]] = js.undefined, depth: UndefOr[Double] = js.undefined, description: UndefOr[String] = js.undefined, edgeColor: UndefOr[|[String, Object]] = js.undefined, edgeWidth: UndefOr[Double] = js.undefined, enableMouseTracking: UndefOr[Boolean] = js.undefined, events: UndefOr[CleanJsObject[SeriesErrorbarEvents]] = js.undefined, getExtremesFromAll: UndefOr[Boolean] = js.undefined, groupZPadding: UndefOr[Double] = js.undefined, id: UndefOr[String] = js.undefined, index: UndefOr[Double] = js.undefined, keys: UndefOr[Array[String]] = js.undefined, legendIndex: UndefOr[Double] = js.undefined, lineWidth: UndefOr[Double] = js.undefined, linkedTo: UndefOr[String] = js.undefined, maxPointWidth: UndefOr[Double] = js.undefined, name: UndefOr[String] = js.undefined, negativeColor: UndefOr[|[String, Object]] = js.undefined, point: UndefOr[CleanJsObject[SeriesErrorbarPoint]] = js.undefined, pointInterval: UndefOr[Double] = js.undefined, pointIntervalUnit: UndefOr[String] = js.undefined, pointPadding: UndefOr[Double] = js.undefined, pointPlacement: UndefOr[|[String, Double]] = js.undefined, pointRange: UndefOr[Double] = js.undefined, pointStart: UndefOr[Double] = js.undefined, pointWidth: UndefOr[Double] = js.undefined, selected: UndefOr[Boolean] = js.undefined, states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]] = js.undefined, stemColor: UndefOr[|[String, Object]] = js.undefined, stemDashStyle: UndefOr[String] = js.undefined, stemWidth: UndefOr[Double] = js.undefined, stickyTracking: UndefOr[Boolean] = js.undefined, tooltip: UndefOr[CleanJsObject[SeriesErrorbarTooltip]] = js.undefined, turboThreshold: UndefOr[Double] = js.undefined, type: String = "errorbar", visible: UndefOr[Boolean] = js.undefined, whiskerColor: UndefOr[|[String, Object]] = js.undefined, whiskerLength: UndefOr[|[Double, String]] = js.undefined, whiskerWidth: UndefOr[Double] = js.undefined, xAxis: UndefOr[|[Double, String]] = js.undefined, yAxis: UndefOr[|[Double, String]] = js.undefined, zIndex: UndefOr[Double] = js.undefined, zoneAxis: UndefOr[String] = js.undefined, zones: UndefOr[Array[CleanJsObject[SeriesErrorbarZones]]] = js.undefined): SeriesErrorbar

    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.

    className

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

    color

    The main color of the bars. This can be overridden by stemColor and whiskerColor individually.

    colorByPoint

    When using automatic point colors pulled from the options.colors. collection, this option determines whether the chart should receive . one color per series or one color per point.

    colors

    A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.

    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 errorbar series type, points can be given in the following ways:. . - An array of arrays with 3 or 2 values. In this case, the values correspond to x,low,high. If the first value is a string, it is. applied as the name of the point, and the x value is inferred. The x value can also be omitted, in which case the inner arrays should be of length 2. Then the x value is automatically calculated, either starting at 0 and incremented by 1, or from pointStart . and pointInterval given in the series options.. 

    data: [.     [0, 10, 2], .     [1, 1, 8], .     [2, 4, 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: [{.     x: 1,.     low: 0,.     high: 0,.     name: "Point2",.     color: "#00FF00". }, {.     x: 1,.     low: 5,.     high: 5,.     name: "Point1",.     color: "#FF00FF". }]

    depth

    Depth of the columns in a 3D column chart. Requires highcharts-3d.js.

    description

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

    edgeColor

    3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.

    edgeWidth

    3D columns only. The width of the colored edges.

    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.

    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.

    groupZPadding

    The spacing between columns on the Z Axis in a 3D chart. Requires highcharts-3d.js.

    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 .

    lineWidth

    The width of the line surrounding the box. If any of stemWidth, medianWidth or whiskerWidth are null, the lineWidth also applies to these lines.

    linkedTo

    The parent series of the error bar. The default value links it to the previous series. Otherwise, use the id of the parent series.

    maxPointWidth

    The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.

    name

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

    negativeColor

    The color for the parts of the graph or points that are below the threshold.

    point

    Properties for each single point

    pointInterval

    If no x values are given for the points in a series, pointInterval defines. the interval of the x values. For example, if a series contains one value. every decade starting from year 0, set pointInterval to 10.. Since Highcharts 4.1, it can be combined with pointIntervalUnit to draw irregular intervals.

    pointIntervalUnit

    On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this option with pointInterval to draw weeks, quarters, 6 months, 10 years etc.

    pointPadding

    Padding between each column or bar, in x axis units.

    pointPlacement

    Possible values: null, "on", "between".. In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.. Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.. Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.. Defaults to null in cartesian charts, "between" in polar charts.

    pointRange

    The X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.

    pointStart

    If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.

    pointWidth

    A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.

    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.

    states

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

    stemColor

    The color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is used.

    stemDashStyle

    The dash style of the stem, the vertical line extending from the box to the whiskers.

    stemWidth

    The width of the stem, the vertical line extending from the box to the whiskers. If null, the width is inherited from the lineWidth option.

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

    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.

    turboThreshold

    When a series contains a data array that is longer than this, only one dimensional arrays of numbers,. or two dimensional arrays with x and y values are allowed. Also, only the first. point is tested, and the rest are assumed to be the same format. This saves expensive. data checking and indexing in long series. Set it to 0 disable.

    visible

    Set the initial visibility of the series.

    whiskerColor

    The color of the whiskers, the horizontal lines marking low and high values. When null, the general series color is used.

    whiskerLength

    The length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set 0 to disable whiskers.

    whiskerWidth

    The line width of the whiskers, the horizontal lines marking low and high values. When null, the general lineWidth applies.

    xAxis

    When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.

    yAxis

    When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.

    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
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped