Class IgbFunnelChart

Represents a funnel chart.

Inheritance

System.Object

BaseRendererControl

IgbFunnelChart

Implements

JsonSerializable

System.IDisposable

Inherited Members

BaseRendererControl.eventCallbacksCache

BaseRendererControl._cachedSerializedContent

BaseRendererControl.ResolveEventBehavior()

BaseRendererControl.ResolveDisplay()

BaseRendererControl.ToSpinal(String)

BaseRendererControl.TransformSimpleKey(String)

BaseRendererControl.IsTransformedEnumValue(String)

BaseRendererControl.TransformPotentialEnumValue(String, Object)

BaseRendererControl.BuildSequenceInfo(Int32)

BaseRendererControl.BuildRenderTree(RenderTreeBuilder)

BaseRendererControl.TemplateContentType(String)

BaseRendererControl.OnAfterRenderAsync(Boolean)

BaseRendererControl.EnsureReady()

BaseRendererControl.MarkPropDirty(String)

BaseRendererControl.IsPropDirty(String)

BaseRendererControl.Serialize(SerializationContext, String)

BaseRendererControl.Serialize()

BaseRendererControl.InvokeMethod(String, Object[], String[], ElementReference[])

BaseRendererControl.InvokeMethodSync(String, Object[], String[], ElementReference[])

BaseRendererControl.SuspendNotifications(Object)

BaseRendererControl.ResumeNotifications(Object, Boolean)

BaseRendererControl.NotifyUpdateItem(Object, Int32, Object, Boolean)

BaseRendererControl.OnRefChanged(String, Object)

BaseRendererControl.OnInvokeReturn(Int64, Object)

BaseRendererControl.Camelize(String)

BaseRendererControl.ToPascal(String)

BaseRendererControl.OnElementNameChanged(BaseRendererElement, String, String)

BaseRendererControl.Dispose(Boolean)

BaseRendererControl.SetResourceStringAsync(String, String, String)

BaseRendererControl.SetResourceStringAsync(String, String)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, JsonElement)

BaseRendererControl.SetPropertyValue(Object, PropertyInfo, Object)

BaseRendererControl.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)

BaseRendererControl.Finalize()

BaseRendererControl.Dispose()

BaseRendererControl.IgBlazor

BaseRendererControl.Height

BaseRendererControl.Width

BaseRendererControl.Class

BaseRendererControl.AdditionalAttributes

BaseRendererControl.ParentTypeName

BaseRendererControl.EventBehavior

BaseRendererControl.ChildContent

BaseRendererControl.RoundTripDateConversion

BaseRendererControl.SupportsVisualChildren

BaseRendererControl.UseDirectRender

BaseRendererControl.DirectRenderElementName

BaseRendererControl.NeedsDynamicContent

BaseRendererControl.UseCamelEnumValues

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbFunnelChart : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbFunnelChart()

Declaration

public IgbFunnelChart()

Properties

ActualHighlightValueDisplayMode

Gets whether and how to display the highlighted value.

Declaration

public HighlightedValueDisplayMode ActualHighlightValueDisplayMode { get; set; }

Property Value

Type	Description
HighlightedValueDisplayMode

ActualHighlightValueOpacity

Gets the actual opacity of the primary needle while highlighting

Declaration

public double ActualHighlightValueOpacity { get; set; }

Property Value

Type	Description
System.Double

AllowSliceSelection

Gets or sets whether to allow slices to be selected.

Declaration

public bool AllowSliceSelection { get; set; }

Property Value

Type	Description
System.Boolean

BottomEdgeWidth

Gets or sets the percentage (from near 0 to 1) of space the bottom edge of the funnel should take.

Declaration

public double BottomEdgeWidth { get; set; }

Property Value

Type	Description
System.Double

Brushes

Gets or sets the palette of brushes to use for coloring the slices.

Declaration

public string Brushes { get; set; }

Property Value

Type	Description
System.String

DataSource

Gets or sets the ItemsSource for the funnel chart.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object

DataSourceScript

Provides a means of setting DataSource in the JavaScript environment.

Declaration

public string DataSourceScript { get; set; }

