Vue Funnel Props

See Also

• Configure a Widget: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC

When adapting to small container size, the widget may hide its accessory elements, thus saving space for more valuable ones. The elements are being hidden in the following sequence.

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

To specify the widget's size small enough for the layout to begin adapting, use the height and width options of the adaptiveLayout object.

View Demo on JSFiddle

Two algorithms are available:

• "dynamicSlope"

  The 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 option. You can also transform the pyramid's peak into a funnel's neck using the neckHeight and neckWidth options.

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

This option accepts one of the following:

• Array of objects
  A simple JavaScript array containing a collection of plain objects.

• URL
  A URL to JSON data or a service returning data in JSON format.

• DataSource or its configuration object
  A DataSource is an object that provides an API for data processing. Learn more about it from the Data Layer and DataSource Examples guides.

  NOTE

  Turn the DataSource's pagination off to prevent data from partitioning.

See Also

• argumentField | valueField | colorField
• getDataSource()

You can configure this option in an ASP.NET MVC Control as follows:

@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

These features allow a user to export your widget into a document or print it. When exporting is enabled, the "Exporting/Printing" button appears in the widget. 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.exportFromMarkup(markup, options)

Watch Video

See Also

• item.hoverStyle
• onHoverChanged

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 option to true.

When the widget visualizes local data, loading is instant. But when the widget is bound to a remote data source, loading may takes a considerable amount of time. To keep the viewer's attention, the widget can display a loading indicator.

To activate the loading indicator, assign true to the loadingIndicator.show option. Once data is loaded, the loading indicator will be hidden automatically.

See Also

• showLoadingIndicator()
• hideLoadingIndicator()

See Also

• onExporting
• onFileSaving

See Also

• onExported
• onFileSaving

See Also

• onExporting
• onExported

When an error or warning appears, the widget notifies you by passing a message to the browser console. This message contains the ID of the incident, a brief description, and a link to the Errors and Warnings section where further information about this incident can be found. However, you can handle errors and warnings in the way that you require. To do this, implement a callback function performing the required actions and assign it to the onIncidentOccurred option. Within this function, you can use information about the incident that occurred. This information can be accessed from the target field of the object passed to the callback function as a parameter. This information includes the following.

• id
  Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.
• type
  Contains the type of the incident. This field equals "error" for errors or "warning" for warnings.
• args
  Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.
• text
  Contains the text passed to the browser console. This text includes the content of the args field, if there are any.
• widget
  Contains the name of the widget that produced the error or warning.
• version
  Contains the currently used version of the DevExtreme library.

You cannot access widget elements in this handler because it is executed before they are ready. Use the onDrawn handler instead.

The onItemClick event handler 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
    ],
    // ...
})

See Also

• selectionMode
• onSelectionChanged

See Also

• legend

See onItemClick to learn how to implement selection.

See Also

• selectionMode
• item.selectionStyle

This option accepts either the name of a predefined palette or an array of colors in one of the following formats.

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

If the funnel has more items than the palette has colors, the colors are repeated with slight modification.

When using the widget as an ASP.NET MVC Control, you can specify this option using the VizPalette enum. This enum accepts the following values: Default, SoftPastel, HarmonyLight, Pastel, Bright, Soft, Ocean, Vintage, Violet, Carmine, DarkMoon, SoftBlue, DarkViolet and GreenMist.

If you place the widget on a page that uses a tag modifying the path (<base>, <iframe>, etc.), some of the widget elements may get mixed up or disappear. To solve this problem, set the pathModified option to true.

See Also

• DevExpress.viz.refreshPaths()

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

When this option is set to true, the widget 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 widget occupies its container's entire area by default. Use the size object to specify the widget's size if it should be different from that of its container. Assign 0 to size object's height and width options to hide the widget.

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 widget configuration that gives the widget a distinctive appearance. Use can use one of the predefined themes or create a custom one. Changing the option values in the widget's configuration object overrides the theme's corresponding values.

When using the widget as an ASP.NET MVC Control, specify this option using the VizTheme enum. This enum accepts the following values: GenericLight, GenericDark, GenericContrast, GenericCarmine, GenericDarkMoon, GenericSoftBlue, GenericDarkViolet, GenericGreenMist, Android5Light, IOS7Default, Win10Black and Win10White.

The widget'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 option. Otherwise, set this option 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