JavaScript/jQuery Chart Options

See Also

• Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core

The adaptive layout enables the UI component to hide optional elements if they do not fit in the container. Elements are hidden in the following sequence:

1. Title
2. Export menu icon
3. Legend
4. Axis titles
5. Axis labels
6. Point labels (can be saved by setting the adaptiveLayout.keepLabels property to true)

Use the height and width properties in the adaptiveLayout object to specify the minimum container size at which the layout begins to adapt.

View Demo on JSFiddle

See Also

• Adaptive Layout

When a user zooms or pans the argument axis, the range of displayed series values changes accordingly. To display this entire range without unused space on the value axis, the value axis's visual range gets widened or narrowed.

Set this property to false if the visual range should be constant and equal to the series values' maximum range.

View Demo

See Also

• zoomAndPan

The UI component animates its elements at the beginning of its lifetime and when the data source changes.

$(function() {
    $("#chartContainer").dxChart({
        // ...
        animation: {
            easing: "linear",
            duration: 500,
            maxPointCountSupported: 100
        }
    });
});

<dx-chart ... >
    <dxo-animation
        easing="linear"
        [duration]="500"
        [maxPointCountSupported]="100">
    </dxo-animation>
</dx-chart>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxChart ... >
        <DxAnimation
            easing="linear"
            :duration="500"
            :max-point-count-supported="100"
        />
    </DxChart>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxChart, {
    DxAnimation
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxAnimation
    },
    // ...
}
</script>

import React from 'react';

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import Chart, {
    Animation 
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <Animation
                    easing="linear"
                    duration={500}
                    maxPointCountSupported={100}
                />
            </Chart>
        );
    }
}
export default App;

Annotations are images and text blocks that provide additional information on the visualized data. The image below demonstrates their appearance:

To configure annotations, assign an array of objects to the annotations[] property. Each object should have the type field set to "text" or "image". Depending on the type, specify the annotation's text or image property:

$(function() {
    $("#chartContainer").dxChart({
        annotations: [{
            type: "text",
            text: "Annotation text"
        }, {
            type: "image",
            image: "http://image/url/myimage.png"
        }]
    });
});

<dx-chart ... >
    <dxi-annotation
        type="text"
        text="Annotation text">
    </dxi-annotation>
    <dxi-annotation
        type="image"
        image="http://image/url/myimage.png">
    </dxi-annotation>
</dx-chart>

import { Component } from '@angular/core';
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxChart ... >
        <DxAnnotation
            type="text"
            text="Annotation text"
        />
        <DxAnnotation
            type="image"
            image="http://image/url/myimage.png"
        />
    </DxChart>
</template>

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

export default {
    components: {
        DxChart,
        DxAnnotation
    },
    data() {
        // ...
    }
}
</script>

import React from 'react';

import Chart, {
    Annotation
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <Annotation
                    type="text"
                    text="Annotation text"
                />
                <Annotation
                    type="image"
                    image="http://image/url/myimage.png"
                />
            </Chart>
        );
    }
}

export default App;

Annotations can be unattached or anchored to a chart element. The following list shows how to position them. Chart coordinates (argument, value, axis, series) specify the element that the annotation's arrow points to; pixel coordinates (x and y) specify the position of the annotation's center.

• Unanchored annotation

  annotations: [{
      x: 100,
      y: 200
  }]

• Annotation anchored to a chart coordinate

  annotations: [{
      argument: new Date(2019, 1, 16),
      value: 15,
      axis: "Value axis 2" // in a chart with multiple value axes
  }]

• Annotation anchored to a series or series point

  annotations: [{
      argument: new Date(2019, 1, 16),
      series: "Series 1"
  }]

• Annotation displayed on an axis

  annotations: [{ 
      // An annotation on the argument axis 
      argument: new Date(2019, 1, 16)
  }, { 
      // An annotation on the value axis 
      value: 15,  
      axis: "Value axis 2" // in a chart with multiple value axes
  }]

• Mixed anchoring (pixel and chart coordinates used simultaneously)

  annotations: [{
      argument: new Date(2019, 1, 16),
      y: 200
  }]

When a user long-presses an annotation or hovers the mouse pointer over it, the Chart displays a tooltip.

