Represents a funnel chart.
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbFunnelChart()Returns IgbFunnelChart
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererControl
protected virtual string ParentTypeName { get; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererControl
protected virtual bool SupportsVisualChildren { get; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererControl
protected virtual bool UseDirectRender { get; }DirectRenderElementName
Section titled "DirectRenderElementName"Inherited from: BaseRendererControl
protected virtual string DirectRenderElementName { get; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }ActualHighlightValueDisplayMode
Section titled "ActualHighlightValueDisplayMode"Gets whether and how to display the highlighted value.
[Parameter]
public HighlightedValueDisplayMode ActualHighlightValueDisplayMode { get; set; }ActualHighlightValueOpacity
Section titled "ActualHighlightValueOpacity"Gets the actual opacity of the primary needle while highlighting
[Parameter]
public double ActualHighlightValueOpacity { get; set; }AllowSliceSelection
Section titled "AllowSliceSelection"Gets or sets whether to allow slices to be selected.
[Parameter]
public bool AllowSliceSelection { get; set; }BottomEdgeWidth
Section titled "BottomEdgeWidth"Gets or sets the percentage (from near 0 to 1) of space the bottom edge of the funnel should take.
[Parameter]
public double BottomEdgeWidth { get; set; }Brushes
Section titled "Brushes"Gets or sets the palette of brushes to use for coloring the slices.
[Parameter]
public string Brushes { get; set; }DataSource
Section titled "DataSource"Gets or sets the ItemsSource for the funnel chart.
[Parameter]
public object DataSource { get; set; }DataSourceScript
Section titled "DataSourceScript"Provides a means of setting DataSource in the JavaScript environment.
[Parameter]
public string DataSourceScript { get; set; }DefaultEventBehavior
Section titled "DefaultEventBehavior"Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }FormatInnerLabel
Section titled "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.
[Parameter]
public string FormatInnerLabel { get; set; }FormatInnerLabelScript
Section titled "FormatInnerLabelScript"Provides a means of setting FormatInnerLabel in the JavaScript environment.
[Parameter]
public string FormatInnerLabelScript { get; set; }FormatOuterLabel
Section titled "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.
[Parameter]
public string FormatOuterLabel { get; set; }FormatOuterLabelScript
Section titled "FormatOuterLabelScript"Provides a means of setting FormatOuterLabel in the JavaScript environment.
[Parameter]
public string FormatOuterLabelScript { get; set; }FunnelSliceDisplay
Section titled "FunnelSliceDisplay"Gets or sets how the heights of the funnel slices should be configured.
[Parameter]
public FunnelSliceDisplay FunnelSliceDisplay { get; set; }HighlightValueDisplayMode
Section titled "HighlightValueDisplayMode"Gets or sets whether and how to display the highlighted value.
[Parameter]
public HighlightedValueDisplayMode HighlightValueDisplayMode { get; set; }HighlightValueOpacity
Section titled "HighlightValueOpacity"Gets or sets the opacity while highlighting
[Parameter]
public double HighlightValueOpacity { get; set; }HighlightedValueMemberPath
Section titled "HighlightedValueMemberPath"Gets or sets the highlighted value member path for the funnel chart.
[Parameter]
public string HighlightedValueMemberPath { get; set; }InnerLabelMemberPath
Section titled "InnerLabelMemberPath"Gets or sets the InnerLabel mapping property for the current series object.
[Parameter]
public string InnerLabelMemberPath { get; set; }InnerLabelVisibility
Section titled "InnerLabelVisibility"Gets or sets whether the inner labels are visible.
[Parameter]
public Visibility InnerLabelVisibility { get; set; }IsInverted
Section titled "IsInverted"Gets or sets if the funnel should be rendered inverted.
[Parameter]
public bool IsInverted { get; set; }LegendItemBadgeTemplate
Section titled "LegendItemBadgeTemplate"Gets or sets the LegendItemBadgeTemplate to use for the legend items.
[Parameter]
public object LegendItemBadgeTemplate { get; set; }LegendItemBadgeTemplateScript
Section titled "LegendItemBadgeTemplateScript"Provides a means of setting LegendItemBadgeTemplate in the JavaScript environment.
[Parameter]
public string LegendItemBadgeTemplateScript { get; set; }OuterLabelAlignment
Section titled "OuterLabelAlignment"Gets or sets which side of the chart the outer labels should appear.
[Parameter]
public OuterLabelAlignment OuterLabelAlignment { get; set; }OuterLabelMemberPath
Section titled "OuterLabelMemberPath"Gets or sets the OuterLabel mapping property for the current series object.
[Parameter]
public string OuterLabelMemberPath { get; set; }OuterLabelTextColor
Section titled "OuterLabelTextColor"Gets or sets the brush used for the outer labels.
[Parameter]
public string OuterLabelTextColor { get; set; }OuterLabelTextStyle
Section titled "OuterLabelTextStyle"Gets or sets the text style for outer labels
[Parameter]
public string OuterLabelTextStyle { get; set; }OuterLabelVisibility
Section titled "OuterLabelVisibility"Gets or sets whether the outer labels are visible.
[Parameter]
public Visibility OuterLabelVisibility { get; set; }OutlineThickness
Section titled "OutlineThickness"Gets or sets the thickness of outline around slices.
[Parameter]
public double OutlineThickness { get; set; }Outlines
Section titled "Outlines"Gets or sets the palette of brushes to use for outlines on the slices.
[Parameter]
public string Outlines { get; set; }PixelScalingRatio
Section titled "PixelScalingRatio"Gets or sets the scaling value used to affect the pixel density of the control.
[Parameter]
public double PixelScalingRatio { get; set; }SelectedItems
Section titled "SelectedItems"Represents the current selected items.
public IgbFunnelChartSelectedItemsCollection SelectedItems { get; protected set; }SelectedSliceFill
Section titled "SelectedSliceFill"Gets or sets the fill brush.
[Parameter]
public string SelectedSliceFill { get; set; }SelectedSliceOpacity
Section titled "SelectedSliceOpacity"Gets or sets the opacity.
[Parameter]
public double SelectedSliceOpacity { get; set; }SelectedSliceStroke
Section titled "SelectedSliceStroke"Gets or sets the stroke brush.
[Parameter]
public string SelectedSliceStroke { get; set; }SelectedSliceStrokeThickness
Section titled "SelectedSliceStrokeThickness"Gets or sets the stroke thickness.
[Parameter]
public double SelectedSliceStrokeThickness { get; set; }TextColor
Section titled "TextColor"Gets or sets the brush used for the inner labels.
[Parameter]
public string TextColor { get; set; }TextStyle
Section titled "TextStyle"Gets or sets the text style for inner labels
[Parameter]
public string TextStyle { get; set; }TransitionDuration
Section titled "TransitionDuration"Gets or sets how long the animations should take to run.
[Parameter]
public int TransitionDuration { get; set; }public override string Type { get; }UnselectedSliceFill
Section titled "UnselectedSliceFill"Gets or sets the fill brush.
[Parameter]
public string UnselectedSliceFill { get; set; }UnselectedSliceOpacity
Section titled "UnselectedSliceOpacity"Gets or sets the opacity.
[Parameter]
public double UnselectedSliceOpacity { get; set; }UnselectedSliceStroke
Section titled "UnselectedSliceStroke"Gets or sets the stroke brush.
[Parameter]
public string UnselectedSliceStroke { get; set; }UnselectedSliceStrokeThickness
Section titled "UnselectedSliceStrokeThickness"Gets or sets the stroke thickness.
[Parameter]
public double UnselectedSliceStrokeThickness { get; set; }UseBezierCurve
Section titled "UseBezierCurve"Gets or sets whether to use a Bezier curve to define the funnel.
[Parameter]
public bool UseBezierCurve { get; set; }UseOuterLabelsForLegend
Section titled "UseOuterLabelsForLegend"Gets or sets whether to use the outer labels to identify the legend items.
[Parameter]
public bool UseOuterLabelsForLegend { get; set; }UseUnselectedStyle
Section titled "UseUnselectedStyle"Gets or sets whether to use the unselected style on unselected slices.
[Parameter]
public bool UseUnselectedStyle { get; set; }ValueMemberPath
Section titled "ValueMemberPath"Gets or sets the value member path for the funnel chart.
[Parameter]
public string ValueMemberPath { get; set; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"Inherited from: BaseRendererControl
protected virtual string ResolveDisplay()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
ExportSerializedVisualData()
Section titled "ExportSerializedVisualData()"public string ExportSerializedVisualData()Returns any
ExportSerializedVisualDataAsync()
Section titled "ExportSerializedVisualDataAsync()"Exports and serializes the chart visuals.
public Task<string> ExportSerializedVisualDataAsync()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
Flush()
Section titled "Flush()"public void Flush()Returns any
FlushAsync()
Section titled "FlushAsync()"Use to force the funnel chart to finish any deferred work before printing or evaluating its visual.
public Task FlushAsync()Returns any
GetCurrentSelectedItems()
Section titled "GetCurrentSelectedItems()"public IgbFunnelChartSelectedItemsCollection GetCurrentSelectedItems()Returns any
GetCurrentSelectedItemsAsync()
Section titled "GetCurrentSelectedItemsAsync()"public Task<IgbFunnelChartSelectedItemsCollection> GetCurrentSelectedItemsAsync()Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"public void NotifyClearItems(object source_)Parameters
- source_:
object
Returns any
NotifyClearItemsAsync(object)
Section titled "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.
public Task NotifyClearItemsAsync(object source_)Parameters
- source_:
object
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"public void NotifyInsertItem(object source_, int index, object newItem)Parameters
- source_:
object - index:
int - newItem:
object
Returns any
NotifyInsertItemAsync(object, int, object)
Section titled "NotifyInsertItemAsync(object, int, object)"public Task NotifyInsertItemAsync(object source_, int index, object newItem)Parameters
- source_:
object - index:
int - newItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"public void NotifyRemoveItem(object source_, int index, object oldItem)Parameters
- source_:
object - index:
int - oldItem:
object
Returns any
NotifyRemoveItemAsync(object, int, object)
Section titled "NotifyRemoveItemAsync(object, int, object)"public Task NotifyRemoveItemAsync(object source_, int index, object oldItem)Parameters
- source_:
object - index:
int - oldItem:
object
Returns any
NotifyResized()
Section titled "NotifyResized()"public void NotifyResized()Returns any
NotifyResizedAsync()
Section titled "NotifyResizedAsync()"Notifies the controller and view about a size change.
public Task NotifyResizedAsync()Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"public void NotifySetItem(object source_, int index, object oldItem, object newItem)Parameters
- source_:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifySetItemAsync(object, int, object, object)
Section titled "NotifySetItemAsync(object, int, object, object)"public Task NotifySetItemAsync(object source_, int index, object oldItem, object newItem)Parameters
- source_:
object - index:
int - oldItem:
object - newItem:
object
Returns any
ProvideContainer(object)
Section titled "ProvideContainer(object)"public void ProvideContainer(object container)Parameters
- container:
object
Returns any
ProvideContainerAsync(object)
Section titled "ProvideContainerAsync(object)"Provides container for funnel chart
public Task ProvideContainerAsync(object container)Parameters
- container:
object
Returns any
ToggleSelection(int)
Section titled "ToggleSelection(int)"public void ToggleSelection(int index)Parameters
- index:
int
Returns any
ToggleSelectionAsync(int)
Section titled "ToggleSelectionAsync(int)"Toggle selection of item at index.
public Task ToggleSelectionAsync(int index)Parameters
- index:
int
Returns any
Events
Section titled "Events"SelectedItemsChanged
Section titled "SelectedItemsChanged"[Parameter]
public EventCallback<IgbFunnelChartSelectedItemsChangedEventArgs> SelectedItemsChanged { get; set; }SliceClicked
Section titled "SliceClicked"[Parameter]
public EventCallback<IgbFunnelSliceClickedEventArgs> SliceClicked { get; set; }SliceEnter
Section titled "SliceEnter"[Parameter]
public EventCallback<IgbFunnelSliceEventArgs> SliceEnter { get; set; }SliceHover
Section titled "SliceHover"[Parameter]
public EventCallback<IgbFunnelSliceEventArgs> SliceHover { get; set; }SliceLeave
Section titled "SliceLeave"[Parameter]
public EventCallback<IgbFunnelSliceEventArgs> SliceLeave { get; set; }SelectedItemsChangedScript
Section titled "SelectedItemsChangedScript"[Parameter]
public string SelectedItemsChangedScript { get; set; }SliceClickedScript
Section titled "SliceClickedScript"[Parameter]
public string SliceClickedScript { get; set; }SliceEnterScript
Section titled "SliceEnterScript"[Parameter]
public string SliceEnterScript { get; set; }SliceHoverScript
Section titled "SliceHoverScript"[Parameter]
public string SliceHoverScript { get; set; }SliceLeaveScript
Section titled "SliceLeaveScript"[Parameter]
public string SliceLeaveScript { get; set; }