Class/Object

com.highcharts.config

SeriesAreasplinerange

Related Docs: object SeriesAreasplinerange | package config

Permalink

class SeriesAreasplinerange extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: series<areasplinerange>

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

Instance Constructors

  1. new SeriesAreasplinerange()

    Permalink

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.

    Example:
    1. Line, column, pie

    Since

    1.2.0

  5. val animation: UndefOr[Boolean]

    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.

  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.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. 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.

    Since

    5.0.0

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. 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.

    In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the .highcharts-series, .highcharts-color-{n}, .highcharts-{type}-series or .highcharts-series-{n} class, or individual classes given by the className option.

  11. val colorIndex: UndefOr[Double]

    Permalink

    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

  12. val connectNulls: UndefOr[Boolean]

    Permalink

    Whether to connect a graph line across null points.

    Whether to connect a graph line across null points.

  13. val cropThreshold: UndefOr[Double]

    Permalink

    When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom.

    When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.

    Since

    2.2

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

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

  15. val dashStyle: UndefOr[String]

    Permalink

    A name for the dash style to use for the graph.

    A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline, area and scatter in case it has a lineWidth. The value for the dashStyle include:

    • Solid
    • ShortDash
    • ShortDot
    • ShortDashDot
    • ShortDashDotDot
    • Dot
    • Dash
    • LongDash
    • DashDot
    • LongDashDot
    • LongDashDotDot
    Since

    2.1

  16. val data: UndefOr[Array[|[CleanJsObject[SeriesAreasplinerangeData], Array[Any]]]]

    Permalink

    An array of data points for the series.

    An array of data points for the series. For the areasplinerange 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, 0, 5],
        [1, 9, 1],
        [2, 5, 2]
    ]
    

    -

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

    Example:
    1. The demos use a line series, but the principle is the same for all types.

  17. val dataLabels: UndefOr[CleanJsObject[SeriesAreasplinerangeDataLabels]]

    Permalink

    Extended data labels for range series types.

    Extended data labels for range series types. Range series data labels have no x and y options. Instead, they have xLow, xHigh, yLow and yHigh options to allow the higher and lower data label sets individually.

    Since

    2.3.0

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

    Since

    5.0.0

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  22. val events: UndefOr[CleanJsObject[SeriesAreasplinerangeEvents]]

    Permalink
  23. val exposeElementToA11y: UndefOr[Boolean]

    Permalink

    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.

    Since

    5.0.12

  24. val fillColor: UndefOr[|[String, Object]]

    Permalink

    Fill color or gradient for the area.

    Fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.

  25. val fillOpacity: UndefOr[Double]

    Permalink

    Fill opacity for the area.

    Fill opacity for the area. When you set an explicit fillColor, the fillOpacity is not applied. Instead, you should define the opacity in the fillColor with an rgba color definition. The fillOpacity setting, also the default setting, overrides the alpha component of the color setting.

  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. val findNearestPointBy: UndefOr[String]

    Permalink

    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.

    Since

    5.0.10

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

    Permalink
    Definition Classes
    AnyRef → Any
  29. 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.

    Since

    4.1.6

  30. def hasOwnProperty(v: String): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  32. 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().

    Since

    1.2.0

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

    Since

    2.3.0

  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.

    Since

    4.1.6

  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 .

  38. val lineColor: UndefOr[|[String, Object]]

    Permalink

    A separate color for the graph line.

    A separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor.

    Example:
    1. Dark gray line

  39. val lineWidth: UndefOr[Double]

    Permalink

    Pixel width of the arearange graph line.

    Pixel width of the arearange graph line.

    Since

    2.3.0

  40. val linecap: UndefOr[String]

    Permalink

    The line cap used for line ends and line joins on the graph.

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

    Example:
    1. Linked series

    Since

    3.0

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

    Example:
    1. Series name

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

    Permalink
    Definition Classes
    AnyRef
  44. val negativeColor: UndefOr[|[String, Object]]

    Permalink

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

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

    Since

    3.0

  45. val negativeFillColor: UndefOr[|[String, Object]]

    Permalink

    A separate color for the negative part of the area.

    A separate color for the negative part of the area.

    Since

    3.0

  46. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  48. val point: UndefOr[CleanJsObject[SeriesAreasplinerangePoint]]

    Permalink

    Properties for each single point

  49. val pointDescriptionFormatter: UndefOr[Function]

    Permalink

    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

  50. val pointInterval: UndefOr[Double]

    Permalink

    If no x values are given for the points in a series, pointInterval defines the interval of the x values.

    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.

    Example:
    1. Datetime X axis

  51. val pointIntervalUnit: UndefOr[String]

    Permalink

    On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year.

    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.

    Since

    4.1.0

  52. val pointPlacement: UndefOr[|[String, Double]]

    Permalink

    Possible values: null, "on", "between".

    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.

    Since

    2.3.0

  53. val pointStart: UndefOr[Double]

    Permalink

    If no x values are given for the points in a series, pointStart defines on what value to start.

    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.

    Example:
    1. Linear, datetime X axis

  54. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  55. 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.

    Since

    1.2.0

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

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

    Example:
    1. Show select box

    Since

    1.2.0

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

  59. val skipKeyboardNavigation: UndefOr[Boolean]

    Permalink

    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

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

    Permalink

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

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

    Since

    2.0

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  65. val tooltip: UndefOr[CleanJsObject[SeriesAreasplinerangeTooltip]]

    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.

    Since

    2.3

  66. val trackByArea: UndefOr[Boolean]

    Permalink

    Whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.

    Whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.

    Since

    2.3.0

  67. val turboThreshold: UndefOr[Double]

    Permalink

    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.

    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.

    Since

    2.2

  68. val type: String

    Permalink

    The type of series.

    The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.

  69. def valueOf(): Any

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

    Permalink

    Set the initial visibility of the series.

    Set the initial visibility of the series.

  71. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. val xAxis: UndefOr[|[Double, String]]

    Permalink

    When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.

    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.

  75. val yAxis: UndefOr[|[Double, String]]

    Permalink

    When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.

    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.

  76. val zIndex: UndefOr[Double]

    Permalink

    Define the visual z index of the series.

  77. val zoneAxis: UndefOr[String]

    Permalink

    Defines the Axis on which the zones are applied.

    Defines the Axis on which the zones are applied.

    Since

    4.1.0

  78. val zones: UndefOr[Array[CleanJsObject[SeriesAreasplinerangeZones]]]

    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.

    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