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

jQuery PolarChart - commonSeriesSettings.selectionStyle

An object defining configuration properties for a selected series.

Type:

Object

This member is exposed by the following entities:

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.

border

An object defining the border properties for a selected series.

Type:

Object

This member is exposed by the following entities:

To set custom border settings specific to the 'selected' state for all series at once, use the properties of the commonSeriesSettings.selectionStyle.border configuration object.

To set custom border settings specific to the 'selected' state for all series of a single type at once, use the properties of the corresponding object within commonSeriesSettings (e.g. area.selectionStyle.border). The values that are set within this object override the corresponding common values that are set within the root commonSeriesSettings.selectionStyle.border object.

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

color

Sets a color for a series when it is selected.

Type:

String

Default Value: undefined

This property supports the following colors:

dashStyle

Specifies the dash style for the line in a selected series.

Type:

String

Default Value: 'solid'
Accepted Values: 'dash' | 'dot' | 'longDash' | 'solid'
This member is exposed by the following entities:

The following dash styles are available:

  • solid
    The border is a solid, continuous line.

  • longDash
    The border is displayed using long dashes.

  • dash
    The border is displayed using dashes.

  • dot
    The border is displayed using dots.

  • Any combination of 'longDash', 'dash' and 'dot'
    The border is displayed by repeating the specified combination. For instance, 'dashdotdash'.

hatching

Specifies the hatching properties to be applied when a series is selected.

Type:

Object

This member is exposed by the following entities:

Within this object, you can specify how to apply hatching using the direction property, the width and opacity of lines with the width and opacity properties, and the space between the lines using the step property.

width

Specifies the width of a line in a selected series.

Type:

Number

Default Value: 3
This member is exposed by the following entities: