Angular Chart API

The Chart is a widget that visualizes data from a local or remote storage using a great variety of series types along with different interactive elements, such as tooltips, crosshair pointer, legend, etc.

import { DxChartModule } from "devextreme-angular"

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the Chart widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

JavaScript

HTML

var fruits = [
    { fruit: 'Oranges', yield: 10, consumed: 7 },
    { fruit: 'Apples', yield: 15, consumed: 14 },
    { fruit: 'Bananas', yield: 9, consumed: 9 }
];
$(function() {
    $("#chart").dxChart({
        dataSource: fruits,
        commonSeriesSettings: {
            argumentField: "fruit",
            type: "bar"
        },
        series: [
            { valueField: "yield" },
            { valueField: "consumed" }
        ]
    });
});

<div id="chart"></div>

Angular

HTML

TypeScript

<dx-chart [dataSource]="fruits">
    <dxo-common-series-settings
        argumentField="fruit"
        type="bar">
    </dxo-common-series-settings>
    <dxi-series valueField="yield"></dxi-series>
    <dxi-series valueField="consumed"></dxi-series>
</dx-chart>

import { DxChartModule } from 'devextreme-angular';
// ...
export class AppComponent {
    fruits = [
        { fruit: 'Oranges', yield: 10, consumed: 7 },
        { fruit: 'Apples', yield: 15, consumed: 14 },
        { fruit: 'Bananas', yield: 9, consumed: 9 }  
    ];
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})

AngularJS

HTML

JavaScript

<div ng-controller="DemoController">
    <div dx-chart="{
        dataSource: fruits,
        commonSeriesSettings: {
            argumentField: 'fruit',
            type: 'bar'
        },
        series: [
            { valueField: 'yield' },
            { valueField: 'consumed' }
        ]
    }"></div>
</div>

angular.module('DemoApp', ['dx'])
    .controller("DemoController", function ($scope) {
        $scope.fruits = [
            { fruit: 'Oranges', yield: 10, consumed: 7 },
            { fruit: 'Apples', yield: 15, consumed: 14 },
            { fruit: 'Bananas', yield: 9, consumed: 9 } 
        ];
    });

Knockout

HTML

JavaScript

<div data-bind="dxChart: {
    dataSource: fruits,
    commonSeriesSettings: {
        argumentField: 'fruit',
        type: 'bar'
    },
    series: [
        { valueField: 'yield' },
        { valueField: 'consumed' }
    ]
}"></div>

var viewModel = {
    fruits: [
        { fruit: 'Oranges', yield: 10, consumed: 7 },
        { fruit: 'Apples', yield: 15, consumed: 14 },
        { fruit: 'Bananas', yield: 9, consumed: 9 }
    ]
};
ko.applyBindings(viewModel);

ASP.NET MVC Controls

Razor C#

Razor VB

@(Html.DevExtreme().Chart()
    .ID("chart")
    .DataSource(new[] {
        new { Fruit = "Oranges", Yield = 10, Consumed = 7 },
        new { Fruit = "Apples", Yield = 15, Consumed = 14 },
        new { Fruit = "Bananas", Yield = 9, Consumed = 9 }
    })
    .CommonSeriesSettings(c => c
        .ArgumentField("Fruit")
        .Type(SeriesType.Bar)
    )
    .Series(series => {
        series.Add().ValueField("Yield");
        series.Add().ValueField("Consumed");
    })
)

@(Html.DevExtreme().Chart() _
    .ID("chart") _
    .DataSource({
        New With { .Fruit = "Oranges", .Yield = 10, .Consumed = 7 },
        New With { .Fruit = "Apples", .Yield = 15, .Consumed = 14 },
        New With { .Fruit = "Bananas", .Yield = 9, .Consumed = 9 }
    }) _
    .CommonSeriesSettings(Sub(c)
        c.ArgumentField("Fruit") _
            .Type(SeriesType.Bar)
    End Sub) _
    .Series(Sub(series)
        series.Add().ValueField("Yield")
        series.Add().ValueField("Consumed")
    End Sub)
)

View Demo

Properties

This section describes properties that configure the contents, behavior and appearance of the Chart widget.

