This section describes properties that configure the Funnel UI component's contents, behavior and appearance.
Specifies adaptive layout properties.
Selector: DxAdaptiveLayout
The adaptive layout enables the UI component to hide optional elements if they do not fit in the container. Elements are hidden in the following sequence:
Use the height and width properties in the adaptiveLayout object to specify the minimum container size at which the layout begins to adapt.
See AlsoSpecifies the algorithm for building the funnel.
Default Value: 'dynamicSlope'
Two algorithms are available:
"dynamicSlope"
Each funnel item's form depends on the ratio between the current and the next item's value.
"dynamicHeight"
The height of each funnel item is proportional to the item's value. This algorithm produces a pyramid which is upturned by default. You can return it to normal by assigning true to the inverted property. You can also transform the pyramid's peak into a funnel's neck using the neckHeight and neckWidth properties.
Specifies which data source field provides arguments for funnel items. The argument identifies a funnel item and represents it on the legend.
Selector: argument-field
Default Value: 'arg'
Specifies which data source field provides colors for funnel items. If this field is absent, the palette provides the colors.
Selector: color-field
Default Value: 'color'
Binds the UI component to data.
Selector: data-source
Cannot be used in themes.
The Funnel works with collections of objects.
Depending on your data source, bind Funnel to data as follows. In each case, also specify the argumentField, valueField, and optionally colorField properties.
Data Array
Assign the array to the dataSource option. View Demo
Read-Only Data in JSON Format
Set the dataSource property to the URL of a JSON file or service that returns JSON data.
OData
Implement an ODataStore.
Web API, PHP, MongoDB
Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:
Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.
jQuery$(function() { let serviceUrl = "https://url/to/my/service"; $("#funnelContainer").dxFunnel({ // ... dataSource: DevExpress.data.AspNet.createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) }) });Angular
import { Component } from '@angular/core'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { store: CustomStore; constructor() { let serviceUrl = "https://url/to/my/service"; this.store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) } }
<dx-funnel ... [dataSource]="store"> </dx-funnel>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFunnelModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxFunnelModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxFunnel ... :data-source="store" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import { DxFunnel } from 'devextreme-vue/funnel'; export default { components: { DxFunnel }, data() { const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); return { store } } } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import Funnel from 'devextreme-react/funnel'; const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); class App extends React.Component { render() { return ( <Funnel ... dataSource={store} /> ); } } export default App;
Any other data source
Implement a CustomStore.
Regardless of the data source on the input, the Funnel always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.
Review the following notes about data binding:
If you wrap the store into the DataSource object explicitly, set the paginate property to false to prevent data from partitioning.
Field names cannot be equal to this
and should not contain the following characters: .
, :
, [
, and ]
.
Funnel does not execute dataSource.sort functions. To implement custom sorting logic, implement columns[].calculateSortValue.
Specifies whether the UI component responds to user interaction.
Default Value: false
Cannot be used in themes.
Specifies the global attributes to be attached to the UI component's container element.
Selector: DxElementAttr
Default Value: {}
jQuery$(function(){ $("#funnelContainer").dxFunnel({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });Angular
<dx-funnel ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-funnel>
import { DxFunnelModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxFunnelModule ], // ... })Vue
<template> <DxFunnel ... :element-attr="funnelAttributes"> </DxFunnel> </template> <script> import DxFunnel from 'devextreme-vue/funnel'; export default { components: { DxFunnel }, data() { return { funnelAttributes: { id: 'elementId', class: 'class-name' } } } } </script>React
import React from 'react'; import Funnel from 'devextreme-react/funnel'; class App extends React.Component { funnelAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <Funnel ... elementAttr={this.funnelAttributes}> </Funnel> ); } } export default App;
Configures the exporting and printing features.
Selector: DxExport
Type: viz/core/base_widget:BaseWidgetExport
Specifies whether funnel items change their style when a user pauses on them.
Selector: hover-enabled
Default Value: true
Turns the funnel upside down.
Configures funnel items' appearance.
Configures funnel item labels.
Configures the legend.
The legend is a component that helps a user identify funnel items. The legend contains several items, one per funnel item, each consisting of a colored marker and text showing the funnel item's argument.
You can make the legend visible by setting the legend.visible property to true.
Configures the loading indicator.
Selector: DxLoadingIndicator
Type: viz/core/base_widget:BaseWidgetLoadingIndicator
When the UI component is bound to a remote data source, it can display a loading indicator while data is loading.
To enable the automatic loading indicator, set the enabled property to true.
If you want to change the loading indicator's visibility, use the show property or the showLoadingIndicator() and hideLoadingIndicator() methods.
Generates space around the UI component.
Selector: DxMargin
Type: viz/core/base_widget:BaseWidgetMargin
jQuery$(function() { $("#funnelContainer").dxFunnel({ // ... margin: { top: 20, bottom: 20, left: 30, right: 30 } }); });Angular
<dx-funnel ... > <dxo-margin [top]="20" [bottom]="20" [left]="30" [right]="30"> </dxo-margin> </dx-funnel>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFunnelModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxFunnelModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxFunnel ... > <DxMargin :top="20" :bottom="20" :left="30" :right="30" /> </DxFunnel> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxFunnel, { DxMargin } from 'devextreme-vue/funnel'; export default { components: { DxFunnel, DxMargin }, // ... } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import Funnel, { Margin } from 'devextreme-react/funnel'; class App extends React.Component { render() { return ( <Funnel ... > <Margin top={20} bottom={20} left={30} right={30} /> </Funnel> ); } } export default App;
Specifies the ratio between the height of the neck and that of the whole funnel. Accepts values from 0 to 1. Applies only if the algorithm is "dynamicHeight".
Selector: neck-height
Default Value: 0
Specifies the ratio between the width of the neck and that of the whole funnel. Accepts values from 0 to 1. Applies only if the algorithm is "dynamicHeight".
Selector: neck-width
Default Value: 0
A function that is executed before the UI component is disposed of.
Selector: @disposing
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed when the UI component's rendering has finished.
Selector: @drawn
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
A function that is executed after the UI component is exported.
Selector: @exported
Function parameters:Information about the event.
Object structure:
Default Value: null
A function that is executed before the UI component is exported.
Selector: @exporting
Function parameters:Information about the event.
Object structure:
Name Type Description formatThe resulting file format. One of PNG, PDF, JPEG, SVG and GIF.
fileNameThe name of the file to which the UI component is about to be exported.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
Default Value: null
A function that is executed before a file with exported UI component is saved to the user's local storage.
Selector: @file-saving
Function parameters:Information about the event.
Object structure:
Name Type Description formatThe format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'
The name of the file to be saved.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
dataExported data as a BLOB.
componentThe UI component's instance.
cancelAllows you to prevent file saving.
Default Value: null
A function that is executed after the pointer enters or leaves a funnel item.
Selector: @hover-changed
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
To identify whether the pointer has entered or left the funnel item, call the item's isHovered() method.
A function that is executed when an error or warning occurs.
Selector: @incident-occurred
Function parameters:Information about the event.
Object structure:
Default Value: null
The UI component notifies you of errors and warnings by passing messages to the browser console. Each message contains the incident's ID, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found.
The onIncidentOccurred function allows you to handle errors and warnings the way you require. The object passed to it contains the target field. This field provides information about the occurred incident and contains the following properties:
A function used in JavaScript frameworks to save the UI component instance.
Selector: @initialized
Function parameters:Information about the event.
Object structure:
Default Value: null
Angular<dx-funnel ... (onInitialized)="saveInstance($event)"> </dx-funnel>
import { Component } from "@angular/core"; import Funnel from "devextreme/ui/data_grid"; // ... export class AppComponent { funnelInstance: Funnel; saveInstance (e) { this.funnelInstance = e.component; } }Vue
App.vue (Composition API)
<template> <div> <DxFunnel ... @initialized="saveInstance"> </DxFunnel> </div> </template> <script> import DxFunnel from 'devextreme-vue/funnel'; export default { components: { DxFunnel }, data: function() { return { funnelInstance: null }; }, methods: { saveInstance: function(e) { this.funnelInstance = e.component; } } }; </script>
<template> <div> <DxFunnel ... @initialized="saveInstance"> </DxFunnel> </div> </template> <script setup> import DxFunnel from 'devextreme-vue/funnel'; let funnelInstance = null; const saveInstance = (e) => { funnelInstance = e.component; } </script>React
import Funnel from 'devextreme-react/funnel'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.funnelInstance = e.component; } render() { return ( <div> <Funnel onInitialized={this.saveInstance} /> </div> ); } }See Also jQuery
A function that is executed when a funnel item is clicked or tapped.
Selector: @item-click
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
This function is often used to implement item selection as shown in the following code:
jQuery$(function () { $("#funnelContainer").dxFunnel({ // ... onItemClick: function (e) { e.item.select(!e.item.isSelected()) } }); });Angular
<dx-funnel ... (onItemClick)="selectItem($event)"> </dx-funnel>
import { DxFunnelModule } from "devextreme-angular"; // ... export class AppComponent { selectItem (e) { e.item.select(!e.item.isSelected()) } } @NgModule({ imports: [ // ... DxFunnelModule ], // ... })Vue
<template> <DxFunnel @item-click="selectItem" /> </template> <script> import DxFunnel from 'devextreme-vue/funnel'; export default { components: { DxFunnel }, methods: { selectItem (e) { e.item.select(!e.item.isSelected()) } } } </script>React
import React from 'react'; import Funnel from 'devextreme-react/funnel'; class App extends React.Component { render() { return ( <Funnel onItemClick={this.selectItem} /> ); } selectItem (e) { e.item.select(!e.item.isSelected()) } } export default App;See Also
A function that is executed when a legend item is clicked or tapped.
Selector: @legend-click
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
A function that is executed after a UI component property is changed.
Selector: @option-changed
Function parameters:Information about the event.
Object structure:
Name Type Description value anyThe modified property's new value.
previousValue anyThe UI component's previous value.
nameThe modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
fullNameThe path to the modified property that includes all parent properties.
elementThe UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
componentThe UI component's instance.
Default Value: null
The following example shows how to subscribe to component property changes:
jQuery$(function() { $("#funnelContainer").dxFunnel({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });Angular
<dx-funnel ... (onOptionChanged)="handlePropertyChange($event)"> </dx-funnel>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFunnelModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxFunnelModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxFunnel ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxFunnel from 'devextreme-vue/funnel'; export default { components: { DxFunnel }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import Funnel from 'devextreme-react/funnel'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <Funnel ... onOptionChanged={handlePropertyChange} /> ); }
A function that is executed when a funnel item is selected or selection is canceled.
Selector: @selection-changed
Function parameters:Information about the event.
Object structure:
Default Value: null
Cannot be used in themes.
Sets the palette to be used to colorize funnel items.
Default Value: 'Material'
Specifies what to do with colors in the palette when their number is less than the number of funnel items.
Selector: palette-extension-mode
Default Value: 'blend'
The following variants are available:
"blend"
Create a blend of two neighboring colors and insert it between these colors in the palette.
"alternate"
Repeat the full set of palette colors, alternating their normal, lightened, and darkened shades in that order.
"extrapolate"
Repeat the full set of palette colors, changing their shade gradually from dark to light.
Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path.
Selector: path-modified
Default Value: false
Cannot be used in themes.
If you place the UI component on a page that uses a tag modifying the path (<base>
, <iframe>
, etc.), some of the UI component elements may get mixed up or disappear. To solve this problem, set the pathModified property to true.
Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates.
Selector: redraw-on-resize
Default Value: true
Cannot be used in themes.
When this property is set to true
, the UI component will be redrawn automatically in case the size of its container changes.
Specifies how item labels should behave when they overlap.
Selector: resolve-label-overlapping
Default Value: 'shift'
The following modes are available:
"shift"
Item labels shift from their positions. If they still overlap, some of them hide.
"hide"
Certain item labels hide.
"none"
Item labels overlap.
Switches the UI component to a right-to-left representation.
Selector: rtl-enabled
Default Value: false
Cannot be used in themes.
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
In a right-to-left representation, SVG elements have the
directionattribute with the
rtlvalue. This might cause problems when rendering left-to-right texts. Use this property if you have only right-to-left texts.
Specifies whether a single or multiple funnel items can be in the selected state at a time. Assigning "none" disables the selection feature.
Selector: selection-mode
Default Value: 'single'
See onItemClick to learn how to implement selection.
Specifies the UI component's size in pixels.
Selector: DxSize
Type: viz/core/base_widget:BaseWidgetSize
Default Value: {height: 400, width: 400}
You can specify a custom width and height for the component:
Fixed Relative Assign values to the size object's height and width properties or specify a container for the component. Specify a container for the component. The component occupies the container area.The size object has priority over the container.
Assign 0 to the size object's height and width properties to hide the component.
jQuery$(function() { $("#funnelContainer").dxFunnel({ // ... size: { height: 300, width: 600 } }); });Angular
<dx-funnel ... > <dxo-size [height]="300" [width]="600"> </dxo-size> </dx-funnel>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxFunnelModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxFunnelModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }Vue
<template> <DxFunnel ... > <DxSize :height="300" :width="600" /> </DxFunnel> </template> <script> import DxFunnel, { DxSize } from 'devextreme-vue/funnel'; export default { components: { DxFunnel, DxSize }, // ... } </script>React
import React from 'react'; import Funnel, { Size } from 'devextreme-react/funnel'; class App extends React.Component { render() { return ( <Funnel ... > <Size height={300} width={600} /> </Funnel> ); } } export default App;
Alternatively, you can use CSS to style the UI component's container:
jQuery$(function() { $("#funnel").dxFunnel({ // ... }); });
#funnel { width: 85%; height: 70%; }Angular
<dx-funnel ... id="funnel"> </dx-funnel>
#funnel { width: 85%; height: 70%; }Vue
<template> <DxFunnel ... id="funnel"> </DxFunnel> </template> <script> import DxFunnel from 'devextreme-vue/funnel'; export default { components: { DxFunnel }, // ... } </script> <style> #funnel { width: 85%; height: 70%; } </style>React
import React from 'react'; import Funnel from 'devextreme-react/funnel'; class App extends React.Component { render() { return ( <Funnel ... id="funnel"> </Funnel> ); } } export default App;
#funnel { width: 85%; height: 70%; }
Specifies whether to sort funnel items.
Selector: sort-data
Default Value: true
true puts bigger values on the top, smaller on the bottom; false keeps the order specified in the data source.
See AlsoSets the name of the theme the UI component uses.
Default Value: 'generic.light'
A theme is a UI component configuration that gives the UI component a distinctive appearance. You can use one of the predefined themes or create a custom one. Changing the property values in the UI component's configuration object overrides the theme's corresponding values.
Configures the UI component's title.
Selector: DxTitle
Type: viz/core/base_widget:BaseWidgetTitle
The UI component's title is a short text that usually indicates what is visualized. If you need to specify the title's text only, assign it directly to the title property. Otherwise, set this property to an object with the text and other fields specified.
The title can be accompanied by a subtitle elaborating on the visualized subject using the title.subtitle object.
Specifies which data source field provides values for funnel items. The value defines a funnel item's area.
Selector: value-field
Default Value: 'val'
Feel free to share topic-related thoughts here.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4