Class IgbPieChartBase
Represents the base class for the pie chart.
Inheritance
System.Object
IgbPieChartBase
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbPieChartBase : BaseRendererControl, JsonSerializable
Constructors
IgbPieChartBase()
Declaration
Properties
ActualBrushes
Gets the actual palette of brushes to use for coloring the slices.
Declaration
public string ActualBrushes { get; set; }
Property Value
Type |
Description |
System.String |
|
Declaration
public IgbFormatSpecifierCollection ActualLabelFormatSpecifiers { get; }
Property Value
ActualLabelInnerColor
Gets the actual color for labels rendered inside of the pie chart.
Declaration
public string ActualLabelInnerColor { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualLabelOuterColor
Gets the actual color for labels rendered outside of the pie chart.
Declaration
public string ActualLabelOuterColor { get; set; }
Property Value
Type |
Description |
System.String |
|
Declaration
public IgbFormatSpecifierCollection ActualLegendLabelFormatSpecifiers { get; }
Property Value
Declaration
public IgbFormatSpecifierCollection ActualLegendOthersLabelFormatSpecifiers { get; }
Property Value
Declaration
public IgbFormatSpecifierCollection ActualOthersLabelFormatSpecifiers { get; }
Property Value
ActualOutlines
Gets the actual palette of brushes to use for outlines on the slices.
Declaration
public string ActualOutlines { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualPixelScalingRatio
Resolved pixel scaling ratio. Unless explicitly overridden by the
PieChartBase.PixelScalingRatio property,
this one returns the default ratio enforced by device. High resolution devices will initialize this property
to a higher value.
Declaration
public double ActualPixelScalingRatio { get; set; }
Property Value
Type |
Description |
System.Double |
|
AllowSliceExplosion
Gets or sets whether the slices can be exploded.
Declaration
public bool AllowSliceExplosion { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowSliceSelection
Gets or sets whether the slices can be selected.
Declaration
public bool AllowSliceSelection { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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 |
|
ContentLabelFormatSpecifiers
Declaration
public IgbFormatSpecifierCollection ContentLabelFormatSpecifiers { get; }
Property Value
ContentLegendLabelFormatSpecifiers
Declaration
public IgbFormatSpecifierCollection ContentLegendLabelFormatSpecifiers { get; }
Property Value
ContentLegendOthersLabelFormatSpecifiers
Declaration
public IgbFormatSpecifierCollection ContentLegendOthersLabelFormatSpecifiers { get; }
Property Value
ContentOthersLabelFormatSpecifiers
Declaration
public IgbFormatSpecifierCollection ContentOthersLabelFormatSpecifiers { get; }
Property Value
DataSource
Gets or sets the data source for the 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 |
|
ExplodedRadius
Determines how much the exploded slice is offset from the center. Value between 0 and 1.
Declaration
public double ExplodedRadius { get; set; }
Property Value
Type |
Description |
System.Double |
|
ExplodedSlices
Gets or sets the collection of exploded slice indices.
Declaration
public int[] ExplodedSlices { get; set; }
Property Value
Type |
Description |
System.Int32[] |
|
InnerExtent
Gets or sets the amount of space between the center and the start of the arc. This property should be set between 0 and 1.
Declaration
public double InnerExtent { get; set; }
Property Value
Type |
Description |
System.Double |
|
IsDragInteractionEnabled
Gets or sets whether the pie chart will handle drag interaction and make them avaiilable in its events.
Declaration
public bool IsDragInteractionEnabled { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsSurfaceInteractionDisabled
Gets or sets whether all surface interactions with the plot area should be disabled.
Declaration
public bool IsSurfaceInteractionDisabled { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
LabelClick
Declaration
public EventCallback<IgbLabelClickEventArgs> LabelClick { get; set; }
Property Value
LabelClickScript
Declaration
public string LabelClickScript { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelExtent
Gets or sets the pixel amount by which the labels are offset from the edge of the slices.
Declaration
public double LabelExtent { get; set; }
Property Value
Type |
Description |
System.Double |
|
Gets or sets the label format string to use for the label.
Declaration
public string LabelFormat { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the format specifiers to use with the LabelFormat string.
Declaration
public IgbFormatSpecifierCollection LabelFormatSpecifiers { get; set; }
Property Value
LabelInnerColor
Gets or sets the color for labels rendered inside of the pie chart.
Declaration
public string LabelInnerColor { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelMemberPath
Gets or sets the property name that contains the labels.
Declaration
public string LabelMemberPath { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelOuterColor
Gets or sets the color for labels rendered outside of the pie chart.
Declaration
public string LabelOuterColor { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelsPosition
Gets or sets the position of chart labels.
Declaration
public LabelsPosition LabelsPosition { get; set; }
Property Value
LeaderLineMargin
Gets or sets the margin between a label and the end of its leader line. The default is 6 pixels.
Declaration
public double LeaderLineMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
LeaderLineType
Gets or sets what type of leader lines will be used for the outside end labels.
Declaration
public LeaderLineType LeaderLineType { get; set; }
Property Value
LeaderLineVisibility
Gets or sets whether the leader lines are visible.
Declaration
public Visibility LeaderLineVisibility { get; set; }
Property Value
Legend
Gets or sets the legend used for the current chart.
Declaration
public IgbLegendBase Legend { get; set; }
Property Value
LegendEmptyValuesMode
Declaration
public LegendEmptyValuesMode LegendEmptyValuesMode { get; set; }
Property Value
LegendItemBadgeTemplate
Gets or sets the LegendItemBadgeTemplate property.
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 |
|
LegendItemTemplate
Gets or sets the LegendItemTemplate property.
Declaration
public object LegendItemTemplate { get; set; }
Property Value
Type |
Description |
System.Object |
|
LegendItemTemplateScript
Provides a means of setting LegendItemTemplate in the JavaScript environment.
Declaration
public string LegendItemTemplateScript { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the label format string to use for the label.
Declaration
public string LegendLabelFormat { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the format specifiers to use with the LegendLabelFormat string.
Declaration
public IgbFormatSpecifierCollection LegendLabelFormatSpecifiers { get; set; }
Property Value
LegendLabelMemberPath
Gets or sets the property name that contains the legend labels.
Declaration
public string LegendLabelMemberPath { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the label format string to use for the label.
Declaration
public string LegendOthersLabelFormat { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the format specifiers to use with the LegendOthersLabelFormat string.
Declaration
public IgbFormatSpecifierCollection LegendOthersLabelFormatSpecifiers { get; set; }
Property Value
LegendScript
Provides a means of setting Legend in the JavaScript environment.
Declaration
public string LegendScript { get; set; }
Property Value
Type |
Description |
System.String |
|
OthersCategoryFill
Gets or sets the fill brush.
Declaration
public string OthersCategoryFill { get; set; }
Property Value
Type |
Description |
System.String |
|
OthersCategoryOpacity
Gets or sets the opacity.
Declaration
public double OthersCategoryOpacity { get; set; }
Property Value
Type |
Description |
System.Double |
|
OthersCategoryStroke
Gets or sets the stroke brush.
Declaration
public string OthersCategoryStroke { get; set; }
Property Value
Type |
Description |
System.String |
|
OthersCategoryStrokeThickness
Gets or sets the stroke thickness.
Declaration
public double OthersCategoryStrokeThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
OthersCategoryText
Gets or sets the label of the Others slice.
Declaration
public string OthersCategoryText { get; set; }
Property Value
Type |
Description |
System.String |
|
OthersCategoryThreshold
Gets or sets the threshold value that determines if slices are grouped into the Others slice.
Declaration
public double OthersCategoryThreshold { get; set; }
Property Value
Type |
Description |
System.Double |
|
OthersCategoryType
Gets or sets whether to use numeric or percent-based threshold value.
Declaration
public OthersCategoryType OthersCategoryType { get; set; }
Property Value
Gets or sets the label format string to use for the label.
Declaration
public string OthersLabelFormat { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the format specifiers to use with the OthersLabelFormat string.
Declaration
public IgbFormatSpecifierCollection OthersLabelFormatSpecifiers { get; set; }
Property Value
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 |
|
ParentTypeName
Declaration
protected override string ParentTypeName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
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 |
|
RadiusFactor
Gets or sets the scaling factor of the chart's radius. Value between 0 and 1.
Declaration
public double RadiusFactor { get; set; }
Property Value
Type |
Description |
System.Double |
|
SelectedItem
Gets or sets the currently selected data item. If a different data item is provided the pie chart
will select the slice associated with the new item.
Declaration
public object SelectedItem { get; set; }
Property Value
Type |
Description |
System.Object |
|
SelectedItemChanged
Declaration
public EventCallback<IgbSelectedItemChangedEventArgs> SelectedItemChanged { get; set; }
Property Value
SelectedItemChangedScript
Declaration
public string SelectedItemChangedScript { get; set; }
Property Value
Type |
Description |
System.String |
|
SelectedItemChanging
Declaration
public EventCallback<IgbSelectedItemChangingEventArgs> SelectedItemChanging { get; set; }
Property Value
SelectedItemChangingScript
Declaration
public string SelectedItemChangingScript { get; set; }
Property Value
Type |
Description |
System.String |
|
SelectedItems
Gets the currently selected data items. Adding or removing data items from this collection will
select or deselect the slices associated with those items.
Declaration
public IgbObjectCollection SelectedItems { get; set; }
Property Value
SelectedItemsChanged
Declaration
public EventCallback<IgbSelectedItemsChangedEventArgs> SelectedItemsChanged { get; set; }
Property Value
SelectedItemsChangedScript
Declaration
public string SelectedItemsChangedScript { get; set; }
Property Value
Type |
Description |
System.String |
|
SelectedItemsChanging
Declaration
public EventCallback<IgbSelectedItemsChangingEventArgs> SelectedItemsChanging { get; set; }
Property Value
SelectedItemsChangingScript
Declaration
public string SelectedItemsChangingScript { 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 |
|
SelectionMode
Gets or sets which mode to use for selecting slices.
Declaration
public SliceSelectionMode SelectionMode { get; set; }
Property Value
ShouldDisplayMockData
Gets or sets whether the pie chart should display mock data when data isn't present.
Declaration
public bool ShouldDisplayMockData { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Gets or sets whether the pie chart should use a skeleton style for mock data.
Declaration
public bool ShouldUseSkeletonStyleForMockData { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
SliceClick
Declaration
public EventCallback<IgbSliceClickEventArgs> SliceClick { get; set; }
Property Value
SliceClickScript
Declaration
public string SliceClickScript { get; set; }
Property Value
Type |
Description |
System.String |
|
SliceEnter
Declaration
public EventCallback<IgbSliceEventArgs> SliceEnter { get; set; }
Property Value
SliceEnterScript
Declaration
public string SliceEnterScript { get; set; }
Property Value
Type |
Description |
System.String |
|
SliceHover
Declaration
public EventCallback<IgbSliceEventArgs> SliceHover { get; set; }
Property Value
SliceHoverScript
Declaration
public string SliceHoverScript { get; set; }
Property Value
Type |
Description |
System.String |
|
SliceLeave
Declaration
public EventCallback<IgbSliceEventArgs> SliceLeave { get; set; }
Property Value
SliceLeaveScript
Declaration
public string SliceLeaveScript { get; set; }
Property Value
Type |
Description |
System.String |
|
StartAngle
Gets or sets the starting angle of the chart.
Declaration
public double StartAngle { get; set; }
Property Value
Type |
Description |
System.Double |
|
SweepDirection
Gets or sets the rotational direction of the chart.
Declaration
public SweepDirection SweepDirection { get; set; }
Property Value
TextStyle
Manually overrides the style to use for the labels.
Declaration
public string TextStyle { get; set; }
Property Value
Type |
Description |
System.String |
|
Type
Declaration
public override string Type { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
ValueMemberPath
Gets or Sets the property name that contains the values.
Declaration
public string ValueMemberPath { get; set; }
Property Value
Type |
Description |
System.String |
|
Methods
Destroy()
Declaration
DestroyAsync()
Invoked when the instance is being destroyed.
Declaration
public Task DestroyAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
ExportSerializedVisualData()
Declaration
public string ExportSerializedVisualData()
Returns
Type |
Description |
System.String |
|
ExportSerializedVisualDataAsync()
Returns the chart visuals expressed as a serialized string.
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
Flush()
Declaration
FlushAsync()
Use to force the pie chart to finish any deferred work before printing or evaluating its visual.
Declaration
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
GetCurrentSelectedItem()
Declaration
public object GetCurrentSelectedItem()
Returns
Type |
Description |
System.Object |
|
GetCurrentSelectedItemAsync()
Declaration
public Task<object> GetCurrentSelectedItemAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Object> |
|
GetCurrentSelectedItems()
Declaration
public IgbObjectCollection GetCurrentSelectedItems()
Returns
GetCurrentSelectedItemsAsync()
Declaration
public Task<IgbObjectCollection> GetCurrentSelectedItemsAsync()
Returns
NotifyClearItems(Object)
Declaration
public void NotifyClearItems(object source_)
Parameters
Type |
Name |
Description |
System.Object |
source_ |
|
NotifyClearItemsAsync(Object)
Manually notifies the pie 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 pie chart is bound to is already observable.
Declaration
public Task NotifyClearItemsAsync(object source_)
Parameters
Type |
Name |
Description |
System.Object |
source_ |
The data source.
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
NotifyContainerResized()
Declaration
public void NotifyContainerResized()
NotifyContainerResizedAsync()
Notification from the containing object that the container has been resized.
Declaration
public Task NotifyContainerResizedAsync()
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 |
|
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)
Invoked by the containing object to provide reference to the container.
Declaration
public Task ProvideContainerAsync(object container)
Parameters
Type |
Name |
Description |
System.Object |
container |
Reference to the container.
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Declaration
public void RemoveWidgetLevelDataSource()
Resets items data source.
Declaration
public Task RemoveWidgetLevelDataSourceAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Declaration
public void SetWidgetLevelDataSource(object source_)
Parameters
Type |
Name |
Description |
System.Object |
source_ |
|
Assigns data source for the items.
Declaration
public Task SetWidgetLevelDataSourceAsync(object source_)
Parameters
Type |
Name |
Description |
System.Object |
source_ |
Array of the data source items.
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
SimulateLeftClick(Point)
Declaration
public void SimulateLeftClick(Point point)
Parameters
Type |
Name |
Description |
Point |
point |
|
SimulateLeftClickAsync(Point)
Simulates a mouse click action at the specified point.
Declaration
public Task SimulateLeftClickAsync(Point point)
Parameters
Type |
Name |
Description |
Point |
point |
The point to click at.
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
StyleUpdated()
Declaration
public void StyleUpdated()
StyleUpdatedAsync()
Invoked when style is updated.
Declaration
public Task StyleUpdatedAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Implements
System.IDisposable