Objects in the annotations[] array configure individual annotations. To specify properties common for all annotations, use the commonAnnotationSettings object. Individual settings take precedence over common settings.

View Demo

See Also

• customizeAnnotation

The argumentAxis object, which is described here, configures the argument axis individually. To specify common settings for all axes in a chart, use the commonAxisSettings object. Axis-specific settings override common settings.

Point markers are hidden when:

• In a single-series chart, at least half of all point markers are overlapped by adjacent markers.
• In a multi-series chart, all point markers of a series are overlapped by adjacent markers and markers of other series.

See Also

• series.aggregation

This property accepts a value from 0 to 1 that specifies the correlation between the empty space on a bar group's sides and the group's width: 0 - the bar group occupies the whole allocated space; 1 - virtually hides the bar group creating a lot of empty space.

See Also

• Specify the Bar Width
• barPadding

A bar's maximum width is limited. In single-series charts, it cannot be greater than the interval between two major ticks. In multi-series charts, it depends on the number of bars in the parent group and this group's actual width. See the Specify the Bar Width article for more information.

See Also

• barWidth

This property accepts values from 0 to 1 excluding 0. The assigned value specifies the correlation between a bar and the empty space around it. A value close to 0 makes the bar very thin leaving a lot of space, and 1, conversely, makes the bar very thick leaving no space.

Settings specified here can be ignored in favor of individual annotation settings specified in the annotations[] array. Refer to the array's description for information on how to configure annotations.

The following code shows the commonAnnotationSettings declaration syntax:

$(function() {
    $("#chartContainer").dxChart({
        // ...
        commonAnnotationSettings: {
            tooltipEnabled: false
        }
    });
});

<dx-chart ... >
    <dx-common-annotation-settings
        [tooltipEnabled]="false">
    </dx-common-annotation-settings>
</dx-chart>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxChart ... >
        <DxCommonAnnotationSettings
            :tooltip-enabled="false"
        />
    </DxChart>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxChart, {
    DxCommonAnnotationSettings
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxCommonAnnotationSettings
    },
    data() {
        // ...
    }
}
</script>

import React from 'react';

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import Chart, {
    CommonAnnotationSettings
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <CommonAnnotationSettings
                    tooltipEnabled={false}
                />
            </Chart>
        );
    }
}
export default App;

View Demo

See Also

• customizeAnnotation

The commonAxisSettings object, which is described here, specifies common settings for all axes in a chart. To configure a particular axis, use the argumentAxis or valueAxis object. Axis-specific settings override common settings.

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

The commonPaneSettings object, which is described here, specifies common settings for all panes in the chart. To specify properties of an individual pane, use the objects of the panes array. Individual settings override common settings.

There are three ways to configure a series.

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

• The commonSeriesSettings.%seriesType% (area, line, etc.) object
  Specifies settings for all series of the seriesType.

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

If the background of your page has a color different from white, assign this color to the containerBackgroundColor property to ensure that the UI component will blend smoothly into your page. Certain UI component elements, such as series points in the hovered state, will use this color when coordinating with the page.

See Also

• panes.backgroundColor - colors the background of the chart plot.

Crosshair is a pointer represented by two mutually-crossing lines stretched over the entire chart plot. The crosshair helps a user identify the values of the series points precisely. When enabled, the crosshair follows the cursor and snaps to the nearest series point.

To enable the crosshair, set the crosshair.enabled property to true. Assign true to the crosshair.label.visible property as well to make the crosshair labels visible.

Settings specified in the crosshair object apply to both the crosshair lines. If you specify the same settings within the horizontalLine or verticalLine object, they will apply to the particular crosshair line only. Note that individual settings override common ones.

View Demo

The following code shows how to use the customizeAnnotation function to apply different settings to text and image annotations:

$(function() {
    $("#chartContainer").dxChart({
        // ...
        customizeAnnotation: function(annotationItem) {
            if(annotationItem.text) {
                annotationItem.color = "red";
            }
            if(annotationItem.image) {
                annotationItem.color = "blue";
            }
            return annotationItem;
        }
    });
});

<dx-chart ...
    [customizeAnnotation]="customizeAnnotation">
</dx-chart>

// ...
export class AppComponent {
    customizeAnnotation(annotationItem) {
        if(annotationItem.text) {
            annotationItem.color = "red";
        }
        if(annotationItem.image) {
            annotationItem.color = "blue";
        }
        return annotationItem;
    }
}

import { DxChartModule } from 'devextreme-angular';
// ...
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})
export class AppModule { }

<template> 
    <DxChart ...
        :customize-annotation="customizeAnnotation">
    </DxChart>
</template>

<script>
import DxChart from 'devextreme-vue/chart';

export default {
    components: {
        DxChart
    },
    methods: {
        customizeAnnotation(annotationItem) {
            if(annotationItem.text) {
                annotationItem.color = "red";
            }
            if(annotationItem.image) {
                annotationItem.color = "blue";
            }
            return annotationItem;
        }
    }
}
</script>

import React from 'react';
import Chart from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ...
                customizeAnnotation={this.customizeAnnotation}>
            </Chart>
        );
    }

    customizeAnnotation(annotationItem) {
        if(annotationItem.text) {
            annotationItem.color = "red";
        }
        if(annotationItem.image) {
            annotationItem.color = "blue";
        }
        return annotationItem;
    }
}

export default App;

@(Html.DevExtreme().Chart()
    @* ... *@
    .CustomizeAnnotation("customizeAnnotation")
)

<script type="text/javascript">
    function customizeAnnotation(annotationItem) {
        if(annotationItem.text) {
            annotationItem.color = "red";
        }
        if(annotationItem.image) {
            annotationItem.color = "blue";
        }
        return annotationItem;
    }
</script>

See Also

• annotations[]
• commonAnnotationSettings

All point labels in a chart are identical by default, but you can specify a unique appearance for individual labels using the customizeLabel function. This function should return an object with properties that will be changed for a certain label. See the label object for information about all properties available for changing.

The customizeLabel function accepts an object providing information about the series point that the label belongs to. This object contains the following fields.

In the range bar and range area series, the value field is replaced by the following fields.

In the financial series (candlestick and stock), the value field is replaced by the following fields.

View Demo

By default, all series points in a chart are identical, but you can specify a unique appearance for individual points using the customizePoint function. This function should return an object with properties that will be changed for a certain point. See the point object for information about all properties available for changing.

The customizePoint function accepts an object providing information about the series point. This object contains the following fields.

In the range bar and range area series, the value field is replaced by the following fields.

In the financial series (candlestick and stock), the value field is replaced by the following fields.

View Demo

The following code shows the dataPrepareSettings declaration syntax:

$(function() {
    $("#chartContainer").dxChart({
        // ...
        dataPrepareSettings: {
            sortingMethod: false
        }
    });
});

<dx-chart ... >
    <dxo-data-prepare-settings
        [sortingMethod]="false">
    </dxo-data-prepare-settings>
</dx-chart>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxChart ... >
        <DxDataPrepareSettings
            :sorting-method="false"
        />
    </DxChart>
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxChart, {
    DxDataPrepareSettings 
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxDataPrepareSettings
    },
    data() {
        // ...
    }
}
</script>

import React from 'react';

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import Chart, {
    DataPrepareSettings 
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <DataPrepareSettings
                    sortingMethod={false}
                />
            </Chart>
        );
    }
}
export default App;

If you use DevExtreme ASP.NET MVC Controls, refer to the Bind Controls to Data article.

The Chart works with collections of objects.

Depending on your data source, bind the Chart to data as follows.

• Data Array
  Assign the array to the dataSource property. View Demo

• Read-Only Data in JSON Format
  Set the dataSource property to the URL of a JSON file or service that returns JSON data. View Demo

• OData
  Implement an ODataStore.

