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()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#mySankey").dxSankey("dispose");
$("#mySankey").remove();Angular
Use conditional rendering instead of this method:
<dx-sankey ...
*ngIf="condition">
</dx-sankey>Vue
Use conditional rendering instead of this method:
<template>
<DxSankey ...
v-if="condition">
</DxSankey>
</template>
<script>
import DxSankey from 'devextreme-vue/sankey';
export default {
components: {
DxSankey
}
}
</script>React
Use conditional rendering instead of this method:
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;endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
Main article: beginUpdate()
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 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
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
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
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.