React Chart Methods
This section describes the methods that can be used in code to manipulate the UI component.
See Also
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
clearSelection()
Deselects the chart's selected series. The series is displayed in an initial style.
See Also
dispose()
Disposes of all the resources allocated to the Chart instance.
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myChart").dxChart("dispose");
$("#myChart").remove();Angular
Use conditional rendering instead of this method:
<dx-chart ...
*ngIf="condition">
</dx-chart>Vue
Use conditional rendering instead of this method:
<template>
<DxChart ...
v-if="condition">
</DxChart>
</template>
<script>
import DxChart from 'devextreme-vue/chart';
export default {
components: {
DxChart
}
}
</script>React
Use conditional rendering instead of this method:
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;element()
Gets the root UI component element.
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.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getArgumentAxis()
Gets the argument axis.
The argument axis.
See Also
- getValueAxis()
- Series.getArgumentAxis()
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
getInstance(element)
Gets the instance of a UI component found using its DOM node.
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.
The series' name.
See Also
getSize()
Gets the current UI component size.
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.
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
- getArgumentAxis()
- Series.getValueAxis()
getValueAxis(name)
Gets a value axis with the specified name.
A value axis's name.
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.
This UI component's instance.
See Also
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
on(eventName, eventHandler)
Subscribes to an event.
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.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
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(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
option(options)
Updates the values of several properties.
Options with their new values.
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.
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.
var renderOptions = {
force: true, // forces redrawing
animate: false // redraws the UI component without animation
}See Also
resetOption(optionName)
Resets a property to its default value.
A property's name.
See Also
resetVisualRange()
Resets the visual ranges of both axes to the data range or the whole range if it is within the data range.
See Also
- Visual and Whole Ranges
- argumentAxis.visualRange | valueAxis.visualRange
- Axis.visualRange(visualRange)
zoomArgument(startValue, endValue)
Sets the argument axis' start and end values.
If you have technical questions, please create a support ticket in the DevExpress Support Center.