• Web API, PHP, MongoDB
  Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

  jQuery

  JavaScript

  $(function() {
      let serviceUrl = "https://url/to/my/service";
      $("#chartContainer").dxChart({
          // ...
          dataSource: DevExpress.data.AspNet.createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      })
  });

  Angular

  app.component.ts

  app.component.html

  app.module.ts

  import { Component } from '@angular/core';
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      store: CustomStore;
      constructor() {
          let serviceUrl = "https://url/to/my/service";
          this.store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      }
  }

  <dx-chart ...
      [dataSource]="store">
  </dx-chart>

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxChartModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxChartModule
      ],
      providers: [],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template> 
      <DxChart ...
          :data-source="store" />
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.common.css';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import { DxChart } from 'devextreme-vue/chart';
  
  export default {
      components: {
          DxChart
      },
      data() {
          const serviceUrl = "https://url/to/my/service";
          const store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          });
          return {
              store
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  import 'devextreme/dist/css/dx.common.css';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import Chart from 'devextreme-react/chart';
  
  const serviceUrl = "https://url/to/my/service";
  const store = createStore({
      key: "ID",
      loadUrl: serviceUrl + "/GetAction",
      insertUrl: serviceUrl + "/InsertAction",
      updateUrl: serviceUrl + "/UpdateAction",
      deleteUrl: serviceUrl + "/DeleteAction"
  });
  
  class App extends React.Component {
      render() {
          return (
              <Chart ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the Chart always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

After providing data, bind series to it.

This property accepts the name of a pane from the panes array. The default pane displays all series with unspecified pane property. If defaultPane is undefined, the last pane in the panes array becomes the default.

If a value in a series equals to zero or is undefined, the bar visualizing this value will not be displayed on the chart making an empty space. If you need to fill this space by extending the neighbouring bars, set the equalBarWidth property to false.

These features allow a user to export your UI component into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the UI component. A click on it invokes a drop-down menu that lists exporting and printing commands. The following formats are supported for exporting into: PNG, PDF, JPEG, SVG and GIF.

See Also

• exportTo(fileName, format)
• print()
• DevExpress.viz.exportWidgets(widgetInstances, options)

The Chart UI component can include a legend - an explanatory component that helps you identify a series. Each series is represented by an item on a Legend. An item marker identifies the series color. An item label displays the series title. To set the required position for a legend and its items, to customize the font settings for item labels, and to specify the size of item markers, use the properties of the legend configuration object. To learn more on the legend and its properties, refer to the Legend topic.

When the UI component is bound to a remote data source, it can display a loading indicator while data is loading.

To enable the automatic loading indicator, set the enabled property to true.

If you want to change the loading indicator's visibility, use the show property or the showLoadingIndicator() and hideLoadingIndicator() methods.

When defining a bubble series, you are required to specify a size field. The largest size value will be represented on the chart by the largest bubble. Its visual diameter will be calculated by the following formula.

d = maxBubbleSize * min(height, width)

Normally, the height and width from this formula equal the size of the UI component container. However, when several panes are used in the UI component, the height and width equal the pane size.

When defining a bubble series, you are required to specify a size field. The smallest size value will be represented on the chart by the smallest bubble. To set its visual diameter, specify the minBubbleSize property.

Oftentimes, series data contains negative values. Visualizing such data using stacked-like series may lead to unexpected results. To prevent situations of this kind, assign true to the negativesAsZeroes property, and the UI component will count all negative values as zeroes.

See Also

• getAllSeries()
• getSeriesByName(seriesName)
• getSeriesByPos(seriesIndex)

See Also

• onExporting
• onFileSaving

See Also

• onExported
• onFileSaving

See Also

• onExporting
• onExported

The UI component notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.

The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:

• id
  The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
• type
  The incident's type: "error" or "warning".
• args
  The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the property that was not set properly.
• text
  The text passed to the browser's console. Includes the args content, if there is any.
• widget
  The name of the UI component that produced the error or warning.
• version
  The used DevExtreme version.

See Also

• Get a UI component Instance in Angular | AngularJS | Knockout | Vue | React

$(function () {
    $("#chartContainer").dxChart({
        // ...
        onLegendClick: function (e) {
            e.event.cancel = true;
        }
    });
});

import { DxChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    cancelSeriesClick (e) {
        e.event.cancel = true;
    }
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})

<dx-chart ...
    (onLegendClick)="cancelSeriesClick($event)">
</dx-chart>

<template>
    <DxChart ...
        @legend-click="cancelSeriesClick">
    </DxChart>
</template>

<script>
import DxChart from 'devextreme-vue/chart';

export default {
    components: {
        DxChart
    },
    methods: {
        cancelSeriesClick (e) {
            e.event.cancel = true;
        }
    }
}
</script>

import React from 'react';

import Chart from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ...
                onLegendClick={this.cancelSeriesClick}>
            </Chart>
        );
    }

    cancelSeriesClick (e) {
        e.event.cancel = true;
    }
}

export default App;

View Demo

The following example shows how to subscribe to component property changes:

$(function() {
    $("#chartContainer").dxChart({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-chart ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-chart>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxChartModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxChartModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxChart ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script> 
import 'devextreme/dist/css/dx.common.css'; 
import 'devextreme/dist/css/dx.light.css'; 
import DxChart from 'devextreme-vue/chart'; 

export default { 
    components: { 
        DxChart
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react'; 
import 'devextreme/dist/css/dx.common.css'; 
import 'devextreme/dist/css/dx.light.css'; 

import Chart from 'devextreme-react/chart'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Chart ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

$(function () {
    $("#chartContainer").dxChart({
        // ...
        onPointClick: function (e) {
            e.event.cancel = true;
        }
    });
});

import { DxChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    cancelSeriesClick (e) {
        e.event.cancel = true;
    }
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})

<dx-chart ...
    (onPointClick)="cancelSeriesClick($event)">
</dx-chart>

<template>
    <DxChart ...
        @point-click="cancelSeriesClick">
    </DxChart>
</template>

<script>
import DxChart from 'devextreme-vue/chart';

export default {
    components: {
        DxChart
    },
    methods: {
        cancelSeriesClick (e) {
            e.event.cancel = true;
        }
    }
}
</script>

import React from 'react';

import Chart from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ...
                onPointClick={this.cancelSeriesClick}>
            </Chart>
        );
    }

    cancelSeriesClick (e) {
        e.event.cancel = true;
    }
}

export default App;

Bar Chart Demo

To identify whether the pointer has entered or left the series point, call the point's isHovered() method.

To identify whether the selection has been applied or canceled, call the point's isSelected() method.

View Demo

To identify whether the pointer has entered or left the series, call the series' isHovered() method.

To identify whether the selection has been applied or canceled, call the series' isSelected() method.

See Also

• hideTooltip()
• Point.hideTooltip()

See Also

• Point.showTooltip()

See Also

• zoomAndPan
• onZoomStart

See Also

• zoomAndPan
• onZoomEnd

This property accepts either the name of a predefined palette or an array of colors. The array can include the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

Use the VizPalette enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Default, SoftPastel, HarmonyLight, Pastel, Bright, Soft, Ocean, Vintage, Violet, Carmine, DarkMoon, SoftBlue, DarkViolet, and GreenMist.

See Also

• Palettes
• paletteExtensionMode
• DevExpress.viz.generateColors(palette, count, options)
• series.color

The following variants are available:

• "blend"
  Create a blend of two neighboring colors and insert it between these colors in the palette.

• "alternate"
  Repeat the full set of palette colors, alternating their normal, lightened, and darkened shades in that order.

• "extrapolate"
  Repeat the full set of palette colors, changing their shade gradually from dark to light.

View Demo

Use the VizPaletteExtensionMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Blend, Alternate, and Extrapolate.

A pane is a chart area containing series. If there are many series an a chart, they can be distributed between multiple 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.

If you place the UI component on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the UI component elements may get mixed up or disappear. To solve this problem, set the pathModified property to true.

See Also

• DevExpress.viz.refreshPaths()

To set the points to highlight along with the selected point, set the series.point.selectionMode property.

To learn how to select a point, refer to the Selection Handling topic.

Use the ChartElementSelectionMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Single and Multiple.

Multiple Point Selection Demo API - Select a Point Demo

When this property is set to true, the UI component will be redrawn automatically in case the size of its parent window changes.

When users zoom the chart, axis labels can be longer. However, they are cut because their allocated space remains the same.

Enable the resizePanesOnZoom property to show the entire labels. In this case, panes are resized to allow more space for labels, and the UI component's layout is recalculated. This can make the axis shift from its position at runtime and cause an issue if you display several charts aligned side by side or under each other.

See Also

• adjustOnZoom

Series point labels display series point values. If your chart contains several series with a large number of points in each, point labels may overlap. In this case, specify how the chart must resolve overlapping using the resolveLabelOverlapping property. To hide certain labels, set this property to 'hide'. Labels to be hidden will be determined automatically. If labels that overlap belong to series points that have the same argument, you can arrange these labels in a stack. For this purpose, set the resolveLabelOverlapping property to 'stack'.

Use the ChartResolveLabelOverlapping enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: None, Hide, and Stack.

See Also

• commonAxisSettings.inverted - inverts the axes.

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

The scroll bar allows a user to pan the chart. To use it, you need to enable zooming and panning in your chart.

By default, the scroll bar is hidden. To make it visible, set the visible field of the scrollBar object to true. Using other fields of this object you can adjust the scroll bar appearance settings, including color, width and opacity.

View Demo

This property allows you to control the scrolling capability in your chart. By default, this capability is off. To make scrolling available on touch-enabled devices only, assign 'touch' to the scrollingMode property. In that case, a user will be able to scroll the chart using the flick gesture. If your chart is not supposed to be viewed on touch-enabled devices, but you still need scrolling to be enabled, assign 'mouse' to the scrollingMode property. In that case, a user will be able to scroll the chart by dragging. To enable scrolling for all devices, assign 'all' to the scrollingMode property.

Scrolling may also be performed using the scroll bar. To make it visible assign true to the visible property of the scrollBar object.

Use the ChartPointerType enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Mouse, Touch, All, and None.

View Demo

See Also

• zoomStart - an event that fires when scrolling or zooming begins.
• zoomEnd - an event that fires when scrolling or zooming ends.

A series represents a grouping of related data points. The most important characteristic of a series is its type, which determines a particular visual representation of data. You can find more details on each series type in the corresponding topics in the Series help section.

To define a single series, assign an object defining the series to the series configuration object. In the series' object, specify the series type, data source fields, the appearance of the series points and other properties.

To show several series, specify series as an array of objects defining series. If you need to set similar values to properties of several series, use the commonSeriesSettings configuration object. It exposes the properties that can be specified for all series at once and for all series of a particular type at once. Note that the values specified for a series individually (in the series array) override the values that are specified for all series (in the commonSeriesSettings object).

To set the series elements to highlight when a series is selected, set the series selectionMode property.

To learn how to select a point, refer to the Selection Handling topic.

Use the ChartElementSelectionMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Single and Multiple.

View Demo

In most cases, you can organize the array that is assigned to the chart's dataSource property in the following way.

[
    {arg: arg1Value, series1Value: val11, series2Value: val12, ...}
    {arg: arg2Value, series1Value: val21, series2Value: val22, ...}
    ...
    {arg: argNValue, series1Value: valN1, series2Value: valN2, ...}
]

Each object that is included in the array represents an argument value and the values of all series for this argument.

However, there are some scenarios in which you do not know exactly how many series will be added. In these cases, you will not be able to define the data source in the manner detailed above. Instead, define it in the following way.

[
    {seriesName: series1, arg: arg11Value, val: value11 }
    {seriesName: series1, arg: arg12Value, val: value12 }
    ...
    {seriesName: seriesM, arg: argM1Value, val: valueM1 }
    {seriesName: seriesM, arg: argM2Value, val: valueM2 }
    ...
]

If you define a data source in this manner, set the argument and value fields using the argumentField and valueField properties of the commonSeriesSettings configuration object (for all series at once). Then, define a template for the series using the seriesTemplate configuration object. Within this object, set the data source field that specifies the series name to the nameField property.

If you need to specify individual values for properties of a particular series, assign a callback function to the customizeSeries property of the seriesTemplate object.

View Demo

The UI component occupies its container's entire area by default. Use the size object to specify the UI component's size if it should be different from that of its container. Assign 0 to size object's height and width properties to hide the UI component.

$(function() {
    $("#chartContainer").dxChart({
        // ...
        size: {
            height: 300,
            width: 600
        }
    });
});

<dx-chart ... >
    <dxo-size
        [height]="300"
        [width]="600">
    </dxo-size>
</dx-chart>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxChartModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxChartModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxChart ... >
        <DxSize
            :height="300"
            :width="600"
        />
    </DxChart>
</template>

<script>

import DxChart, {
    DxSize
} from 'devextreme-vue/chart';

export default {
    components: {
        DxChart,
        DxSize
    },
    // ...
}
</script>

import React from 'react';

import Chart, {
    Size
} from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ... >
                <Size
                    height={300}
                    width={600}
                />
            </Chart>
        );
    }
}
export default App;

