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

JavaScript/jQuery Chart - commonSeriesSettings.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 UI component API. Refer to the onPointClick property 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.

border

Configures the appearance adopted by the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series.

color

Specifies the color of the series in the selected state.

Default Value: undefined

This property supports the following colors:

You can also specify a custom pattern or gradient instead of a plain color. Call the registerPattern() or registerGradient() method to obtain a fill ID. Assign that value to the fillId field.

This functionality is available for the following Chart series:

jQuery
index.js
$(function(){
    $("#chartContainer").dxChart({
        // ...
        series: {
            // ...
            selectionStyle: {
                color: {
                    fillId: customPatternId
                }
            }
        }
    });
});
Angular
app.component.html
app.component.ts
<dx-chart ... >
    <dxi-series ... >
        <dxo-selection-style
            [color]="fill"
        ></dxo-selection-style>
    </dxi-series>
</dx-chart>
// ...

export class AppComponent {
    // ...

    fill = {
        fillId: this.customPatternId
    };
} 
Vue
App.vue (Options API)
App.vue (Composition API)
<template>
    <DxChart ... >
        <DxSeries ... >
            <DxSelectionStyle :color="fill" />
        </DxSeries>
    </DxChart>
</template>

<script>
import DxChart, { DxSeries, DxSelectionStyle } from 'devextreme-vue/chart'; 
// ...

export default {
    components: {
        DxChart,
        DxSeries,
        DxSelectionStyle
    },
    data() {
        return {
            // ...
            fill: {
                fillId: this.customPatternId
            }
        }
    }
}
</script>
<template>
    <DxChart ... >
        <DxSeries ... >
            <DxSelectionStyle :color="fill" />
        </DxSeries>
    </DxChart>
</template>

<script setup>
import DxChart, { DxSeries, DxSelectionStyle } from 'devextreme-vue/chart';  
// ...

const fill = {
    fillId: customPatternId
};
</script>
React
App.js
import React from 'react';
import Chart, { Series, SelectionStyle } from 'devextreme-react/chart'; 

// ...
const fill = {
    fillId: customPatternId
};

export default function App() { 
    return ( 
        <Chart ... >
            <Series ... >
                <SelectionStyle color={fill} />
            </Series>
        </Chart>        
    ); 
} 

dashStyle

Specifies the dash style of the series line when the series is in the selected state. Applies only to line-like series.

Type:

DashStyle

Default Value: 'solid'

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

Configures hatching that applies when a user selects the series.

Hatching is filling an area or a bar (depending on the series type) with parallel diagonal lines. In the Chart UI component, it applies when a user selects a series.

highlight

Specifies whether to lighten the series when a user selects it.

width

Specifies the pixel-measured width of the series line when the series is in the selected state.