JavaScript/jQuery Sankey Methods
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
dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#mySankey").dxSankey("dispose");
$("#mySankey").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
<dx-sankey ...
*ngIf="condition">
</dx-sankey>Vue
<template>
<DxSankey ...
v-if="condition">
</DxSankey>
</template>
<script>
import DxSankey from 'devextreme-vue/sankey';
export default {
components: {
DxSankey
}
}
</script>React
import React from 'react';
import Sankey from 'devextreme-react/sankey';
function DxSankey(props) {
if (!props.shouldRender) {
return null;
}
return (
<Sankey ... >
</Sankey>
);
}
class App extends React.Component {
render() {
return (
<DxSankey shouldRender="condition" />
);
}
}
export default App;See Also
getDataSource()
Gets the DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Sankey instance found in an element with the mySankey ID:
// Modular approach
import Sankey from "devextreme/viz/sankey";
...
let element = document.getElementById("mySankey");
let instance = Sankey.getInstance(element) as Sankey;
// Non-modular approach
let element = document.getElementById("mySankey");
let instance = DevExpress.viz.dxSankey.getInstance(element);See Also
hideTooltip()
See Also
- Node.showTooltip()
- Link.showTooltip()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout
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.