Property Value

Type	Description
System.String

DefaultEventBehavior

Declaration

protected override ControlEventBehavior DefaultEventBehavior { get; }

Property Value

Type	Description
ControlEventBehavior

Overrides

BaseRendererControl.DefaultEventBehavior

FormatInnerLabel

Gets or sets the formatter function for inner labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.

Declaration

public string FormatInnerLabel { get; set; }

Property Value

Type	Description
System.String

FormatInnerLabelScript

Provides a means of setting FormatInnerLabel in the JavaScript environment.

Declaration

public string FormatInnerLabelScript { get; set; }

Property Value

Type	Description
System.String

FormatOuterLabel

Gets or sets the formatter function for outer labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart.

Declaration

public string FormatOuterLabel { get; set; }

Property Value

Type	Description
System.String

FormatOuterLabelScript

Provides a means of setting FormatOuterLabel in the JavaScript environment.

Declaration

public string FormatOuterLabelScript { get; set; }

Property Value

Type	Description
System.String

FunnelSliceDisplay

Gets or sets how the heights of the funnel slices should be configured.

Declaration

public FunnelSliceDisplay FunnelSliceDisplay { get; set; }

Property Value

Type	Description
FunnelSliceDisplay

HighlightedValueMemberPath

Gets or sets the highlighted value member path for the funnel chart.

Declaration

public string HighlightedValueMemberPath { get; set; }

Property Value

Type	Description
System.String

HighlightValueDisplayMode

Gets or sets whether and how to display the highlighted value.

Declaration

public HighlightedValueDisplayMode HighlightValueDisplayMode { get; set; }

Property Value

Type	Description
HighlightedValueDisplayMode

HighlightValueOpacity

Gets or sets the opacity while highlighting

Declaration

public double HighlightValueOpacity { get; set; }

Property Value

Type	Description
System.Double

InnerLabelMemberPath

Gets or sets the InnerLabel mapping property for the current series object.

Declaration

public string InnerLabelMemberPath { get; set; }

Property Value

Type	Description
System.String

InnerLabelVisibility

Gets or sets whether the inner labels are visible.

Declaration

public Visibility InnerLabelVisibility { get; set; }

Property Value

Type	Description
Visibility

IsInverted

Gets or sets if the funnel should be rendered inverted.

Declaration

public bool IsInverted { get; set; }

Property Value

Type	Description
System.Boolean

LegendItemBadgeTemplate

Gets or sets the LegendItemBadgeTemplate to use for the legend items.

Declaration

public object LegendItemBadgeTemplate { get; set; }

Property Value

Type	Description
System.Object

LegendItemBadgeTemplateScript

Provides a means of setting LegendItemBadgeTemplate in the JavaScript environment.

Declaration

public string LegendItemBadgeTemplateScript { get; set; }

Property Value

Type	Description
System.String

OuterLabelAlignment

Gets or sets which side of the chart the outer labels should appear.

Declaration

public OuterLabelAlignment OuterLabelAlignment { get; set; }

Property Value

Type	Description
OuterLabelAlignment

OuterLabelMemberPath

Gets or sets the OuterLabel mapping property for the current series object.

Declaration

public string OuterLabelMemberPath { get; set; }

Property Value

Type	Description
System.String

OuterLabelTextColor

Gets or sets the brush used for the outer labels.

Declaration

public string OuterLabelTextColor { get; set; }

Property Value

Type	Description
System.String

OuterLabelTextStyle

Gets or sets the text style for outer labels

Declaration

public string OuterLabelTextStyle { get; set; }

Property Value

Type	Description
System.String

OuterLabelVisibility

Gets or sets whether the outer labels are visible.

Declaration

public Visibility OuterLabelVisibility { get; set; }

Property Value

Type	Description
Visibility

Outlines

Gets or sets the palette of brushes to use for outlines on the slices.

Declaration

public string Outlines { get; set; }

Property Value

Type	Description
System.String

OutlineThickness

Gets or sets the thickness of outline around slices.

Declaration

public double OutlineThickness { get; set; }

Property Value

Type	Description
System.Double

PixelScalingRatio

