commonSeriesSettings

An object defining the configuration options that are common for all series of the dxChart widget.

Type: Object

Use this object's properties to set options for all chart series at once. These can be options common to all series types and options specific to series types.

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

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

Show Example:
jQuery

In this example, the chart type and the argument field options are set for all series at once using the commonSeriesSettings.


                                    

                                    

area

An object that specifies configuration options for all series of the area type in the chart.

Type: Object

Define a common configuration for all area series in the chart using any options of the AreaSeries object.

Show Example:
jQuery

In this example, the color of all areas is set using the area field of the commonSeriesSettings object.


                                    

                                    

argumentField

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

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

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.

View Demo

bar

An object that specifies configuration options for all series of the bar type in the chart.

Type: Object

Define a common configuration for all bar series in the chart using any options of the BarSeries object.

Show Example:
jQuery

In this example, the corner settings for all series of the bar type are specified using the bar field of the commonSeriesSettings object.


                                    

                                    

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.

bubble

An object that specifies configuration options for all series of the bubble type in the chart.

Type: Object

Define a common configuration for all bubble series in the chart using any options of the Bubble object.

Show Example:
jQuery

In this example, the borders for all bubble series are configured using the bubble field of the commonSeriesSettings object.


                                    

                                    

candlestick

An object that specifies configuration options for all series of the candleStick type in the chart.

Type: Object

Define a common configuration for all candleStick series in the chart using any options of the CandleStick object.

Show Example:
jQuery

In this example, the value fields for all candleStick series are configured using the candlestick field of the commonSeriesSettings object.


                                    

                                    

closeValueField

Specifies the data source field that provides a 'close' value for a candleStick or stock series.

Type: String
Default Value: 'close'
This member is exposed by the following entities:
Cannot be used in themes.

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

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.

cornerRadius

Specifies a radius for bar corners.

Type: Number
Default Value: 0
This member is exposed by the following entities:

dashStyle

Specifies the dash style of the series' line.

Type: String
Default Value: 'solid'
Accepted Values: 'solid'|'longDash'|'dash'|'dot'

fullstackedarea

An object that specifies configuration options for all series of the fullStackedArea type in the chart.

Type: Object

Define a common configuration for all fullStackedArea series in the chart using any options of the FullStackedArea object.

Show Example:
jQuery

In this example, the axis option is set for all fullStackedArea series using the fullstackedarea field of the commonSeriesSettings object.


                                    

                                    

fullstackedbar

An object that specifies configuration options for all series of the fullStackedBar type in the chart.

Type: Object

Define a common configuration for all fullStackedBar series in the chart using any options of the FullStackedBar object.

Show Example:
jQuery

In this example, the argumentField option is set for all series of the fullStackedBar type at once using the fullstackedbar field of the commonSeriesSettings object.


                                    

                                    

fullstackedline

An object that specifies configuration options for all series of the fullStackedLine type in the chart.

Type: Object

Define a common configuration for all fullStackedLine series in the chart using any options of the FullStackedLine object.

Show Example:
jQuery

In this example, the argumentField option is set for all series of the fullStackedLine type at once using the fullstackedline field of the commonSeriesSettings object.


                                    

                                    

fullstackedspline

An object that specifies configuration options for all series of the Full-Stacked Spline type in the chart.

Type: Object

Define a common configuration for all Full-Stacked Spline series in the chart using any options of the FullStackedSpline object.

fullstackedsplinearea

An object that specifies configuration options for all series of the Full-Stacked Spline Area type in the chart.

Type: Object

Define a common configuration for all Full-Stacked Spline Area series in the chart using any options of the FullStackedSplineArea object.

highValueField

Specifies the data source field that provides a 'high' value for a candleStick or stock series.

Type: String
Default Value: 'high'
This member is exposed by the following entities:
Cannot be used in themes.

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

hoverMode

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

Type: String

Refer to the hoverMode option of a particular series type to learn the acceptable values.

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.

innerColor

Specifies the color for the body (rectangle) of a candleStick series.

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

To set the line color for candleStick series points, use the color property.

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.

line

An object that specifies configuration options for all series of the line type in the chart.

Type: Object

Define a common configuration for all line series in the chart using any options of the Line object.

Show Example:
jQuery

In this example, the color option is set for the series of the line type using the line field of the commonSeriesSettings object.


                                    

                                    

lowValueField

Specifies the data source field that provides a 'low' value for a candleStick or stock series.

Type: String
Default Value: 'low'
This member is exposed by the following entities:
Cannot be used in themes.

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

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.

minBarSize

Specifies the minimal height (length, if the chart is rotated) of a displayed bar in pixels.

Type: Number
Default Value: undefined
This member is exposed by the following entities:

When you visualize data with small and large numbers using a bar-like series, the small numbers are represented by very small bars. It makes them difficult to click, select or hover over. In such a case, use the minBarSize option to set the minimal height of a displayed bar.

opacity

Specifies opacity for a series.

Type: Number
Default Value: 0.5

openValueField

Specifies the data source field that provides an 'open' value for a candleStick or stock series.

Type: String
Default Value: 'open'
This member is exposed by the following entities:
Cannot be used in themes.

When defining series, you can either use the series object or the commonSeriesSettings object. When using the series object, set the openValueField, highValueField, lowValueField and closeValueField 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.

pane

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

Type: String
Default Value: 'default'

point

An object defining configuration options for points in line-, scatter- and area-like series.

To specify point options for all line-, scatter- and area-like series at once, use the properties of the point object defined within the commonSeriesSettings configuration object.

If you have several series of a single type, you can set point 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 their corresponding common values.

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

rangearea

An object that specifies configuration options for all series of the rangeArea type in the chart.

Type: Object

Define a common configuration for all rangeArea series in the chart using any options of the RangeArea object.

Show Example:
jQuery

In this example, the value fields of the rangeArea type series is set using the rangearea field of the commonSeriesSettings object.


                                    

                                    

rangebar

An object that specifies configuration options for all series of the rangeBar type in the chart.

Type: Object

Define a common configuration for all rangeBar series in the chart using any options of the RangeBar object.

Show Example:
jQuery

In this example, the argumentField option is set for all series of the rangeBar type at once using the rangebar field of the commonSeriesSettings object.


                                    

                                    

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:
Cannot be used in themes.

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:
Cannot be used in themes.

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

reduction

Specifies reduction options for the stock or candleStick series.

Type: Object
This member is exposed by the following entities:

If the value of a particular point's price level (open, high, low or close) is lower in comparison to the value in the previous point, the subsequent point is painted in a specific color. To set the price to be compared in the series, use the series' level property. To set the specific color for a subsequent price, which is lower than that price in the previous point, use the series's color property.

scatter

An object that specifies configuration options for all series of the scatter type in the chart.

Type: Object

Define a common configuration for all scatter series in the chart using any options of the Scatter object.

Show Example:
jQuery

In this example, the argumentField option is set for the series of the scatter type using the scatter field of the commonSeriesSettings object.


                                    

                                    

selectionMode

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

Type: String

Refer to the selectionMode option of a particular series type to learn the acceptable values.

View Demo

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

sizeField

Specifies the data source field that defines the size of bubbles.

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

The values from a data source define the size of bubbles. However, the actual size of the bubbles differs from the size that is set in the data source. The actual bubble size is calculated depending on the size of the smallest and largest bubble. In turn, the size of the smallest bubble is determined by the minBubbleSize property, while the size of the largest bubble is calculated relatively to the size of the chart pane and depends on the value of the maxBubbleSize property.

You are required to set the sizeField option when defining bubble series. Set this option to the required field from the data source for each series individually within the series configuration object. If the field that defines sizes for bubbles 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 sizeField option of the commonSeriesSettings object.

spline

An object that specifies configuration options for all series of the spline type in the chart.

Type: Object

Define a common configuration for all spline series in the chart using any options of the Spline object.

Show Example:
jQuery

In this example, the argumentField option is set for the series of the spline type using the spline field of the commonSeriesSettings object.


                                    

                                    

splinearea

An object that specifies configuration options for all series of the splineArea type in the chart.

Type: Object

Define a common configuration for all splineArea series in the chart using any options of the SplineArea object.

Show Example:
jQuery

In this example, the argumentField option is set for the series of the splineArea type using the splinearea field of the commonSeriesSettings object.


                                    

                                    

stack

Specifies the name of the stack where the values of the stackedBar or fullStackedBar series must be located.

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

By default, this property is set to 'default' for all series of the stackedBar and fullStackedBar types. So values of all series are located in one stack for each argument value. You can set the stack property to another value for one group of the series and leave the 'default' value for the other group of series. In this instance, series will be divided into two stacks for each argument. In this manner, you can divide series between the required number of logical stacks.

You can set this property for a series individually, for all stackedBar series, for all fullStackedBar series or for all series in the chart. For this purpose choose the appropriate configuration object for this property: series, commonSeriesSettings | stackedBar, commonSeriesSettings | fullStackedBar or commonSeriesSettings.

View Demo

stackedarea

An object that specifies configuration options for all series of the stackedArea type in the chart.

Type: Object

Define a common configuration for all stackedArea series in the chart using any options of the StackedArea object.

Show Example:
jQuery

In this example, the argumentField option is set for the series of the stackedArea type using the stackedarea field of the commonSeriesSettings object.


                                    

                                    

stackedbar

An object that specifies configuration options for all series of the stackedBar type in the chart.

Type: Object

Define a common configuration for all stackedBar series in the chart using any options of the StackedBar object.

Show Example:
jQuery

In this example, the argumentField option is set for the series of the stackedBar type using the stackedbar field of the commonSeriesSettings object.


                                    

                                    

stackedline

An object that specifies configuration options for all series of the stackedLine type in the chart.

Type: Object

Define a common configuration for all stackedLine series in the chart using any options of the StackedLine object.

Show Example:
jQuery

In this example, the argumentField option is set for the series of the stackedLine type using the stackedline field of the commonSeriesSettings object.


                                    

                                    

stackedspline

An object that specifies configuration options for all series of the Stacked Spline type in the chart.

Type: Object

Define a common configuration for all Stacked Spline series in the chart using any options of the StackedSpline object.

stackedsplinearea

An object that specifies configuration options for all series of the Stacked Spline Area type in the chart.

Type: Object

Define a common configuration for all Stacked Spline Area series in the chart using any options of the StackedSplineArea object.

steparea

An object that specifies configuration options for all series of the stepArea type in the chart.

Type: Object

Define a common configuration for all stepArea series in the chart using any options of the StepArea object.

Show Example:
jQuery

In this example, the border is configured for the series of the stepArea type using the steparea field of the commonSeriesSettings object.


                                    

                                    

stepline

An object that specifies configuration options for all series of the stepLine type in the chart.

Type: Object

Define a common configuration for all stepLine series in the chart using any options of the StepLine object.

Show Example:
jQuery

In this example, series points are configured for the series of the stepLine type using the stepline field of the commonSeriesSettings object.


                                    

                                    

stock

An object that specifies configuration options for all series of the stock type in the chart.

Type: Object

Define a common configuration for all stock series in the chart using any options of the Stock object.

Show Example:
jQuery

In this example, the reduction is configured for the series of the stock type using the stock field of the commonSeriesSettings object.


                                    

                                    

tagField

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

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

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.

type

Sets a series type.

Type: String
Default Value: 'line'
Accepted Values: 'line' | 'stackedline' | 'fullstackedline' | 'area' | 'stackedarea' | 'fullstackedarea' | 'bar' | 'stackedbar' | 'fullstackedbar' | 'spline' | 'splinearea' | 'scatter' | 'candlestick' | 'stock' | 'rangearea' | 'rangebar' | 'stepline' | 'steparea' | 'bubble' | 'fullstackedspline' | 'stackedspline' | 'stackedsplinearea' | 'fullstackedsplinearea'

A series type determines a particular visual representation of data. To learn more about series types supplied with the dxChart widget, refer to the Series help section.

valueErrorBar

Configures error bars.

Type: Object
This member is exposed by the following entities:

Error bars are used on charts to indicate an error or an uncertainty in a reported measurement. They give a general idea of how precise a measurement is.

In dxChart, an error bar is a vertical bar with two marks at its edges. An error bar accompanies a series point. Error bars can be generated either from concrete or calculated values. To generate one error bar, two values, high and low, are needed. If the data source of your chart provides concrete high and low values, assign the required data source fields to the highValueField and lowValueField options.

Alternatively, you can calculate the high and low error bar values automatically. For this purpose, choose one of error bar types and specify the value to be used in calculation.

NOTE: Error bars are available for axes of a numeric type only.

View Demo

valueField

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

Type: String
Default Value: 'val'

Use this option only when you apply series templates. Otherwise, specify the valueField option for each series individually within the series array.

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.

NOTE: When the series is invisible, the marker of its legend item is faded.

width

Specifies a width for a line in the series.

Type: Number
Default Value: 2