Packages

trait Series extends Object

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Series
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Data
  2. abstract type DataLabels <: BaseSeriesDataLabels

Abstract Value Members

  1. abstract val type: String

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

    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.

    Annotations
    @JSOptional()
    Example:

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

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

    Annotations
    @JSOptional()
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val className: UndefOr[String]

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

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

    Annotations
    @JSOptional()
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. 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.

    Annotations
    @JSOptional()
    Example:

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

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

    Annotations
    @JSOptional()
    Example:

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

  11. val data: UndefOr[Data]

    An array of data points for the series.

    An array of data points for the series. For the area 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. The x values will be automatically calculated, either starting at 0 and incremented by 1, or from pointStart and pointInterval given in the series options. If the axis has categories, these will be used. Example: 
      data: [0, 5, 3, 5]

    -

    An array of arrays with 2 values. In this case, the values correspond to x,y. If the first value is a string, it is applied as the name of the point, and the x value is inferred. 

    data: [
[0, 9],
[1, 7],
[2, 6]
]

    -

    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,
y: 9,
name: "Point2",
color: "#00FF00"
}, {
x: 1,
y: 6,
name: "Point1",
color: "#FF00FF"
}]

    Annotations
    @JSOptional()
    Example:

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

  12. val dataLabels: UndefOr[DataLabels]

    Options for the series data labels, appearing next to each data point.

    Options for the series data labels, appearing next to each data point.

    In styled mode, the data labels can be styled wtih the .highcharts-data-label-box and .highcharts-data-label class names (see example).

    Annotations
    @JSOptional()
  13. 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.

    Annotations
    @JSOptional()
    Example:

    1. Accessible stock chart

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

    Annotations
    @JSOptional()
    Example:

    1. No mouse tracking

  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. val events: UndefOr[SeriesEvents]
    Annotations
    @JSOptional()
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. 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.

    Annotations
    @JSOptional()
  21. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. val id: UndefOr[String]

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

    Annotations
    @JSOptional()
    Example:

    1. Get series by id

  24. val index: UndefOr[Double]

    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.

    Annotations
    @JSOptional()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  27. 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.

    Annotations
    @JSOptional()
    Example:

    1. An extended data array with keys

  28. val legendIndex: UndefOr[Double]

    The sequential index of the series in the legend.

    The sequential index of the series in the legend.

    Try it:

    Legend in opposite order .

    Annotations
    @JSOptional()
  29. 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.

    Annotations
    @JSOptional()
    Example:

    1. Linked series

  30. val name: UndefOr[String]

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

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

    Annotations
    @JSOptional()
    Example:

    1. Series name

  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. val point: UndefOr[SeriesPoint]

    Properties for each single point

    Properties for each single point

    Annotations
    @JSOptional()
  35. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  36. 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.

    Annotations
    @JSOptional()
    Example:

    1. One out of two series selected

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

    Annotations
    @JSOptional()
    Example:

    1. Show select box

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

    Annotations
    @JSOptional()
    Example:

    1. One series in the legend, one hidden

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

    Annotations
    @JSOptional()
    Example:

    1. True by default, false

  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toLocaleString(): String
    Definition Classes
    Object
  42. def toString(): String
    Definition Classes
    AnyRef → Any
  43. val tooltip: UndefOr[SeriesTooltip]

    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.

    Annotations
    @JSOptional()
  44. def valueOf(): Any
    Definition Classes
    Object
  45. val visible: UndefOr[Boolean]

    Set the initial visibility of the series.

    Set the initial visibility of the series.

    Annotations
    @JSOptional()
    Example:

    1. Two series, one hidden and one visible

  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  49. val zIndex: UndefOr[Int]

    Define the visual z index of the series.

    Define the visual z index of the series.

    Annotations
    @JSOptional()
    Example:

    1. With no z index, the series defined last are on top, with a z index, the series with the highest z index is on top.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped