Class IgbRadialBase

Represents the base class for all IgbDataChart radial series

Inheritance
System.Object
BaseRendererElement
IgbSeries
IgbMarkerSeries
IgbRadialBase
IgbAnchoredRadialSeries
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbRadialBase : IgbMarkerSeries, JsonSerializable, IDisposable

Constructors

IgbRadialBase()

Declaration
public IgbRadialBase()

Properties

AngleAxis

Gets the effective angle axis for the current series object.

Declaration
public IgbCategoryAngleAxis AngleAxis { get; set; }
Property Value
Type Description
IgbCategoryAngleAxis

AngleAxisName

Gets or sets the name to use to resolve angleAxis from markup.

Declaration
public string AngleAxisName { get; set; }
Property Value
Type Description
System.String

AngleAxisScript

Provides a means of setting AngleAxis in the JavaScript environment.

Declaration
public string AngleAxisScript { get; set; }
Property Value
Type Description
System.String

AssigningRadialMarkerStyle

Declaration
public Action<IgbAssigningRadialMarkerStyleEventArgs> AssigningRadialMarkerStyle { get; set; }
Property Value
Type Description
System.Action<IgbAssigningRadialMarkerStyleEventArgs>

AssigningRadialMarkerStyleScript

Declaration
public string AssigningRadialMarkerStyleScript { get; set; }
Property Value
Type Description
System.String

AssigningRadialStyle

Declaration
public Action<IgbAssigningRadialStyleEventArgs> AssigningRadialStyle { get; set; }
Property Value
Type Description
System.Action<IgbAssigningRadialStyleEventArgs>

AssigningRadialStyleScript

Declaration
public string AssigningRadialStyleScript { get; set; }
Property Value
Type Description
System.String

AutoCalloutLabelPrecision

Gets or sets the format string to use for the auto callout labels for the others category.

Declaration
public int AutoCalloutLabelPrecision { get; set; }
Property Value
Type Description
System.Int32

AutoCalloutLabelValueSeparator

Gets or sets the labelling mode to use for the auto callouts in preference to their mode.

Declaration
public string AutoCalloutLabelValueSeparator { get; set; }
Property Value
Type Description
System.String

AutoCalloutOthersLabelFormat

Gets or sets the format string to use for the auto callout labels for the others category.

Declaration
public string AutoCalloutOthersLabelFormat { get; set; }
Property Value
Type Description
System.String

AutoCalloutOthersLabelFormatSpecifiers

Gets or sets the format specifiers to use with the auto callouts for the others category.

Declaration
public IgbFormatSpecifierCollection AutoCalloutOthersLabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

AutoCalloutPercentagePrecision

Gets or sets the format string to use for the auto callout labels for the others category.

Declaration
public int AutoCalloutPercentagePrecision { get; set; }
Property Value
Type Description
System.Int32

AutoCalloutRadialLabelMode

Gets or sets the labelling mode to use for the auto callouts in preference to their mode.

Declaration
public RadialLabelMode AutoCalloutRadialLabelMode { get; set; }
Property Value
Type Description
RadialLabelMode

CategoryCollisionMode

Gets or sets the category collision mode selection behavior to use for the series.

Declaration
public CategoryCollisionMode CategoryCollisionMode { get; set; }
Property Value
Type Description
CategoryCollisionMode

ClipSeriesToBounds

Gets or sets whether to clip the series to the bounds.

