SeriesSolidgauge

Instance Constructors

new SeriesSolidgauge()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
val data: Any

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
val dataLabels: Object

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
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
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val events: SeriesSolidgaugeEvents
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
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
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
val id: 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
val index: 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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
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
val legendIndex: 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 .
val name: 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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val overshoot: 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
val point: SeriesSolidgaugePoint

Properties for each single point
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
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
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
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. Defaults to false for gauge series.

Since
2.3.0
val states: PlotOptionsSeriesStates

A wrapper object for all the series options in specific states.
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
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
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
def valueOf(): Any

Definition Classes
Object
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
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val wrap: 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
val xAxis: Any

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.
val yAxis: Any

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
val zIndex: 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.
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
val zones: Array[SeriesSolidgaugeZones]

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

Related Doc: package config

class SeriesSolidgauge extends Object

Instance Constructors

new SeriesSolidgauge()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val animation: Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val cursor: String

val data: Any

val dataLabels: Object

val enableMouseTracking: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: SeriesSolidgaugeEvents

def finalize(): Unit

final def getClass(): Class[_]

val getExtremesFromAll: Boolean

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val id: String

val index: Double

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val keys: Array[String]

val legendIndex: Double

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val overshoot: Double

val point: SeriesSolidgaugePoint

def propertyIsEnumerable(v: String): Boolean

val selected: Boolean

val showCheckbox: Boolean

val showInLegend: Boolean

val states: PlotOptionsSeriesStates

val stickyTracking: Boolean

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

def toLocaleString(): String

def toString(): String

val tooltip: Object

val type: String

def valueOf(): Any

val visible: Boolean

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val wrap: Boolean

val xAxis: Any

val yAxis: Any

val zIndex: Double

val zoneAxis: String

val zones: Array[SeriesSolidgaugeZones]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped