JavaScript/jQuery Funnel Methods
This section describes the methods that control the Funnel 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()
Cancels the selection of all funnel items.
See onItemClick to learn how to implement selection.
See Also
dispose()
Disposes of all the resources allocated to the Funnel instance.
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myFunnel").dxFunnel("dispose");
$("#myFunnel").remove();Angular
Use conditional rendering instead of this method:
<dx-funnel ...
*ngIf="condition">
</dx-funnel>Vue
Use conditional rendering instead of this method:
<template>
<DxFunnel ...
v-if="condition">
</DxFunnel>
</template>
<script>
import DxFunnel from 'devextreme-vue/funnel';
export default {
components: {
DxFunnel
}
}
</script>React
Use conditional rendering instead of this method:
import React from 'react';
import Funnel from 'devextreme-react/funnel';
function DxFunnel(props) {
if (!props.shouldRender) {
return null;
}
return (
<Funnel ... >
</Funnel>
);
}
class App extends React.Component {
render() {
return (
<DxFunnel 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.
Main article: beginUpdate()
See Also
getAllItems()
Provides access to all funnel items.
A collection of Item objects.
See Also
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 Funnel instance found in an element with the myFunnel ID:
// Modular approach
import Funnel from "devextreme/viz/funnel";
...
let element = document.getElementById("myFunnel");
let instance = Funnel.getInstance(element) as Funnel;
// Non-modular approach
let element = document.getElementById("myFunnel");
let instance = DevExpress.viz.dxFunnel.getInstance(element);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
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
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
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
resetOption(optionName)
Resets a property to its default value.
A property's name.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.