SeriesSolidgauge

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]

   

   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.

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.

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.

   Since

   5.0.0

8. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

9. val colorIndex: UndefOr[Double]

   

   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

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.

    Example:

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

11. val data: UndefOr[Array[|[CleanJsObject[SeriesSolidgaugeData], Double]]]

    

    An array of data points for the series.

    An array of data points for the series. For the solidgauge 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. Example:

      data: [0, 5, 3, 5]
      

    -

    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: [{
        y: 5,
        name: "Point2",
        color: "#00FF00"
    }, {
        y: 7,
        name: "Point1",
        color: "#FF00FF"
    }]
    

    The typical gauge only contains a single data value.

    Example:

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

       • Numerical values
       • Arrays of numeric x and y
       • Arrays of datetime x and y
       • Arrays of point.name and y
       • Config objects

12. val dataLabels: UndefOr[CleanJsObject[SeriesSolidgaugeDataLabels]]

    

    Data labels for the gauge.

    Data labels for the gauge. For gauges, the data labels are enabled by default and shown in a bordered box below the point.

    Since

    2.3.0

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.

    Example:

    1. Accessible stock chart

    Since

    5.0.0

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.

    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[CleanJsObject[SeriesSolidgaugeEvents]]

    

18. val exposeElementToA11y: UndefOr[Boolean]

    

    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.

    Example:

    1. Accessible data visualization

    Since

    5.0.12

19. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

20. val findNearestPointBy: UndefOr[String]

    

    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.

    Example:

    1. Different hover behaviors

    Since

    5.0.10

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

    

    Definition Classes

    AnyRef → Any

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

23. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

24. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

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

    Example:

    1. Get series by id

    Since

    1.2.0

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

    Since

    2.3.0

27. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

28. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

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

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

31. val linecap: UndefOr[String]

    

    Whether the strokes of the solid gauge should be round or square.

    Whether the strokes of the solid gauge should be round or square.

    Example:

    1. Rounded gauge

    Since

    4.2.2

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

    Example:

    1. Series name

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

    

    Definition Classes

    AnyRef

34. final def notify(): Unit

    

    Definition Classes

    AnyRef

35. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

36. val overshoot: UndefOr[Double]

    

    Allow the dial to overshoot the end of the perimeter axis by this many degrees.

    Allow the dial to overshoot the end of the perimeter axis by this many degrees. Say if the gauge axis goes from 0 to 60, a value of 100, or 1000, will show 5 degrees beyond the end of the axis.

    Example:

    1. Allow 5 degrees overshoot

    Since

    3.0.10

37. val point: UndefOr[CleanJsObject[SeriesSolidgaugePoint]]

    

    Properties for each single point

38. val pointDescriptionFormatter: UndefOr[Function]

    

    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

39. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

40. val rounded: UndefOr[Boolean]

    

    Wether to draw rounded edges on the gauge.

    Wether to draw rounded edges on the gauge.

    Example:

    1. Activity Gauge,

    Since

    5.0.11

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

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

43. 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. Defaults to false for gauge series.

    Since

    2.3.0

44. val skipKeyboardNavigation: UndefOr[Boolean]

    

    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

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

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

    

    Definition Classes

    AnyRef

47. val threshold: UndefOr[Double]

    

    The threshold or base level for the gauge.

    The threshold or base level for the gauge.

    Example:

    1. Zero threshold with negative and positive values

    Since

    5.0.3

48. def toLocaleString(): String

    

    Definition Classes

    Object

49. def toString(): String

    

    Definition Classes

    AnyRef → Any

50. val tooltip: UndefOr[CleanJsObject[SeriesSolidgaugeTooltip]]

    

    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

51. val type: String

    

    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.

    Example:

    1. Line and column in the same chart

52. def valueOf(): Any

    

    Definition Classes

    Object

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

54. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

57. val wrap: UndefOr[Boolean]

    

    When this option is true, the dial will wrap around the axes.

    When this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360.

    Since

    3.0

58. val xAxis: UndefOr[|[Double, String]]

    

    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.

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

    

    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.

    Example:

    1. Apply the column series to the secondary Y axis

60. val zIndex: UndefOr[Double]

    

    Define the visual z index of the series.

    Define the visual z index of the series.

    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.