Gets or sets the scaling value used to affect the pixel density of the control.

Declaration

public double PixelScalingRatio { get; set; }

Property Value

Type	Description
System.Double

Remarks

A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

SelectedItems

Represents the current selected items.

Declaration

public IgbFunnelChartSelectedItemsCollection SelectedItems { get; protected set; }

Property Value

Type	Description
IgbFunnelChartSelectedItemsCollection

SelectedItemsChanged

Declaration

public EventCallback<IgbFunnelChartSelectedItemsChangedEventArgs> SelectedItemsChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFunnelChartSelectedItemsChangedEventArgs>

SelectedItemsChangedScript

Declaration

public string SelectedItemsChangedScript { get; set; }

Property Value

Type	Description
System.String

SelectedSliceFill

Gets or sets the fill brush.

Declaration

public string SelectedSliceFill { get; set; }

Property Value

Type	Description
System.String

SelectedSliceOpacity

Gets or sets the opacity.

Declaration

public double SelectedSliceOpacity { get; set; }

Property Value

Type	Description
System.Double

SelectedSliceStroke

Gets or sets the stroke brush.

Declaration

public string SelectedSliceStroke { get; set; }

Property Value

Type	Description
System.String

SelectedSliceStrokeThickness

Gets or sets the stroke thickness.

Declaration

public double SelectedSliceStrokeThickness { get; set; }

Property Value

Type	Description
System.Double

SliceClicked

Declaration

public EventCallback<IgbFunnelSliceClickedEventArgs> SliceClicked { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFunnelSliceClickedEventArgs>

SliceClickedScript

Declaration

public string SliceClickedScript { get; set; }

Property Value

Type	Description
System.String

SliceEnter

Declaration

public EventCallback<IgbFunnelSliceEventArgs> SliceEnter { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFunnelSliceEventArgs>

SliceEnterScript

Declaration

public string SliceEnterScript { get; set; }

Property Value

Type	Description
System.String

SliceHover

Declaration

public EventCallback<IgbFunnelSliceEventArgs> SliceHover { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFunnelSliceEventArgs>

SliceHoverScript

Declaration

public string SliceHoverScript { get; set; }

Property Value

Type	Description
System.String

SliceLeave

Declaration

public EventCallback<IgbFunnelSliceEventArgs> SliceLeave { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<IgbFunnelSliceEventArgs>

SliceLeaveScript

Declaration

public string SliceLeaveScript { get; set; }

Property Value

Type	Description
System.String

TextColor

Gets or sets the brush used for the inner labels.

Declaration

public string TextColor { get; set; }

Property Value

Type	Description
System.String

TextStyle

Gets or sets the text style for inner labels

Declaration

public string TextStyle { get; set; }

Property Value

Type	Description
System.String

TransitionDuration

Gets or sets how long the animations should take to run.

Declaration

public int TransitionDuration { get; set; }

Property Value

Type	Description
System.Int32

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererControl.Type

UnselectedSliceFill

Gets or sets the fill brush.

Declaration

public string UnselectedSliceFill { get; set; }

Property Value

Type	Description
System.String

UnselectedSliceOpacity

Gets or sets the opacity.

Declaration

public double UnselectedSliceOpacity { get; set; }

Property Value

Type	Description
System.Double

UnselectedSliceStroke

Gets or sets the stroke brush.

Declaration

public string UnselectedSliceStroke { get; set; }

Property Value

Type	Description
System.String

UnselectedSliceStrokeThickness

Gets or sets the stroke thickness.

Declaration

public double UnselectedSliceStrokeThickness { get; set; }

Property Value

Type	Description
System.Double

UseBezierCurve

Gets or sets whether to use a Bezier curve to define the funnel.

Declaration

public bool UseBezierCurve { get; set; }

Property Value

Type	Description
System.Boolean

UseOuterLabelsForLegend

Gets or sets whether to use the outer labels to identify the legend items.

Declaration

public bool UseOuterLabelsForLegend { get; set; }

Property Value

Type	Description
System.Boolean

UseUnselectedStyle

Gets or sets whether to use the unselected style on unselected slices.

Declaration

public bool UseUnselectedStyle { get; set; }

Property Value

Type	Description
System.Boolean

ValueMemberPath

Gets or sets the value member path for the funnel chart.

Declaration

public string ValueMemberPath { get; set; }

Property Value

Type	Description
System.String

Methods

EnsureModulesLoaded()

Declaration

protected override void EnsureModulesLoaded()

Overrides

BaseRendererControl.EnsureModulesLoaded()

ExportSerializedVisualData()

Declaration

public string ExportSerializedVisualData()

Returns

Type	Description
System.String

ExportSerializedVisualDataAsync()

Exports and serializes the chart visuals.

Declaration

public Task<string> ExportSerializedVisualDataAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

FindByName(String)

Declaration

public override object FindByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Object

Overrides

BaseRendererControl.FindByName(String)

Flush()

Declaration

public void Flush()

FlushAsync()

Use to force the funnel chart to finish any deferred work before printing or evaluating its visual.

Declaration

public Task FlushAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Remarks

This should only be called if the visual of the funnel chart needs to be synchronously saved or evaluated. Calling this method too often will hinder the performance of the funnel chart.

GetCurrentSelectedItems()

Declaration

public IgbFunnelChartSelectedItemsCollection GetCurrentSelectedItems()

Returns

Type	Description
IgbFunnelChartSelectedItemsCollection

GetCurrentSelectedItemsAsync()

Declaration

public Task<IgbFunnelChartSelectedItemsCollection> GetCurrentSelectedItemsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<IgbFunnelChartSelectedItemsCollection>

NotifyClearItems(Object)

Declaration

public void NotifyClearItems(object source_)

Parameters

Type	Name	Description
System.Object	source_

NotifyClearItemsAsync(Object)

Manually notifies the chart's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the chart is bound to is already observable.

Declaration

public Task NotifyClearItemsAsync(object source_)

Parameters

Type	Name	Description
System.Object	source_

Returns

Type	Description
System.Threading.Tasks.Task

NotifyInsertItem(Object, Int32, Object)

Declaration

public void NotifyInsertItem(object source_, int index, object newItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	newItem

NotifyInsertItemAsync(Object, Int32, Object)

Declaration

public Task NotifyInsertItemAsync(object source_, int index, object newItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	newItem

Returns

Type	Description
System.Threading.Tasks.Task

NotifyRemoveItem(Object, Int32, Object)

Declaration

public void NotifyRemoveItem(object source_, int index, object oldItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	oldItem

NotifyRemoveItemAsync(Object, Int32, Object)

Declaration

public Task NotifyRemoveItemAsync(object source_, int index, object oldItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	oldItem

Returns

Type	Description
System.Threading.Tasks.Task

NotifyResized()

Declaration

public void NotifyResized()

NotifyResizedAsync()

Notifies the controller and view about a size change.

Declaration

public Task NotifyResizedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

NotifySetItem(Object, Int32, Object, Object)

Declaration

public void NotifySetItem(object source_, int index, object oldItem, object newItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	oldItem
System.Object	newItem

NotifySetItemAsync(Object, Int32, Object, Object)

Declaration

public Task NotifySetItemAsync(object source_, int index, object oldItem, object newItem)

Parameters

Type	Name	Description
System.Object	source_
System.Int32	index
System.Object	oldItem
System.Object	newItem

Returns

Type	Description
System.Threading.Tasks.Task

ProvideContainer(Object)

Declaration

public void ProvideContainer(object container)

Parameters

Type	Name	Description
System.Object	container

ProvideContainerAsync(Object)

Provides container for funnel chart

Declaration

public Task ProvideContainerAsync(object container)

Parameters

Type	Name	Description
System.Object	container

Returns

Type	Description
System.Threading.Tasks.Task

ToggleSelection(Int32)

Declaration

public void ToggleSelection(int index)

Parameters

Type	Name	Description
System.Int32	index

ToggleSelectionAsync(Int32)

Toggle selection of item at index.

Declaration

public Task ToggleSelectionAsync(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Threading.Tasks.Task

Implements

JsonSerializable

System.IDisposable