Vue Funnel Props

See Also

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:

1. Title
2. Export menu icon
3. Legend
4. Item labels (can be saved by setting the adaptiveLayout.keepLabels property to true)

Use the height and width properties in the adaptiveLayout object to specify the minimum container size at which the layout begins to adapt.

View Demo on JSFiddle

See Also

• Adaptive Layout

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.

See Also

• argumentField
• valueField
• colorField

See Also

• valueField
• colorField

The colors must have one of the following formats:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

See Also

• argumentField
• valueField

The Funnel works with collections of objects.

Depending on your data source, bind the 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:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  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

  JavaScript

  $(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

  app.component.ts

  app.component.html

  app.module.ts

  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

  App.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

  App.js

  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.

These features allow a user to export your UI component into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the UI component. A click on it invokes a drop-down menu that lists exporting and printing commands. The following formats are supported for exporting into: PNG, PDF, JPEG, SVG and GIF.

See Also

• exportTo(fileName, format)
• print()
• DevExpress.viz.exportWidgets(widgetInstances, options)

See Also

• item.hoverStyle
• onHoverChanged

View Demo

See Also

• resolveLabelOverlapping

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.

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.

See Also

• onExporting
• onFileSaving

See Also

• onExported
• onFileSaving

See Also

• onExporting
• onExported

To identify whether the pointer has entered or left the funnel item, call the item's isHovered() method.

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:

• id
  The incident's ID. The full list of IDs can be found in the Errors and Warnings section.
• type
  The incident's type: "error" or "warning".
• args
  The argument of the incident's message. Depends on the incident. For example, it may be the name of the data source field that was specified incorrectly, or the name of the property that was not set properly.
• text
  The text passed to the browser's console. Includes the args content, if there is any.
• widget
  The name of the UI component that produced the error or warning.
• version
  The used DevExtreme version.

See Also

This function is often used to implement item selection as shown in the following code:

$(function () {
    $("#funnelContainer").dxFunnel({
        // ...
        onItemClick: function (e) {
            e.item.select(!e.item.isSelected())
        }
    });
});

<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
    ],
    // ...
})

<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>

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

• selectionMode
• onSelectionChanged

See Also

• legend

The following example shows how to subscribe to component property changes:

$(function() {
    $("#funnelContainer").dxFunnel({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<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 { }  

<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> 

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}
        />        
    ); 
} 

To identify whether the selection has been applied or canceled, call the funnel item's isSelected() method.

See onItemClick to learn how to implement selection.

See Also

• selectionMode
• item.selectionStyle

This property accepts either the name of a predefined palette or an array of colors. The array can include the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors

See Also

• Palettes
• paletteExtensionMode
• DevExpress.viz.generateColors(palette, count, options)
• colorField

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.

View Demo

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.

See Also

• DevExpress.viz.refreshPaths()

When this property is set to true, the UI component will be redrawn automatically in case the size of its parent window changes.

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.

See Also

• label.position

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
});

See onItemClick to learn how to implement selection.

The UI component occupies its container's entire area by default. Use the size object to specify the UI component's size if it should be different from that of its container. Assign 0 to size object's height and width properties to hide the UI component.

$(function() {
    $("#funnelContainer").dxFunnel({
        // ...
        size: {
            height: 300,
            width: 600
        }
    });
});

<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 { }

<template>
    <DxFunnel ... >
        <DxSize
            :height="300"
            :width="600"
        />
    </DxFunnel>
</template>

<script>

import DxFunnel, {
    DxSize
} from 'devextreme-vue/funnel';

export default {
    components: {
        DxFunnel,
        DxSize
    },
    // ...
}
</script>

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 style the UI component's container using CSS:

$(function() {
    $("#funnel").dxFunnel({
        // ...
    });
});

#funnel {
    width: 85%;
    height: 70%;
}

<dx-funnel ...
    id="funnel">
</dx-funnel>

#funnel {
    width: 85%;
    height: 70%;
}

<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>

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%;
}

true puts bigger values on the top, smaller on the bottom; false keeps the order specified in the data source.

See Also

• inverted

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.

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.

See Also

• argumentField
• colorField