SeriesBubble

Instance Constructors

new SeriesBubble()

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 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
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 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
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
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 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
val data: Any

An array of data points for the series.
An array of data points for the series. For the bubble series type, points can be given in the following ways:
-
An array of arrays with 3 or 2 values. In this case, the values correspond to x,y,z. If the first value is a string, it is applied as the name of the point, and the x value is inferred. The x value can also be omitted, in which case the inner arrays should be of length 2. Then the x value is automatically calculated, either starting at 0 and incremented by 1, or from pointStart and pointInterval given in the series options.
```
data: [
    [0, 1, 2],
    [1, 5, 5],
    [2, 0, 2]
]
```
-
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: 1,
    z: 1,
    name: "Point2",
    color: "#00FF00"
}, {
    x: 1,
    y: 5,
    z: 4,
    name: "Point1",
    color: "#FF00FF"
}]
```
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: SeriesBubbleDataLabels
val displayNegative: Boolean

Whether to display negative sized bubbles.
Whether to display negative sized bubbles. The threshold is given by the zThreshold option, and negative bubbles can be visualized by setting negativeColor.
Example:
1. Negative bubbles
Since
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: SeriesBubbleEvents
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 lineWidth: Double

The width of the line connecting the data points.
The width of the line connecting the data points.
Example:
1. 0 by default, 1px
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
val marker: SeriesBubbleMarker
val maxSize: String

Maximum bubble size.
Maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.
Example:
1. Bubble size
Since
3.0
val minSize: String

Minimum bubble size.
Minimum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.
Example:
1. Bubble size
Since
3.0
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
val negativeColor: String

When a point's Z value is below the zThreshold setting, this color is used.
When a point's Z value is below the zThreshold setting, this color is used.
Example:
1. Negative bubbles
Since
3.0
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val point: SeriesBubblePoint

Properties for each single point
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
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
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
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 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
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. The default value is true for standalone series, false for linked series.
Example:
1. One series in the legend, one hidden
val sizeBy: String

Whether the bubble's value should be represented by the area or the width of the bubble.
Whether the bubble's value should be represented by the area or the width of the bubble. The default, area, corresponds best to the human perception of the size of each bubble.
Example:
1. Comparison of area and size
Since
3.0.7
val sizeByAbsoluteValue: Boolean

When this is true, the absolute value of z determines the size of the bubble.
When this is true, the absolute value of z determines the size of the bubble. This means that with the default zThreshold of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0 will have a smaller size according to minSize.
Example:
1. Size by absolute value, various thresholds.
Since
4.1.9
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
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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
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 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 zMax: Double

The minimum for the Z value range.
The minimum for the Z value range. Defaults to the highest Z value in the data.
Example:
1. Z has a possible range of 0-100
Since
4.0.3
val zMin: Double

The minimum for the Z value range.
The minimum for the Z value range. Defaults to the lowest Z value in the data.
Example:
1. Z has a possible range of 0-100
Since
4.0.3
val zThreshold: Double

When displayNegative is false, bubbles with lower Z values are skipped.
When displayNegative is false, bubbles with lower Z values are skipped. When displayNegative is true and a negativeColor is given, points with lower Z is colored.
Example:
1. Negative bubbles
Since
3.0
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[SeriesBubbleZones]

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 SeriesBubble extends Object

Instance Constructors

new SeriesBubble()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowPointSelect: Boolean

val animation: Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val color: String

val cropThreshold: Double

val cursor: String

val dashStyle: String

val data: Any

val dataLabels: SeriesBubbleDataLabels

val displayNegative: Boolean

val enableMouseTracking: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: SeriesBubbleEvents

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 lineWidth: Double

val linkedTo: String

val marker: SeriesBubbleMarker

val maxSize: String

val minSize: String

val name: String

final def ne(arg0: AnyRef): Boolean

val negativeColor: String

final def notify(): Unit

final def notifyAll(): Unit

val point: SeriesBubblePoint

val pointInterval: Double

val pointIntervalUnit: String

val pointStart: Double

def propertyIsEnumerable(v: String): Boolean

val selected: Boolean

val shadow: Any

val showCheckbox: Boolean

val showInLegend: Boolean

val sizeBy: String

val sizeByAbsoluteValue: Boolean

val softThreshold: Boolean

val states: PlotOptionsSeriesStates

val stickyTracking: Boolean

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

val threshold: Double

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 xAxis: Any

val yAxis: Any

val zIndex: Double

val zMax: Double

val zMin: Double

val zThreshold: Double

val zoneAxis: String

val zones: Array[SeriesBubbleZones]

Inherited from Object

Inherited from Any