JavaScript/jQuery Chart Methods

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

See Also

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

clearSelection()

Deselects the chart's selected series. The series is displayed in an initial style.

To learn about series selection, refer to the Selection Handling help section.

See Also

dispose()

Disposes of all the resources allocated to the Chart instance.

The following code disposes of an Chart instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:

jQuery
JavaScript
$("#myChart").dxChart("dispose");
$("#myChart").remove();
Angular
HTML
<dx-chart #chartVar id="myChart"></dx-chart>
TypeScript
import { ..., ViewChild } from "@angular/core";
import { DxChartComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("chartVar") chart: DxChartComponent;

    removeChart (e) {
        this.chart.instance.dispose();
        document.getElementById("myChart").remove();
    }
}

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports the widget.

Parameters:
fileName:

String

The name of the file to which the widget is about to be exported.

format:

String

The file's format. One of 'PNG', 'PDF', 'JPEG', 'SVG' and 'GIF'.
PNG is used if the browser does not support exporting to the specified format.

NOTE
Safari on Mac OS does not implement an API for saving files, but you can set up a server-side proxy.

View Demo

See Also

getAllSeries()

Gets all the series.

Return Value:

Array<Series>

The Series objects.

See Also

getArgumentAxis()

Gets the argument axis.

Return Value:

Chart Axis

The argument axis.

See Also

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE
This method returns the DataSource instance even if the widget's dataSource option was given a simple array.
See Also

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:
element:

DOM Node

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

getInstance is a static method that the widget class supports. The following code demonstrates how to get the Chart instance found in an element with the myChart ID:

// Modular approach
import Chart from "devextreme/viz/chart";
...
let element = document.getElementById("myChart");
let instance = Chart.getInstance(element) as Chart;

// Non-modular approach
let element = document.getElementById("myChart");
let instance = DevExpress.viz.dxChart.getInstance(element);
See Also

getSeriesByName(seriesName)

Gets a series with a specific name.

Parameters:
seriesName: any

The series' name.

Return Value:

Series

The Series object; null if nothing is found.

See Also

getSeriesByPos(seriesIndex)

Gets a series with a specific index.

Parameters:
seriesIndex:

Number

The series' index.

Return Value:

Series

The Series object.

See Also

getSize()

Gets the current widget size.

Return Value:

Size

The current widget size.

Returns an object with the following fields.

  • width
    The width of the widget in pixels.
  • height
    The height of the widget in pixels.
See Also

getValueAxis()

Gets a value axis.

Return Value:

Chart Axis

A value axis. The first axis from the valueAxis array in a multi-axis chart, and the defaultPane's value axis in a multi-pane chart.

See Also

getValueAxis(name)

Gets a value axis with the specified name.

Parameters:
name:

String

A value axis's name.

Return Value:

Chart Axis

A value axis with the specified name.

See Also

hideLoadingIndicator()

Hides the loading indicator.

Although the loading indicator hides automatically once the widget is ready, you can hide it from code at the required moment using this method.

See Also

hideTooltip()

Hides all widget tooltips.

Use this method to hide all widget tooltips programmatically.

See Also

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value:

Chart

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

Chart

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Chart

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Chart

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

Chart

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Gets all widget options.

Return Value:

Object

The widget's options.

See Also

option(optionName)

Gets the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's value.

See Also

option(optionName, optionValue)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

See Also

option(options)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

See Also

print()

Opens the browser's print window.

View Demo

See Also

refresh()

Reloads data and repaints the widget.

The widget cannot track changes a third party makes in the data source. Call this method to update data in the widget in this case.

See Also

render()

Redraws the widget.

Normally, the widget redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the widget's container is resized. For this purpose, call the render() method.

See Also

render(renderOptions)

Redraws the widget.

Parameters:
renderOptions:

Object

Rendering options.

You can call the render method without parameters after the size or visibility of the widget container is changed. Alternatively, call the render method passing an object as the parameter. This object must contain the force field set to 'true'. In addition, you can use this object to specify whether or not to perform animation on redrawing with the animate field.

The following code sample illustrates the example of the object that can be passed to the render method.

JavaScript
var renderOptions = {
    force: true, // forces redrawing
    animate: false // redraws the widget without animation
}
See Also

resetVisualRange()

Resets the visual ranges of both axes to the data range or to the whole range if it is within the data range.

See Also

showLoadingIndicator()

Shows the loading indicator.

See Also

svg()

Gets the widget's SVG markup.

Return Value:

String

The widget's SVG markup.

See Also

zoomArgument(startValue, endValue)

Sets the argument axis' start and end values.

Parameters:
startValue:

Number

|

Date

|

String

A new start value.

endValue:

Number

|

Date

|

String

A new end value.

NOTE
This method is kept for backward compatibility and its use is not recommended. Use the Axis object's visualRange(visualRange) method instead.