Name	Description
adaptiveLayout	Specifies adaptive layout options.
adjustOnZoom	Specifies whether or not to adjust the value axis when zooming the widget.
animation	Specifies animation options.
argumentAxis	Configures the argument axis.
barWidth	Controls the width of bars in the widget. Applies only to bar-like series and when the equalBarWidth option is true.
commonAxisSettings	Defines common settings for both the argument and value axis in a chart.
commonPaneSettings	Defines common settings for all panes in a chart.
commonSeriesSettings	Specifies settings common for all series in the chart.
containerBackgroundColor	Colors the background of the chart container.
crosshair	Configures the crosshair feature.
customizeLabel	Customizes the appearance of an individual point label.
customizePoint	Customizes the appearance of an individual series point.
dataPrepareSettings	Processes data before visualizing it.
dataSource	Specifies the widget's data origin.
defaultPane	Specifies which pane should be used by default.
elementAttr	Specifies the attributes to be attached to the widget's root element.
equalBarWidth	Specifies whether all bars should have equal width, even if some values are missing from a series. Applies only to bar-like series.
export	Configures the exporting and printing features.
legend	Specifies the options of a chart's legend.
loadingIndicator	Configures the loading indicator.
margin	Generates space around the widget.
maxBubbleSize	Specifies a coefficient determining the diameter of the largest bubble.
minBubbleSize	Specifies the diameter of the smallest bubble measured in pixels.
negativesAsZeroes	Forces the widget to treat negative values as zeroes. Applies to stacked-like series only.
onArgumentAxisClick	A handler for the argumentAxisClick event.
onDisposing	A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
onDone	A function that is executed when all series are ready.
onDrawn	A function that is executed when the widget's rendering has finished.
onExported	A handler for the exported event. Executed after data from the widget is exported.
onExporting	A handler for the exporting event. Executed before data from the widget is exported.
onFileSaving	A handler for the fileSaving event. Executed before a file with exported data is saved on the user's local storage.
onIncidentOccurred	A handler for the incidentOccurred event. Executed when an error or warning appears in the widget.
onInitialized	A handler for the initialized event. Executed only once, after the widget is initialized.
onLegendClick	A handler for the legendClick event.
onOptionChanged	A handler for the optionChanged event. Executed after an option of the widget is changed.
onPointClick	A handler for the pointClick event.
onPointHoverChanged	A handler for the pointHoverChanged event.
onPointSelectionChanged	A handler for the pointSelectionChanged event.
onSeriesClick	A handler for the seriesClick event.
onSeriesHoverChanged	A handler for the seriesHoverChanged event.
onSeriesSelectionChanged	A handler for the seriesSelectionChanged event.
onTooltipHidden	A handler for the tooltipHidden event.
onTooltipShown	A handler for the tooltipShown event.
onZoomEnd	A handler for the zoomEnd event.
onZoomStart	A handler for the zoomStart event.
palette	Sets the name of the palette to be used in the chart. Alternatively, an array of colors can be set as a custom palette to be used within this chart.
panes	Declares a collection of panes.
pathModified	Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path.
pointSelectionMode	Specifies whether a single point or multiple points can be selected in the chart.
redrawOnResize	Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.
resolveLabelOverlapping	Specifies how the chart must behave when series point labels overlap.
rotated	Swaps the axes around making the value axis horizontal and the argument axis vertical.
rtlEnabled	Switches the widget to a right-to-left representation.
scrollBar	Specifies the settings of the scroll bar.
scrollingMode	Enables scrolling in your chart.
series	Specifies options for Chart widget series.
seriesSelectionMode	Specifies whether a single series or multiple series can be selected in the chart.
seriesTemplate	Defines options for the series template.
size	Specifies the widget's size in pixels.
synchronizeMultiAxes	Indicates whether or not to synchronize value axes when they are displayed on a single pane.
theme	Sets the name of the theme the widget uses.
title	Configures the widget's title.
tooltip	Configures tooltips.
useAggregation	Specifies whether or not to filter the series points depending on their quantity.
valueAxis	Configures the value axis.
zoomingMode	Enables zooming in your chart.

Methods