Alternatively, you can style the UI component's container using CSS:

$(function() {
    $("#chart").dxChart({
        // ...
    });
});

#chart {
    width: 85%;
    height: 70%;
}

<dx-chart ...
    id="chart">
</dx-chart>

#chart {
    width: 85%;
    height: 70%;
}

<template>
    <DxChart ...
        id="chart">
    </DxChart>
</template>

<script>
import DxChart from 'devextreme-vue/chart';

export default {
    components: {
        DxChart
    },
    // ...
}
</script>

<style>
#chart {
    width: 85%;
    height: 70%;
}
</style>

import React from 'react';

import Chart from 'devextreme-react/chart';

class App extends React.Component {
    render() {
        return (
            <Chart ...
                id="chart">
            </Chart>
        );
    }
}
export default App;

#chart {
    width: 85%;
    height: 70%;
}

When this property is true, a point remains in the hover state until the mouse pointer moves over to another point or outside the chart plot.

When this property is false, a point remains in the hover state until the mouse pointer moves away from the point.

View Demo

See Also

• series.point.hoverMode

When synchronized, the ticks (or grid lines) of all the value axes in a pane are located on the same line.

A theme is a UI component configuration that gives the UI component a distinctive appearance. Use can use one of the predefined themes or create a custom one. Changing the property values in the UI component's configuration object overrides the theme's corresponding values.

