A newer version of this page is available. Switch to the current version.

jQuery PolarChart - AreaSeries

An object defining a series of the area type.

Type:

Object

All the settings in this section are specified as follows:

  • The commonSeriesSettings object
    Specifies settings for all series in a PolarChart.

  • The commonSeriesSettings.area object
    Specifies settings for all series of the area type.

  • An object in the series array
    Specifies settings for an individual series.

View Demo

AreaSeriesType ChartJS

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.

border

An object defining the series border configuration properties.

Type:

Object

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 properties 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 property, use the border object within the series object of the series array. The values that are set individually override corresponding common values.

closed

Specifies whether or not to close the chart by joining the end point with the first point.

Type:

Boolean

Default Value: true

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 series elements to be highlighted when a user points to the series.

Type:

String

Default Value: 'nearestPoint'
Accepted Values: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'

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

  • nearestPoint
    The series changes its style along with the point that is nearest to the cursor.
  • includePoints
    The series changes its style along with all the points.
  • excludePoints
    The series changes its style, but the points do not.
  • none
    The series does not react to pointing to it.
NOTE
Points in area series are hidden by default. To make them visible, assign true to the point.visible property.
See Also

hoverStyle

An object defining configuration properties 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 properties 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 property 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 the series should ignore null data points.

Type:

Boolean

Default Value: false

Data points that have the null value do not produce actual series points. Because of this, series may be drawn with unnecessary gaps where missing points should have been. To remove these gaps, set the ignoreEmptyPoints property to true.

label

An object defining the label configuration properties.

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 properties for all chart series at once.

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

If you have several series of a single type, you can set label properties 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 property 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.

opacity

Specifies opacity for a series.

Type:

Number

Default Value: 0.5

point

An object defining configuration properties for points in line and area series.

Type:

Object

To specify point properties for all line and area 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 properties 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 property 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.

selectionMode

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

Type:

String

Default Value: 'includePoints'
Accepted Values: 'includePoints' | 'excludePoints' | 'none'

When a user selects the series, it may react in one of the following ways depending on the value of the selectionMode property.

  • includePoints
    The series changes its style along with all the points.
  • excludePoints
    The series changes its style, but the points do not.
  • none
    The series does not react to selection.
NOTE
Points in area series are hidden by default. To make them visible, assign true to the point.visible property.
See Also

selectionStyle

An object defining configuration properties for a selected series.

Type:

Object

The PolarChart UI component 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 properties 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 property 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'
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.

valueErrorBar

Configures error bars.

Type:

Object

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 PolarChart, 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 properties.

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.

valueField

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

Type:

String

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

When defining series using the series configuration object, set the valueField property for each series individually to the corresponding field from the data source. In case you use series templates, specify the valueField property of the commonSeriesSettings configuration object.

visible

Specifies the visibility of a series.

Type:

Boolean

Default Value: true

When this property 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 property within the commonSeriesSettings configuration object.

In addition, you can show/hide series at runtime by using the show() or hide() method of a particular series respectively.

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