This section describes the methods that can be used in code to manipulate the widget.

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
clearSelection()	Deselects the chart's selected series. The series is displayed in an initial style.
dispose()	Disposes of all the resources allocated to the Chart instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
exportTo(fileName, format)	Exports the widget.
getAllSeries()	Gets all the series.
getDataSource()	Gets the DataSource instance.
getInstance(element)	Gets the instance of a widget found using its DOM node.
getSeriesByName(seriesName)	Gets a series with a specific name.
getSeriesByPos(seriesIndex)	Gets a series with a specific index.
getSize()	Gets the current widget size.
hideLoadingIndicator()	Hides the loading indicator.
hideTooltip()	Hides all widget tooltips.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
print()	Opens the browser's print window.
render()	Redraws the widget.
render(renderOptions)	Redraws the widget.
showLoadingIndicator()	Shows the loading indicator.
svg()	Gets the widget's SVG markup.
zoomArgument(startValue, endValue)	Sets the argument axis' start and end values.

Events

This section describes events fired by this widget.

Name	Description
argumentAxisClick	Fires when a user clicks a label on the argument axis.
disposing	Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
done	Raised when all series are ready.
drawn	Raised when the widget's rendering has finished.
exported	Raised after data from the widget is exported.
exporting	Raised before data from the widget is exported.
fileSaving	Raised before a file with exported data is saved on the user's local storage.
incidentOccurred	Raised when an error or warning appears in the widget.
initialized	Raised only once, after the widget is initialized.
legendClick	Fires when an item on the chart legend is clicked.
optionChanged	Raised after a widget option is changed.
pointClick	Fires when a user clicks a series point.
pointHoverChanged	Fires when the hover state of a series point has been changed.
pointSelectionChanged	Fires when the selection state of a series point has been changed.
seriesClick	Fires when a user clicks a series.
seriesHoverChanged	Fires when the hover state of a series has been changed.
seriesSelectionChanged	Fires when the selection state of a series has been changed.
tooltipHidden	Fires when a point's tooltip becomes hidden.
tooltipShown	Fires when a point's tooltip appears.
zoomEnd	Fires when zooming or scrolling ends.
zoomStart	Fires when zooming or scrolling begins.

Series Types

This section lists objects that define options used to configure series of specific types.

Name	Description
AreaSeries	Describes settings supported by a series of the area type.
BarSeries	Describes settings supported by a series of the bar type.
BubbleSeries	Describes settings supported by a series of the bubble type.
CandleStickSeries	Describes settings supported by a series of the candlestick type.
FullStackedAreaSeries	Describes settings supported by a series of the full-stacked area type.
FullStackedBarSeries	Describes settings supported by a series of the full-stacked bar type.
FullStackedLineSeries	Describes settings supported by a series of the full-stacked line type.
FullStackedSplineAreaSeries	Describes settings supported by a series of the full-stacked spline area type.
FullStackedSplineSeries	Describes settings supported by a series of the full-stacked spline area type. An object defining a series of the fullStackedSpline type.
LineSeries	Describes settings supported by a series of the line type.
RangeAreaSeries	Describes settings supported by a series of the range area type.
RangeBarSeries	Describes settings supported by a series of the range bar type.
ScatterSeries	Describes settings supported by a series of the scatter type.
SplineAreaSeries	Describes settings supported by a series of the spline area type.
SplineSeries	Describes settings supported by a series of the spline type.
StackedAreaSeries	Describes settings supported by a series of the stacked area type.
StackedBarSeries	Describes settings supported by a series of the stacked bar type.
StackedLineSeries	Describes settings supported by a series of the stacked line type.
StackedSplineAreaSeries	Describes settings supported by a series of the stacked spline area type.
StackedSplineSeries	Describes settings supported by a series of the stacked spline type.
StepAreaSeries	Describes settings supported by a series of the step rea type.
StepLineSeries	Describes settings supported by a series of the step line type.
StockSeries	Describes settings supported by a series of the stock type.

Type:

Object

Chart Elements

This section describes chart elements.

Angular Chart API

jQuery

Angular

AngularJS

Knockout

ASP.NET MVC Controls

See Also

Properties

Methods

See Also

Events

See Also

Series Types

Chart Elements