Use the VizTheme enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, GenericCarmine, GenericDarkMoon, GenericSoftBlue, GenericDarkViolet, GenericGreenMist, MaterialBlueLight, MaterialLimeLight, MaterialOrangeLight, MaterialPurpleLight, MaterialTealLight.

The UI component's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title property. Otherwise, set this property to an object with the text and other fields specified.

The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.

View Demo

A tooltip is a miniature rectangle displaying values of a series point. A tooltip appears when the end-user hovers the cursor over a series point. You can enable/disable tooltips, change their appearance and format their text using fields of the tooltip configuration object.

By default, a chart displays all series points. But there may be situations when displaying all the series points may affect chart performance. In this case, it is better to aggregate the series points rather than display all of them. For this purpose, set the useAggregation property to true. The aggregation is based on the median filter algorithm.

The valueAxis object, which is described here, configures the value axis individually. To specify common settings for all axes in a chart, use the commonAxisSettings object. Axis-specific settings override common settings.

View Demo

You can enable zooming and panning for the argument and value axes independently. Set the argumentAxis and valueAxis properties to enable zooming, panning, or both for a specific axis.

Users can use the mouse and touch gestures to zoom and pan. The following table illustrates user interaction:

You can use the allowTouchGestures or allowMouseWheel property to disable touch or mouse support.

Users can also use the mouse to zoom the chart by selecting an area with the drag gesture. Refer the dragToZoom property for more information.

Zooming and panning are related to the visual/whole range concept. Refer to the Visual and Whole Ranges article for more information.

View Demo

See Also

• Zooming and Panning
• onZoomStart | onZoomEnd
• argumentAxis.visualRange | valueAxis.visualRange

This property allows you to control the zooming capability in your chart. By default, this capability is off. To make zooming available on touch-enabled devices only, assign 'touch' to the zoomingMode property. In that case, a user will be able to zoom in/out of the chart using the spread/pinch gesture. If your chart is not supposed to be viewed on touch-enabled devices, but you still need zooming to be enabled, assign 'mouse' to the zoomingMode property. In this case, a user will be able to zoom the chart by rolling the mouse wheel. To enable zooming for all devices, assign 'all' to the zoomingMode property.

Use the ChartPointerType enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Mouse, Touch, All, and None.

View Demo

See Also

• argumentAxis.visualRange | valueAxis.visualRange
• Axis.visualRange(visualRange)
• onZoomStart | onZoomEnd