Packages

class PlotOptionsArearange extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: plotOptions-arearange

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

Instance Constructors

  1. new PlotOptionsArearange()

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 animation: UndefOr[Boolean]

    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.

    Example:

    1. Animation disabled, slower animation, custom easing function.

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

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

  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val color: UndefOr[|[String, Object]]

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

    Example:

    1. General plot option, one specific series, area color

  11. val connectNulls: UndefOr[Boolean]

    Whether to connect a graph line across null points.

    Whether to connect a graph line across null points.

    Example:

    1. False by default, true

  12. val cropThreshold: UndefOr[Double]

    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

  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 dashStyle: UndefOr[String]

    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
    Example:

    1. Possible values demonstrated, chart suitable for printing in black and white

    Since

    2.1

  15. val dataLabels: UndefOr[CleanJsObject[PlotOptionsArearangeDataLabels]]

    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

  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[PlotOptionsArearangeEvents]]
  21. val fillColor: UndefOr[|[String, Object]]

    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.

    Example:

    1. Null by default, gradient

  22. val fillOpacity: UndefOr[Double]

    Fill opacity for the area.

    Fill opacity for the area. Note that 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.

    Example:

    1. Automatic fill color and fill opacity of 0.1

  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  25. 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

  26. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  30. 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

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

    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

  32. val lineWidth: UndefOr[Double]

    Pixel width of the arearange graph line.

    Pixel width of the arearange graph line.

    Since

    2.3.0

  33. val linecap: UndefOr[String]

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

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

  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. val negativeColor: UndefOr[|[String, Object]]

    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.

    Example:

    1. Spline, area and column - arearange.

    Since

    3.0

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

    A separate color for the negative part of the area.

    A separate color for the negative part of the area.

    Since

    3.0

  38. final def notify(): Unit
    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  40. val point: UndefOr[CleanJsObject[PlotOptionsArearangePoint]]

    Properties for each single point

  41. val pointInterval: UndefOr[Double]

    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

  42. val pointIntervalUnit: UndefOr[String]

    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.

    Example:

    1. One point a month

    Since

    4.1.0

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

    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.

    Example:

    1. Between in a column chart, numeric placement for custom layout.

    Since

    2.3.0

  44. val pointStart: UndefOr[Double]

    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

  45. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  46. 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

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

  48. val showCheckbox: UndefOr[Boolean]

    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

  49. 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. The default value is true for standalone series, false for linked series.

    Example:

    1. One series in the legend, one hidden

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

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

  51. val step: UndefOr[String]

    Whether to apply steps to the line.

    Whether to apply steps to the line. Possible values are left, center and right. Prior to 2.3.5, only left was supported.

    Example:

    1. Different step line options

    Since

    1.2.5

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

    Example:

    1. True by default, false

    Since

    2.0

  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. def toLocaleString(): String
    Definition Classes
    Object
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. val tooltip: UndefOr[CleanJsObject[PlotOptionsArearangeTooltip]]

    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

  57. val trackByArea: UndefOr[Boolean]

    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

  58. val turboThreshold: UndefOr[Double]

    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

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

  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. 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

  65. val zones: UndefOr[Array[CleanJsObject[PlotOptionsArearangeZones]]]

    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