BubbleSeries

Describes settings supported by a series of the bubble type.

Type: Object

argumentField

Specifies which data source field provides arguments for series points.

Type: String
Default Value: 'arg'
Cannot be used in themes.

Each point in a bubble series has an argument, a regular value and a size value. Arguments are provided by the argumentField; regular values are provided by the valueField; size values are provided by the sizeField.

Commonly, when a chart contains several series, many of them have the same argument and size fields. In this case, assign their names to the argumentField and sizeField properties of the commonSeriesSettings object. If a series must have unique argument and size fields, specify the same properties, but do so in the series object within the series array.

axis

Binds the series to a value axis.

Type: String
Default Value: undefined

When there are multiple value axes in a chart, series need to know exactly which axis they are bound to. By default, all of them are bound to the first axis in the valueAxis array. To bind a series to another axis, assign the name of the axis to the axis series property.

View Demo

border

Configures the series border (in area-like series) or the series point border (in bar-like and bubble series).

Type: Object

Declared in commonSeriesSettings, the border settings apply to all series in the chart. Declared in a series configuration object, the border settings apply to this particular series only. The series-specific border settings override the common ones.

color

Specifies the color of the series.

Type: String
Default Value: undefined

This option supports the following colors.

Specified in the commonSeriesSettings object, this option colors all series in the chart. To color an individual series, specify this option in the series object within the series array.

hoverMode

Specifies series elements to be highlighted when a user points to a series.

Type: String
Default Value: 'onlyPoint'
Accepted Values: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'

When a user points to a series, it may react in one of the following ways depending on the value of the hoverMode option.

hoverMode Result
"onlyPoint"
"allSeriesPoints"
"allArgumentPoints"
"none"

When using the widget as an ASP.NET MVC Control, specify this option using the ChartSeriesHoverMode enum with one of the following values: OnlyPoint, AllSeriesPoints, AllArgumentPoints, and None. Note that although this enum accepts more values, only the listed ones can be applied to a bubble series.

See Also
  • hoverStyle - specifies the appearance of series in the hover state.

hoverStyle

Configures the appearance adopted by the series when a user points to it.

Type: Object

Declared in commonSeriesSettings, hoverStyle applies to all series in the chart. Declared in a series configuration object, hoverStyle applies to this particular series only. The series-specific hoverStyle overrides the common one.

ignoreEmptyPoints

Specifies whether the series should ignore null data points.

Type: Boolean
Default Value: false

Data points that have the null argument or value do not produce actual series points. Because of this, series of continuous types (line, spline, area, etc.) may be drawn with unnecessary gaps where missing points should have been. To remove these gaps, set the ignoreEmptyPoints option to true.

label

Configures point labels.

Type: Object

Declared in commonSeriesSettings, the label settings apply to all point labels in the chart. Declared in a series configuration object, the label settings apply only to the point labels that belong to this particular series. The series-specific label settings override the common ones.

See Also
  • customizeLabel - —Āustomizes the appearance of an individual point label.

maxLabelCount

Specifies a limit for the number of point labels.

Type: Number
Default Value: undefined

If the number of points in a series increases over time, there comes a time when it becomes so massive that displaying labels for them makes the chart too cluttered. In this instance, to keep the chart clear to the viewer, specify a limit for the number of point labels using the maxLabelCount option. Once this limit is exceeded, all point labels of the series will be hidden.

opacity

Specifies how transparent the series should be.

Type: Number
Default Value: 0.5

This option accepts a value from 0 to 1, where 0 makes the series completely transparent, and 1 makes it opaque.

pane

Specifies which pane the series should belong to. Accepts the name of the pane.

Type: String
Default Value: 'default'

If this option is not specified, the series will belong to the default pane.

See Also
  • panes - declares a collection of panes.

View Demo

selectionMode

Specifies series elements to be highlighted when a user selects a bubble.

Type: String
Default Value: 'onlyPoint'
Accepted Values: 'onlyPoint' | 'allSeriesPoints' | 'allArgumentPoints' | 'none'
NOTE
Though not provided out of the box, the selection capability can be implemented using the widget API. Refer to the onPointClick option description for details.

When a user selects a bubble, its series may react in one of the following ways depending on the value of the selectionMode option.

selectionMode Result
"onlyPoint"
"allSeriesPoints"
"allArgumentPoints"
"none"

When using the widget as an ASP.NET MVC Control, specify this option using the ChartSeriesSelectionMode enum with one of the following values: OnlyPoint, AllSeriesPoints, AllArgumentPoints, and None. Note that although this enum accepts more values, only the listed ones can be applied to a bubble series.

See Also
  • pointSelectionMode - specifies whether only one or several bubbles can stay selected.
  • series.selectionStyle - specifies the appearance of bubbles in the selected state.
  • pointSelectionChanged - an event that fires after the selection state of a bubble has been changed.

selectionStyle

Configures the appearance adopted by the series when a user selects it.

Type: Object
NOTE
Though not provided out of the box, the selection capability can be implemented using the widget API. Refer to the onPointClick option description for details.

Declared in commonSeriesSettings, selectionStyle applies to all series in the chart. Declared in a series configuration object, selectionStyle applies to this particular series only. The series-specific selectionStyle overrides the common one.

showInLegend

Specifies whether to show the series in the legend or not.

Type: Boolean
Default Value: true

sizeField

Specifies which data source field provides size values for bubbles. Required by and applies only to bubble series.

Type: String
Default Value: 'size'

Each point in a bubble series has an argument, a regular value and a size value. Arguments are provided by the argumentField; regular values are provided by the valueField; size values are provided by the sizeField.

Size values do not specify the real sizes of bubbles directly, they only define the sizes of bubbles in relation to each other. Apart from a size value, the real, pixel-measured size of a bubble depends on the minBubbleSize and maxBubbleSize values and the size of the pane.

Commonly, a chart contains several series, and many of them have the same size field. In this case, assign the name of this field to the sizeField property of the commonSeriesSettings object. If a series must have a unique size field, specify the same property, but do so in the series object within the series array.

tagField

Specifies which data source field provides auxiliary data for series points.

Type: String
Default Value: 'tag'
Cannot be used in themes.

This option allows you to associate virtually any required data with a series point. This data will be stored in the tag field of the Point object.

Commonly, a chart contains several series, and many of them have the same tagField value. In this case, specify the tagField property in the commonSeriesSettings object. If a series must have a unique tagField value, specify the same property, but do so in the series object within the series array.

See Also
  • series.tag - associates data with an entire series.

valueField

Specifies which data source field provides values for series points.

Type: String
Default Value: 'val'
Cannot be used in themes.

In the Cartesian coordinate system, each point is characterized by a pair of coordinates (X, Y). In a common case, X's are provided by the argumentField; Y's are provided by the valueField.

Certain series types require more than one value field, because their points are characterized by a larger number of coordinates. These series types are:

  • Range-like series types
    Range bar and range area require two value fields: rangeValue1Field and rangeValue2Field.
  • Financial series types
    Stock and candlestick require four value fields: openValueField, closeValueField, highValueField and lowValueField.

If you use a series template, specify the value field properties in the commonSeriesSettings object. Otherwise, do this in the series object within the series array.

visible

Specifies whether the series is visible or not.

Type: Boolean
Default Value: true
NOTE
When the series is invisible, the marker of its legend item is faded.
See Also
  • Series.show() - shows the series at runtime.
  • Series.hide() - hides the series at runtime.