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

JavaScript/jQuery Chart - panes

Declares a collection of panes.

Type:

Array<Panes>

Cannot be used in themes.

A pane is a chart area containing series. If there are many series an a chart, they can be distributed between multiple panes.

DevExtreme HTML5 Charts Panes

Each object in the panes array configures a single pane. If you have several panes, we recommend you to name each pane in order to be able to refer to them afterwards.

View Demo

See Also
  • commonPaneSettings - specifies common settings for all panes in a chart.
  • series.pane - binds a series to a pane.
  • defaultPane - specifies which pane must be used by default.

backgroundColor

Specifies the color of the pane's background.

Default Value: 'none'

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.

jQuery
index.js
$(function(){
    $("#chartContainer").dxChart({
        // ...
        commonPaneSettings: {
            // ...
            backgroundColor: {
                fillId: customPatternId
            }
        }
    });
});
Angular
app.component.html
app.component.ts
<dx-chart ... >
    <dxo-common-pane-settings [backgroundColor]="fill">
    </dxo-common-pane-settings>
</dx-chart>
// ...

export class AppComponent {
    // ...

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

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

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

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

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

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

export default function App() { 
    return ( 
        <Chart ... >
            <CommonPaneSettings backgroundColor={fill} />
        </Chart>        
    ); 
} 

View on GitHub

border

Configures the pane border.

Type:

Object

DevExtreme HTML5 Charts Panes PaneBorder

height

Specifies the pane's height (or width when the chart is rotated) in a multi-pane chart.

Type:

Number

|

String

Default Value: undefined

name

Specifies the name of the pane.

Type:

String

Default Value: undefined

When there are multiple panes in a chart, series need to know which pane they belong to. By default, all of them belong to the defaultPane or, if it is not specified, to the last pane in the panes array. To bind a series to another pane, name the pane and assign this name to the pane series property.