PlotOptionsSpline

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: 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: 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, easing "easeOutBounce" through jQuery UI.

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. val color: String

   

   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.

   Example:

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

9. val connectEnds: Boolean

   

   Polar charts only.

   Polar charts only. Whether to connect the ends of a line series plot across the extremes.

   Example:

   1. Do not connect

   Since

   2.3.0

10. val connectNulls: 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

11. val cropThreshold: Double

    

    When the series contains less points than the crop threshold, all points are drawn, event 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, event 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

12. val cursor: 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

13. val dashStyle: 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

14. val dataLabels: PlotOptionsSplineDataLabels

    

15. val enableMouseTracking: 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

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

    

    Definition Classes

    AnyRef

17. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

18. val events: PlotOptionsSplineEvents

    

19. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

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

    

    Definition Classes

    AnyRef → Any

21. val getExtremesFromAll: 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

22. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

23. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

24. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

25. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

26. val keys: 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

27. val lineWidth: Double

    

    Pixel with of the graph line.

    Pixel with of the graph line.

    Example:

    1. 5px on all series, on one single series

28. val linecap: String

    

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

29. val linkedTo: 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

30. val marker: PlotOptionsSplineMarker

    

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

    

    Definition Classes

    AnyRef

32. val negativeColor: String

    

    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

33. final def notify(): Unit

    

    Definition Classes

    AnyRef

34. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

35. val point: PlotOptionsSplinePoint

    

    Properties for each single point

36. val pointInterval: 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

37. val pointIntervalUnit: String

    

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

    On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year. Combine it with pointInterval to draw quarters, 6 months, 10 years etc.

    Example:

    1. One point a month

    Since

    4.1.0

38. val pointPlacement: Any

    

    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

39. val pointStart: 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

40. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

41. val selected: 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

42. val shadow: Any

    

    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

43. val showCheckbox: 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

44. val showInLegend: 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

45. val softThreshold: Boolean

    

    When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.

    When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.

    For example, if softThreshold is false, a series of 0, 1, 2, 3 will make the Y axis show negative values according to the minPadding option. If softThreshold is true, the Y axis starts at 0.

    Since

    4.1.9

46. val stacking: String

    

    Whether to stack the values of each series on top of each other.

    Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".

    Example:

    1. Line, column, bar, area with "normal" stacking. Line, column, bar, area with "percent" stacking.

47. val states: PlotOptionsSeriesStates

    

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

48. val stickyTracking: 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

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

    

    Definition Classes

    AnyRef

50. val threshold: Double

    

    The threshold, also called zero level or base level.

    The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.

    Since

    3.0

51. def toLocaleString(): String

    

    Definition Classes

    Object

52. def toString(): String

    

    Definition Classes

    AnyRef → Any

53. val tooltip: Object

    

    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

54. val turboThreshold: 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

55. def valueOf(): Any

    

    Definition Classes

    Object

56. val visible: Boolean

    

    Set the initial visibility of the series.

    Set the initial visibility of the series.

    Example:

    1. Two series, one hidden and one visible

57. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

58. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

59. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

60. val zoneAxis: 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

61. val zones: Array[PlotOptionsSplineZones]

    

    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.

    Example:

    1. Color zones

    Since

    4.1.0