JavaScript/jQuery Chart Methods
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
dispose()
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;
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
getDataSource()
Gets the DataSource instance.
See Also
getInstance(element)
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
getSize()
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()
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.
hideLoadingIndicator()
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
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
refresh()
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()
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)
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
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
- Visual and Whole Ranges
- argumentAxis.visualRange | valueAxis.visualRange
- Axis.visualRange(visualRange)