Skip to main content

FunnelBuilder Methods

A Funnel control.
Name Description
AdaptiveLayout(Action<FunnelAdaptiveLayoutBuilder>) Specifies adaptive layout properties. Mirrors the client-side adaptiveLayout object.
Algorithm(FunnelAlgorithm) Specifies the algorithm for building the funnel. Mirrors the client-side algorithm option.
ArgumentField(JS) Specifies which data source field provides arguments for funnel items. The argument identifies a funnel item and represents it on the legend. Mirrors the client-side argumentField option.
ArgumentField(String) Specifies which data source field provides arguments for funnel items. The argument identifies a funnel item and represents it on the legend. Mirrors the client-side argumentField option.
ColorField(JS) Specifies which data source field provides colors for funnel items. If this field is absent, the palette provides the colors. Mirrors the client-side colorField option.
ColorField(String) Specifies which data source field provides colors for funnel items. If this field is absent, the palette provides the colors. Mirrors the client-side colorField option.
DataSource(JS) Binds the UI component to data. Mirrors the client-side dataSource option.
DataSource(IEnumerable, String[]) Binds a Funnel control to a collection: Array, List, or IEnumerable.
DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) Binds a Funnel control to data, allows you to configure data access from different sources: API controllers, Razor page handlers, OData services, arrays, and more.
DataSource(String, String[]) Binds a Funnel control to read-only data in JSON format.
DataSourceOptions(Action<DataSourceOptionsBuilder>) Provides access to methods that mirror client-side data source options.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
ElementAttr(JS) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Dictionary<String, Object>) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(String, Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Export(Action<FunnelExportBuilder>) Configures the exporting and printing features. Mirrors the client-side export object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
HoverEnabled(JS) Specifies whether funnel items change their style when a user pauses on them. Mirrors the client-side hoverEnabled option.
HoverEnabled(Boolean) Specifies whether funnel items change their style when a user pauses on them. Mirrors the client-side hoverEnabled option.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
Inverted(JS) Turns the funnel upside down. Mirrors the client-side inverted option.
Inverted(Boolean) Turns the funnel upside down. Mirrors the client-side inverted option.
Item(Action<FunnelItemBuilder>) Configures funnel items' appearance. Mirrors the client-side item object.
Label(Action<FunnelLabelBuilder>) Configures funnel item labels. Mirrors the client-side label object.
Legend(Action<FunnelLegendBuilder>) Configures the legend. Mirrors the client-side legend object.
LoadingIndicator(Action<FunnelLoadingIndicatorBuilder>) Configures the loading indicator. Mirrors the client-side loadingIndicator object.
Margin(Action<FunnelMarginBuilder>) Generates space around the UI component. Mirrors the client-side margin object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
NeckHeight(JS) 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'. Mirrors the client-side neckHeight option.
NeckHeight(Double) 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'. Mirrors the client-side neckHeight option.
NeckWidth(JS) 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'. Mirrors the client-side neckWidth option.
NeckWidth(Double) 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'. Mirrors the client-side neckWidth option.
OnDisposing(RazorBlock) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDisposing(String) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDrawn(RazorBlock) A function that is executed when the UI component's rendering has finished. Mirrors the client-side onDrawn option.
OnDrawn(String) A function that is executed when the UI component's rendering has finished. Mirrors the client-side onDrawn option.
OnExported(RazorBlock) A function that is executed after the UI component is exported. Mirrors the client-side onExported option.
OnExported(String) A function that is executed after the UI component is exported. Mirrors the client-side onExported option.
OnExporting(RazorBlock) A function that is executed before the UI component is exported. Mirrors the client-side onExporting option.
OnExporting(String) A function that is executed before the UI component is exported. Mirrors the client-side onExporting option.
OnFileSaving(RazorBlock) A function that is executed before a file with exported UI component is saved to the user's local storage. Mirrors the client-side onFileSaving option.
OnFileSaving(String) A function that is executed before a file with exported UI component is saved to the user's local storage. Mirrors the client-side onFileSaving option.
OnHoverChanged(RazorBlock) A function that is executed after the pointer enters or leaves a funnel item. Mirrors the client-side onHoverChanged option.
OnHoverChanged(String) A function that is executed after the pointer enters or leaves a funnel item. Mirrors the client-side onHoverChanged option.
OnIncidentOccurred(RazorBlock) A function that is executed when an error or warning occurs. Mirrors the client-side onIncidentOccurred option.
OnIncidentOccurred(String) A function that is executed when an error or warning occurs. Mirrors the client-side onIncidentOccurred option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnItemClick(RazorBlock) A function that is executed when a funnel item is clicked or tapped. Mirrors the client-side onItemClick option.
OnItemClick(String) A function that is executed when a funnel item is clicked or tapped. Mirrors the client-side onItemClick option.
OnLegendClick(RazorBlock) A function that is executed when a legend item is clicked or tapped. Mirrors the client-side onLegendClick option.
OnLegendClick(String) A function that is executed when a legend item is clicked or tapped. Mirrors the client-side onLegendClick option.
OnOptionChanged(RazorBlock) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnSelectionChanged(RazorBlock) A function that is executed when a funnel item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option.
OnSelectionChanged(String) A function that is executed when a funnel item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option.
Option(String, Object) Specifies an option by its name.
Palette(JS) Sets the palette to be used to colorize funnel items. Mirrors the client-side palette option.
Palette(VizPalette) Sets the palette to be used to colorize funnel items. Mirrors the client-side palette option.
Palette(IEnumerable<String>) Sets the palette to be used to colorize funnel items. Mirrors the client-side palette option.
PaletteExtensionMode(VizPaletteExtensionMode) Specifies what to do with colors in the palette when their number is less than the number of funnel items. Mirrors the client-side paletteExtensionMode option.
PathModified(JS) Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path. Mirrors the client-side pathModified option.
PathModified(Boolean) Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path. Mirrors the client-side pathModified option.
RedrawOnResize(JS) Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates. Mirrors the client-side redrawOnResize option.
RedrawOnResize(Boolean) Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates. Mirrors the client-side redrawOnResize option.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
ResolveLabelOverlapping(ShiftLabelOverlap)
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
SelectionMode(SelectionMode) Specifies whether a single or multiple funnel items can be in the selected state at a time. Assigning 'none' disables the selection feature. Mirrors the client-side selectionMode option.
Size(Action<FunnelSizeBuilder>) Mirrors the client-side size object.
SortData(JS) Specifies whether to sort funnel items. Mirrors the client-side sortData option.
SortData(Boolean) Specifies whether to sort funnel items. Mirrors the client-side sortData option.
Theme(VizTheme) Sets the name of the theme the UI component uses. Mirrors the client-side theme option.
Title(JS) Configures the UI component's title. Mirrors the client-side title option.
Title(Action<FunnelTitleBuilder>) Configures the UI component's title. Mirrors the client-side title object.
Title(String) Configures the UI component's title. Mirrors the client-side title option.
Tooltip(Action<FunnelTooltipBuilder>) Mirrors the client-side tooltip object.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
ValueField(JS) Specifies which data source field provides values for funnel items. The value defines a funnel item's area. Mirrors the client-side valueField option.
ValueField(String) Specifies which data source field provides values for funnel items. The value defines a funnel item's area. Mirrors the client-side valueField option.
See Also