Class IgbPolarBase
Represents the base class from which all IgbDataChart polar series are derived.
Inheritance
System.Object
IgbPolarBase
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbPolarBase : IgbMarkerSeries, JsonSerializable
Constructors
IgbPolarBase()
Declaration
Properties
ActualItemSearchMode
Declaration
public ScatterItemSearchMode ActualItemSearchMode { get; set; }
Property Value
ActualTrendLineBrush
Gets the effective TrendLineBrush for this series.
Declaration
public string ActualTrendLineBrush { get; set; }
Property Value
Type |
Description |
System.String |
|
AngleAxis
Gets the effective angle axis for the current series object.
Declaration
public IgbNumericAngleAxis AngleAxis { get; set; }
Property Value
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 |
|
AngleMemberAsLegendLabel
Gets or sets the label displayed before series' angle value in the Data Legend.
Declaration
public string AngleMemberAsLegendLabel { get; set; }
Property Value
Type |
Description |
System.String |
|
AngleMemberAsLegendUnit
Gets or sets the unit displayed after series' angle value in the Data Legend.
Declaration
public string AngleMemberAsLegendUnit { get; set; }
Property Value
Type |
Description |
System.String |
|
AngleMemberPath
Gets or sets the path to use to find the angle values for the series.
Declaration
public string AngleMemberPath { get; set; }
Property Value
Type |
Description |
System.String |
|
AssigningPolarMarkerStyle
Declaration
public Action<IgbAssigningPolarMarkerStyleEventArgs> AssigningPolarMarkerStyle { get; set; }
Property Value
AssigningPolarMarkerStyleScript
Declaration
public string AssigningPolarMarkerStyleScript { get; set; }
Property Value
Type |
Description |
System.String |
|
AssigningPolarStyle
Declaration
public Action<IgbAssigningPolarStyleEventArgs> AssigningPolarStyle { get; set; }
Property Value
AssigningPolarStyleScript
Declaration
public string AssigningPolarStyleScript { get; set; }
Property Value
Type |
Description |
System.String |
|
ClipSeriesToBounds
Gets or sets whether to clip the series to the bounds.
Declaration
public bool ClipSeriesToBounds { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsCustomPolarMarkerStyleAllowed
Gets or sets whether this Polar series should allow custom style overrides of its individual marker visuals.
Declaration
public bool IsCustomPolarMarkerStyleAllowed { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsCustomPolarStyleAllowed
Gets or sets whether this Polar series should allow custom style overrides of its individual visuals.
Declaration
public bool IsCustomPolarStyleAllowed { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ItemSearchMode
Gets or sets the mode the series will use to find the closest point to the cursor.
Declaration
public ScatterItemSearchMode ItemSearchMode { get; set; }
Property Value
ItemSearchThreshold
Gets or sets the threshold to use when searching for items using ItemSearchMode.
Declaration
public int ItemSearchThreshold { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
MaximumMarkers
Gets or sets the maximum number of markers displayed by the current series.
If more than the specified number of markers are visible, the polar series will automatically
choose a representative set.
Declaration
public int MaximumMarkers { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
RadiusAxis
Gets the effective radius axis for the current series object.
Declaration
public IgbNumericRadiusAxis RadiusAxis { get; set; }
Property Value
RadiusAxisName
Gets or sets the name to use to resolve radiusAxis from markup.
Declaration
public string RadiusAxisName { get; set; }
Property Value
Type |
Description |
System.String |
|
RadiusAxisScript
Provides a means of setting RadiusAxis in the JavaScript environment.
Declaration
public string RadiusAxisScript { get; set; }
Property Value
Type |
Description |
System.String |
|
RadiusMemberAsLegendLabel
Gets or sets the label displayed before series' radius value in the Data Legend.
Declaration
public string RadiusMemberAsLegendLabel { get; set; }
Property Value
Type |
Description |
System.String |
|
RadiusMemberAsLegendUnit
Gets or sets the unit displayed after series' radius value in the Data Legend.
Declaration
public string RadiusMemberAsLegendUnit { get; set; }
Property Value
Type |
Description |
System.String |
|
RadiusMemberPath
Gets or sets the path to use to get the radius values for the series.
Declaration
public string RadiusMemberPath { get; set; }
Property Value
Type |
Description |
System.String |
|
TrendLineBrush
Gets or sets the brush that specifies how the current series
object's trend line is drawn.
Declaration
public string TrendLineBrush { get; set; }
Property Value
Type |
Description |
System.String |
|
TrendLineDashArray
Declaration
public double[] TrendLineDashArray { get; set; }
Property Value
Type |
Description |
System.Double[] |
|
TrendLinePeriod
Gets or sets the moving average period for the current series object.
Declaration
public int TrendLinePeriod { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
TrendLineThickness
Gets or sets the thickness of the current series object's trend line.
Declaration
public double TrendLineThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
TrendLineType
Gets or sets the trend type for the current series object.
Declaration
public TrendLineType TrendLineType { get; set; }
Property Value
TrendLineZIndex
Sets or Gets the Trendline Z index.
Declaration
public int TrendLineZIndex { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
Type
Declaration
public override string Type { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
UseCartesianInterpolation
Gets or sets whether Cartesian Interpolation should be used rather than Archimedian
spiral based interpolation.
Declaration
public bool UseCartesianInterpolation { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
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> |
|
CanUseAsRadiusAxis(Object)
Declaration
public bool CanUseAsRadiusAxis(object axis)
Parameters
Type |
Name |
Description |
System.Object |
axis |
|
Returns
Type |
Description |
System.Boolean |
|
CanUseAsRadiusAxisAsync(Object)
Determine if object can be used as RadiusAxis
Declaration
public Task<bool> CanUseAsRadiusAxisAsync(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
GetExactItemIndex(Point)
Declaration
public override double GetExactItemIndex(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
|
Returns
Type |
Description |
System.Double |
|
Overrides
GetExactItemIndexAsync(Point)
Declaration
public override Task<double> GetExactItemIndexAsync(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
|
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)
Gets the index of the item that resides at the provided world coordinates.
Declaration
public override Task<int> GetItemIndexAsync(Point world)
Parameters
Type |
Name |
Description |
Point |
world |
The world coordinates of the requested item.
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Int32> |
|
Overrides
GetItemValue(Object, String)
Declaration
public override object GetItemValue(object item, string memberPathName)
Parameters
Type |
Name |
Description |
System.Object |
item |
|
System.String |
memberPathName |
|
Returns
Type |
Description |
System.Object |
|
Overrides
GetItemValueAsync(Object, String)
Declaration
public override Task<object> GetItemValueAsync(object item, string memberPathName)
Parameters
Type |
Name |
Description |
System.Object |
item |
|
System.String |
memberPathName |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Object> |
|
Overrides
GetSeriesValuePosition(Point, Boolean, Boolean)
Declaration
public override Point GetSeriesValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type |
Name |
Description |
Point |
world |
|
System.Boolean |
useInterpolation |
|
System.Boolean |
skipUnknowns |
|
Returns
Overrides
GetSeriesValuePositionAsync(Point, Boolean, Boolean)
Declaration
public override Task<Point> GetSeriesValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type |
Name |
Description |
Point |
world |
|
System.Boolean |
useInterpolation |
|
System.Boolean |
skipUnknowns |
|
Returns
Type |
Description |
System.Threading.Tasks.Task<Point> |
|
Overrides
Declaration
public override bool ScrollIntoView(object item)
Parameters
Type |
Name |
Description |
System.Object |
item |
|
Returns
Type |
Description |
System.Boolean |
|
Overrides
Scrolls the requested item into view, if possible.
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