Declaration
public bool ClipSeriesToBounds { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Setting this property to true will decrease chart performance.

IsCustomRadialMarkerStyleAllowed

Gets or sets whether this Radial series should allow custom style overrides of its individual marker visuals.

Declaration
public bool IsCustomRadialMarkerStyleAllowed { get; set; }
Property Value
Type Description
System.Boolean

IsCustomRadialStyleAllowed

Gets or sets whether this Radial series should allow custom style overrides of its individual visuals.

Declaration
public bool IsCustomRadialStyleAllowed { get; set; }
Property Value
Type Description
System.Boolean

IsTransitionInEnabled

Gets or sets whether the series should transition into the plot area when a new data source is assigned. Note: Transitions are not currently supported for stacked series.

Declaration
public bool IsTransitionInEnabled { get; set; }
Property Value
Type Description
System.Boolean

LegendProportionalRadialLabelFormat

Gets or sets the format string to use for the auto callout labels for the others category.

Declaration
public string LegendProportionalRadialLabelFormat { get; set; }
Property Value
Type Description
System.String

LegendProportionalRadialLabelFormatSpecifiers

Gets or sets the format specifiers to use with the auto callouts for the others category.

Declaration
public IgbFormatSpecifierCollection LegendProportionalRadialLabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

LegendRadialLabelMode

Gets or sets the labelling mode to use for the auto callouts in preference to their mode.

Declaration
public RadialLabelMode LegendRadialLabelMode { get; set; }
Property Value
Type Description
RadialLabelMode

OthersCategoryBrush

Gets or sets the OthersCategoryBrush property.

Declaration
public string OthersCategoryBrush { get; set; }
Property Value
Type Description
System.String

OthersCategoryOutline

Gets or sets the OthersCategoryOutline property.

Declaration
public string OthersCategoryOutline { get; set; }
Property Value
Type Description
System.String

OthersLegendProportionalRadialLabelFormat

Gets or sets the format string to use for the auto callout labels for the others category.

Declaration
public string OthersLegendProportionalRadialLabelFormat { get; set; }
Property Value
Type Description
System.String

OthersLegendProportionalRadialLabelFormatSpecifiers

Gets or sets the format specifiers to use with the auto callouts for the others category.

Declaration
public IgbFormatSpecifierCollection OthersLegendProportionalRadialLabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

OthersProportionalRadialLabelFormat

Gets or sets the format string to use for the auto callout labels for the others category.

Declaration
public string OthersProportionalRadialLabelFormat { get; set; }
Property Value
Type Description
System.String

OthersProportionalRadialLabelFormatSpecifiers

Gets or sets the format specifiers to use with the auto callouts for the others category.

Declaration
public IgbFormatSpecifierCollection OthersProportionalRadialLabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

ProportionalRadialLabelFormat

Gets or sets the format string to use for the auto callout labels for the others category.

Declaration
public string ProportionalRadialLabelFormat { get; set; }
Property Value
Type Description
System.String

ProportionalRadialLabelFormatSpecifiers

Gets or sets the format specifiers to use with the auto callouts for the others category.

Declaration
public IgbFormatSpecifierCollection ProportionalRadialLabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

TransitionInMode

Gets or sets the method by which to animate the data into the chart when the chart data source is swapped. Note: Transitions are not currently supported for stacked series.

Declaration
public CategoryTransitionInMode TransitionInMode { get; set; }
Property Value
Type Description
CategoryTransitionInMode

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

ValueAxis

Gets the effective value axis for the current series object.

Declaration
public IgbNumericRadiusAxis ValueAxis { get; set; }
Property Value
Type Description
IgbNumericRadiusAxis

ValueAxisName

Gets or sets the name to use to resolve valueAxis from markup.

Declaration
public string ValueAxisName { get; set; }
Property Value
Type Description
System.String

ValueAxisScript

Provides a means of setting ValueAxis in the JavaScript environment.

Declaration
public string ValueAxisScript { get; set; }
Property Value
Type Description
System.String

Methods

BindAxes(IgbAxis[])

Declaration
protected override void BindAxes(IgbAxis[] Axes)
Parameters
Type Name Description
IgbAxis[] Axes
Overrides

CanUseAsAngleAxis(Object)

Declaration
public bool CanUseAsAngleAxis(object axis)
Parameters
Type Name Description
System.Object axis
Returns
Type Description
System.Boolean

CanUseAsAngleAxisAsync(Object)

Determine if object can be used as AngleAxis

Declaration
public Task<bool> CanUseAsAngleAxisAsync(object axis)
Parameters
Type Name Description
System.Object axis

The object to check
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

CanUseAsValueAxis(Object)

Declaration
public bool CanUseAsValueAxis(object axis)
Parameters
Type Name Description
System.Object axis
Returns
Type Description
System.Boolean

CanUseAsValueAxisAsync(Object)

Determine if object can be used as ValueAxis

Declaration
public Task<bool> CanUseAsValueAxisAsync(object axis)
Parameters
Type Name Description
System.Object axis

The object to check
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

GetAngleFromWorld(Point)

Declaration
public virtual double GetAngleFromWorld(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Double

GetAngleFromWorldAsync(Point)

Gets the angle to the provided world position from the center of the radial series.

Declaration
public virtual Task<double> GetAngleFromWorldAsync(Point world)
Parameters
Type Name Description
Point world

The world position to get the angle for
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetCategoryWidth()

Declaration
public virtual double GetCategoryWidth()
Returns
Type Description
System.Double

GetCategoryWidthAsync()

Returns the width of the category grouping this series is in.

Declaration
public virtual Task<double> GetCategoryWidthAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetExactItemIndex(Point)

Declaration
public override double GetExactItemIndex(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Double
Overrides

GetExactItemIndexAsync(Point)

Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex.

Declaration
public override Task<double> GetExactItemIndexAsync(Point world)
Parameters
Type Name Description
Point world

The world position for which to return the index.
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

GetItem(Point)

Declaration
public override object GetItem(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Object
Overrides

GetItemAsync(Point)

Gets the item that is the best match for the specified world coordinates.

Declaration
public override Task<object> GetItemAsync(Point world)
Parameters
Type Name Description
Point world

The world coordinates to use.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>
Overrides

GetItemIndex(Point)

Declaration
public override int GetItemIndex(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Int32
Overrides

GetItemIndexAsync(Point)

Get the index of the item near the provided world coordinates.

Declaration
public override Task<int> GetItemIndexAsync(Point world)
Parameters
Type Name Description
Point world

The world coordinates for which to getch the item index.
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides

GetOffsetValue()

Declaration
public virtual double GetOffsetValue()
Returns
Type Description
System.Double

GetOffsetValueAsync()

Returns the offset value for this series if grouped on a category axis.

Declaration
public virtual Task<double> GetOffsetValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetUnscaledPosition(Point)

Declaration
public override Point GetUnscaledPosition(Point pos)
Parameters
Type Name Description
Point pos
Returns
Type Description
Point
Overrides

GetUnscaledPositionAsync(Point)

Gets an unscaled position in terms of axis values from a viewport position.

Declaration
public override Task<Point> GetUnscaledPositionAsync(Point pos)
Parameters
Type Name Description
Point pos

The viewport relative position
Returns
Type Description
System.Threading.Tasks.Task<Point>
Overrides

ScrollIntoView(Object)

Declaration
public override bool ScrollIntoView(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
System.Boolean
Overrides

ScrollIntoViewAsync(Object)

Scrolls the specified item into the view.

Declaration
public override Task<bool> ScrollIntoViewAsync(object item)
Parameters
Type Name Description
System.Object item

The item to scroll into view.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Overrides

Implements

System.IDisposable