Series

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 addPoint(options: Object = ???, redraw: Boolean = ???, shift: Boolean = ???, animation: Any = ???): Unit

   

   Add a point to the series after render time.

   Add a point to the series after render time. The point can be added at the end, or by giving it an X value, to the start or in the middle of the series.

   shift

   Defaults to false. When shift is true, one point is shifted off the start of the series as one is appended to the end. Use this option for live charts monitoring a value over time.

   animation

   Defaults to true. When true, the graph will be animated with default animation options. The animation can also be a configuration object with properties duration and easing.

   Example:

   1. Append 100 points,append and shift

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. val chart: CleanJsObject[Chart]

   

   Read only.

   Read only. The chart that the series belongs to.

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. val data: Array[CleanJsObject[Point]]

   

   Read only.

   Read only. An array with the series' data point objects. In case the series data length exceeds the cropThreshold, or if the data is grouped, series.data doesn't contain all the points. It only contains the points that have been created on demand. In these cases, all original X and Y values can be read from series.xData and series.yData. Additionally, series.options.data contains all configuration objects for the points, whether they be numbers, arrays or objects.

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

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnyRef → Any

13. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

14. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

15. def hide(): Unit

    

    Hides the series if visible.

    Hides the series if visible. If the chart.ignoreHiddenSeries option is true, the chart is redrawn without this series.

    Example:

    1. Toggle visibility from a button

16. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

17. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

18. val name: String

    

    The series' name as given in the options.

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

    

    Definition Classes

    AnyRef

20. final def notify(): Unit

    

    Definition Classes

    AnyRef

21. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

22. val options: Object

    

    Read only.

    Read only. The series' options.

23. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

24. def remove(redraw: Boolean = ???): Unit

    

    Remove the series from the chart.

    Remove the series from the chart.

    redraw

    Defaults to true. Whether to redraw the chart after the series is removed.If doing more operations on the chart, it is a good idea to set redraw to false and call chart.redraw() after.

    Example:

    1. Remove first series from a button

25. def removePoint(index: Object = ???, redraw: Boolean = ???, animation: Any = ???): Unit

    

    Remove a point from the series.

    Remove a point from the series. Unlike the Point.remove method, this can also be done on a point that is not instanciated because it is outside the view or subject to data grouping.

    index

    The index of the point in the data array.

    Example:

    1. Remove cropped point

    Since

    2.1.0

26. def select(selected: Boolean = ???): Unit

    

    Select or unselect the series.

    Select or unselect the series. This means its selected property is set,the checkbox in the legend is toggled and when selected, the series is returned in the chart.getSelectedSeries() method.

27. val selected: Boolean

    

    Read only.

    Read only. The series' selected state as set by series.select().

28. def setCompare(compare: String = ???): Unit

    

    Set the compare mode of the series after render time.

    Set the compare mode of the series after render time. In most cases it is more useful running Axis.setCompare on the X axis to update all its series.

    compare

    Can be one of null, "percent" or "value".

    Since

    1.3

29. def setData(data: Array[Any] = ???, redraw: Boolean = ???, animation: Any = ???, updatePoints: Boolean = ???): Unit

    

    Apply a new set of data to the series and optionally redraw it.

    Apply a new set of data to the series and optionally redraw it. The new data array is passed by reference (except in case of updatePoints), and may later be mutated when updating the chart data.

    Note the difference in behaviour when setting the same amount of points, or a different amount of points, as handled by the updatePoints parameter.

    Example:

    1. Set new data from a button

30. def setVisible(visible: Boolean = ???, redraw: Boolean = ???): Unit

    

    A utility function to show or hide the series with an optional redraw.

    A utility function to show or hide the series with an optional redraw.

    visible

    Whether to show or hide the series. If undefined, the visibility is toggled.

    redraw

    Defaults to true. Whether to redraw the chart after the series is altered.If doing more operations on the chart, it is a good idea to set redraw to false and call chart.redraw() after.

31. def show(): Unit

    

    Shows the series if hidden.

    Shows the series if hidden.

    Example:

    1. Toggle visibility from a button

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

    

    Definition Classes

    AnyRef

33. def toLocaleString(): String

    

    Definition Classes

    Object

34. def toString(): String

    

    Definition Classes

    AnyRef → Any

35. val type: String

    

    Read only.

    Read only. The series' type, like "line", "area" etc.

36. def update(options: Object = ???, redraw: Boolean = ???): Unit

    

    Update the series with a new set of options.

    Update the series with a new set of options. For a clean and precise handling of new options, all methods and elements from the series are removed, and it is initiated from scratch. Therefore, this method is more performance expensive than some other utility methods like setData or setVisible.

    options

    New options that will be merged into the series' existing options.

    Example:

    1. Updating series options

    Since

    1.3

37. def valueOf(): Any

    

    Definition Classes

    Object

38. val visible: Boolean

    

    Read only.

    Read only. The series' visibility state as set by series.show(), series.hide(), or the initial configuration.

39. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

42. val xAxis: CleanJsObject[Axis]

    

    Read only.

    Read only. The unique xAxis object associated with the series.

43. val yAxis: CleanJsObject[Axis]

    

    Read only.

    Read only. The unique yAxis object associated with the series.