React Chart Methods

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

See Also

beginUpdate()

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

The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component 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.

After calling this method, remove the DOM element associated with the UI component:

JavaScript
$("#myChart").dxChart("dispose");
$("#myChart").remove();

Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular
app.component.html
<dx-chart ...
    *ngIf="condition">
</dx-chart>
Vue
App.vue
<template>
    <DxChart ...
        v-if="condition">
    </DxChart>
</template>

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

export default {
    components: {
        DxChart
    }
}
</script>
React
App.js
import React from 'react';

import Chart from 'devextreme-react/chart';

function DxChart(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <Chart ... >    
        </Chart>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxChart shouldRender="condition" />
        );
    }
}
export default App;
See Also

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

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

See Also

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports the UI component.

Parameters:
fileName:

String

The name of the file to which the UI component 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.

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 UI component's dataSource property was given a simple array.
See Also

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:
element:

DOM Node

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

getInstance is a static method that the UI component 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 UI component size.

Return Value:

Size

The current UI component size.

Returns an object with the following fields.

  • width
    The width of the UI component in pixels.
  • height
    The height of the UI component 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 UI component is ready, you can hide it from code at the required moment using this method.

See Also

hideTooltip()

Hides all UI component tooltips.

Use this method to hide all UI component tooltips programmatically.

See Also

instance()

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

Return Value:

Chart

This UI component'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 UI component properties.

Return Value:

Object

The UI component's properties.

See Also

option(optionName)

Gets the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

Return Value: any

This property's value.

See Also

option(optionName, optionValue)

Updates the value of a single property.

Parameters:
optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

See Also

option(options)

Updates the values of several properties.

Parameters:
options:

Object

Propertieswith their new values.

See Also

print()

Opens the browser's print window.

View Demo

See Also

refresh()

Reloads data and repaints the UI component.

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

See Also

render()

Redraws the UI component.

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

See Also

render(renderOptions)

Redraws the UI component.

Parameters:
renderOptions:

Object

Rendering properties.

You can call the render method without parameters after the size or visibility of the UI component 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 UI component without animation
}
See Also

resetOption(optionName)

Resets an property to its default value.

Parameters:
optionName:

String

An property's name.

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 UI component's SVG markup.

Return Value:

String

The UI component's SVG markup.

View Demo

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.