RangeBarSeries

An object defining a series of the rangeBar type.

Type: Object

RangeBarSeriesType ChartJS

For details on the rangeBar series type, refer to the Range Bar topic.

argumentField

Specifies the data source field that provides arguments for series points.

Type: String
Default Value: 'arg'

When defining series using the series configuration object, set the argumentField property to the corresponding field from the data source for each series individually. If the field that supplies arguments for data points is called in a similar way for several series, there is no need to set the field name for each series individually. Instead, set the field name for the argumentField property of the commonSeriesSettings configuration object at once.

axis

Specifies the name of the value axis that will be used to display the series.

Type: String
Default Value: undefined

This property is required when you implement a dxChart widget with multiple value axes. Set names for the value axes using their name property and assign these names to the series' axis property.

border

An object defining the series border configuration options.

Series of some types can be displayed with borders (bars, area, etc.). To set custom border settings for all such series at once, use the border object within the commonSeriesSettings configuration object.

If you have several series of one type, you can set border options specific to this type using the corresponding object (area, line, or another) within the commonSeriesSettings configuration object. In addition, any non-specific series type property of the commonSeriesSettings | border object can be added to the series-type-specific border definition within the commonSeriesSettings | area/line/... | border configuration object. The values that are set within series-type-specific configuration objects override the corresponding common values.

In case you have to set an individual value for a common or series-type-specific border option, use the border object within the series object of the series array. The values that are set individually override corresponding common values.

color

Specifies a series color.

Type: String
Default Value: undefined

Color is used to distinguish one chart series from another. However, there can be cases when it is more appropriate to display all chart series in one color. In this case, set the color property of the commonSeriesSettings configuration object. If required, you can override this property's common value in individual series objects.

hoverMode

Specifies the series elements to highlight when a series is hovered over.

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

The following values are available:

  • onlyPoint
    Changes the appearance of the hovered bar only.
  • allSeriesPoints
    Changes the appearance of all the bars of the hovered series.
  • allArgumentPoints
    Changes the appearance of the hovered bar and of other bars that are displayed for the argument of the hovered bar.
  • none
    The appearance of the hovered series is not changed.

To set custom options for the 'hover' style (which is applied when a series is hovered over), use the hoverStyle configuration object. Define this object for an individual series (see series | hoverStyle), for all series of a particular type (see commonSeriesSettings | area/line/... | hoverStyle), or all series in the chart (see commonSeriesSettings | hoverStyle).

hoverStyle

An object defining configuration options for a hovered series.

Type: Object

To set a custom 'hover' style for all series at once, use the hoverStyle object within the commonSeriesSettings configuration object.

If you have several series of one type, you can set hover style options to the values specific to this type using the corresponding object (area, line or another) within the commonSeriesSettings configuration object. The values that are set within series-type-specific configuration objects override the corresponding common values.

In case you have to set a hover style option for an individual series, use the hoverStyle object within the series object of the series array. The values that are set individually override corresponding common values.

ignoreEmptyPoints

Specifies whether a chart ignores null data points or not.

Type: Boolean
Default Value: false

By default, if a data source has data points with a null argument or value, a chart may draw series with unnecessary gaps between points. To prevent this behavior from occurring, set the ignoreEmptyPoints option to true.

label

An object defining the label configuration options.

Type: Object

Each series point can be accompanied by a text label that represents data related to the point. These are called series point labels. Use the label object's properties to set label options for all chart series at once.

Specify the label object's properties within the commonSeriesSettings configuration object to set label options for all chart series at once.

If you have several series of a single type, you can set label options to the values specific to this series type using the corresponding object (area, line, etc.) within the commonSeriesSettings configuration object. The values that are set within series-type-specific configuration objects override the corresponding common values.

If you need to set a label option for an individual series, use the label object within the series object of the series array. The values that are set individually override the corresponding common values.

maxLabelCount

Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed.

Type: Number
Default Value: undefined

When there are several series in a chart and series with a large number of points, the point labels may overlap each other and make a chart difficult to read. In this instance, it is better to display the point labels depending on their quantity. To specify the maximum amount of the labels to be displayed, set the required number to the maxLabelCount field. If the number of the points on a series exceeded the number assigned to the maxLabelCount field, the point labels for this series will not be displayed.

pane

Specifies the pane that will be used to display a series.

Type: String
Default Value: 'default'

rangeValue1Field

Specifies the data source field that provides values for one end of a range series. To set the data source field for the other end of the range series, use the rangeValue2Field property.

Type: String
Default Value: 'val1'
This member is exposed by the following entities:

When defining series, you can either use the series object or the commonSeriesSettings object. When using the series object, set the rangeValue1Field and rangeValue2Field options to the corresponding fields of the data source. The same options can be specified within the commonSeriesSettings object, but only when you use series templates in your chart.

rangeValue2Field

Specifies the data source field that provides values for the second end of a range series. To set the data source field for the other end of the range series, use the rangeValue1Field property.

Type: String
Default Value: 'val2'
This member is exposed by the following entities:

This property is analogous to the rangeValue1Field property. So refer to this property for a description.

selectionMode

Specifies the series elements to highlight when the series is selected.

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

The dxChart widget comes with an API that allows you to select a series or a particular point in code. Use the selectionMode property to specify which series elements to select when the series is selected:

  • onlyPoint
    Changes the appearance of the hovered bar only.
  • allSeriesPoints
    Changes the appearance of all the bars of the hovered series.
  • allArgumentPoints
    Changes the appearance of the hovered bar and of other bars that are displayed for the argument of the hovered bar.
  • none
    The appearance of the hovered series is not changed.

To set custom options for the 'selected' style (which is applied when a series is selected), use the selectionStyle configuration object. Define this object for an individual series (see series | selectionStyle), for all series of a particular type (see commonSeriesSettings | area/line/... | selectionStyle), or all series in the chart (see commonSeriesSettings | selectionStyle).

selectionStyle

An object defining configuration options for a selected series.

Type: Object

The dxChart widget comes with API members that allow you to select a series in code. To set a custom 'selected' style for all series at once, use the selectionStyle object within the commonSeriesSettings configuration object.

If you have several series of one type, you can set selection style options to the values specific to this type using the corresponding object (area, line or another) within the commonSeriesSettings configuration object. The values that are set within series-type-specific configuration objects override the corresponding common values.

In case you have to set a selection style option for an individual series, use the selectionStyle object within the series object of the series array. The values that are set individually override corresponding common values.

showInLegend

Specifies whether or not to show the series in the chart's legend.

Type: Boolean
Default Value: true

tagField

Specifies the name of the data source field that provides data about a point.

Type: String
Default Value: 'tag'

When setting a common data source via the dataSource property, you can pass information about a point. For this purpose, add a separate field to the data source in addition to the argument and value fields. To set the specified data to the point instance, set the series' tagField property to the name of the field with the information. In this instance, when clicking a point in the chart, you can access the data associated with this point using the point's instance.

When defining series using the series configuration object, set the tagField property to the corresponding field from the data source for each series individually. If the field that supplies data about points is called similarly in several series, there is no need to set its name for each series individually. Instead, set it for the tagField property of the commonSeriesSettings configuration object.

You can also associate data with a series instance. To learn how to do this, refer to the description of the tag property of the series configuration object.

visible

Specifies the visibility of a series.

Type: Boolean
Default Value: true

When this option is set to false for a series, the series appears invisible. If you require all the series to appear so, assign the same value to the visible option within the commonSeriesSettings configuration object.

In addition, you can show/hide series at runtime. For this purpose, use the show() or hide() method of a particular series respectively.