Class IgbCategoryAxisBase

Represents the base class for all IgbDataChart category-based axes.

Inheritance
System.Object
BaseRendererElement
IgbAxis
IgbCategoryAxisBase
IgbCategoryAngleAxis
IgbCategoryXAxis
IgbCategoryYAxis
IgbTimeAxisBase
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCategoryAxisBase : IgbAxis, JsonSerializable, IDisposable

Constructors

IgbCategoryAxisBase()

Declaration
public IgbCategoryAxisBase()

Properties

DataSource

Gets or sets the ItemsSource property for the current axis.

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

Gap

Gets or sets the amount of space between adjacent categories for the current axis object.

Declaration
public double Gap { get; set; }
Property Value
Type Description
System.Double
Remarks

The gap is silently clamped to the range [0, 1] when used.

ItemsCount

Gets the number of items in the current category axis items source.

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

ItemsCountChanged

Declaration
public Action<int> ItemsCountChanged { get; set; }
Property Value
Type Description
System.Action<System.Int32>

ItemsCountChangedScript

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

MaximumGap

Gets or sets the maximum gap value to allow. This defaults to 1.0.

Declaration
public double MaximumGap { get; set; }
Property Value
Type Description
System.Double

MinimumGapSize

Gets or sets the minimum amount of pixels to use for the gap between categories, if possible.

Declaration
public double MinimumGapSize { get; set; }
Property Value
Type Description
System.Double

Overlap

Gets or sets the amount of overlap between adjacent categories for the current axis object.

Declaration
public double Overlap { get; set; }
Property Value
Type Description
System.Double
Remarks

The overlap is silently clamped to the range [-1, 1] when used.

Type

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

UseClusteringMode

Gets or sets whether the category axis should use clustering display mode even if no series are present that would force clustering mode.

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

Methods

FindByName(String)

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

GetCategoryBoundingBox(Point, Boolean, Double)

Declaration
public virtual Rect GetCategoryBoundingBox(Point point, bool useInterpolation, double singularWidth)
Parameters
Type Name Description
Point point
System.Boolean useInterpolation
System.Double singularWidth
Returns
Type Description
Rect

GetCategoryBoundingBoxAsync(Point, Boolean, Double)

Declaration
public virtual Task<Rect> GetCategoryBoundingBoxAsync(Point point, bool useInterpolation, double singularWidth)
Parameters
Type Name Description
Point point
System.Boolean useInterpolation
System.Double singularWidth
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetCategoryBoundingBoxHelper(Point, Boolean, Double, Boolean)

Declaration
public virtual Rect GetCategoryBoundingBoxHelper(Point point, bool useInterpolation, double singularWidth, bool isVertical)
Parameters
Type Name Description
Point point
System.Boolean useInterpolation
System.Double singularWidth
System.Boolean isVertical
Returns
Type Description
Rect

GetCategoryBoundingBoxHelperAsync(Point, Boolean, Double, Boolean)

Declaration
public virtual Task<Rect> GetCategoryBoundingBoxHelperAsync(Point point, bool useInterpolation, double singularWidth, bool isVertical)
Parameters
Type Name Description
Point point
System.Boolean useInterpolation
System.Double singularWidth
System.Boolean isVertical
Returns
Type Description
System.Threading.Tasks.Task<Rect>

GetCurrentItemsCount()

Declaration
public int GetCurrentItemsCount()
Returns
Type Description
System.Int32

GetCurrentItemsCountAsync()

Declaration
public Task<int> GetCurrentItemsCountAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

GetFullRange()

Declaration
public override double[] GetFullRange()
Returns
Type Description
System.Double[]
Overrides

GetFullRangeAsync()

Declaration
public override Task<double[]> GetFullRangeAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Double[]>
Overrides

NotifyClearItems()

Declaration
public void NotifyClearItems()

NotifyClearItemsAsync()

Used to manually notify the axis that the data source has reset or cleared its items.

Declaration
public Task NotifyClearItemsAsync()
Returns
Type Description
System.Threading.Tasks.Task

NotifyInsertItem(Int32, Object)

Declaration
public void NotifyInsertItem(int index, object newItem)
Parameters
Type Name Description
System.Int32 index
System.Object newItem

NotifyInsertItemAsync(Int32, Object)

Declaration
public Task NotifyInsertItemAsync(int index, object newItem)
Parameters
Type Name Description
System.Int32 index
System.Object newItem
Returns
Type Description
System.Threading.Tasks.Task

NotifyRemoveItem(Int32, Object)

Declaration
public void NotifyRemoveItem(int index, object oldItem)
Parameters
Type Name Description
System.Int32 index
System.Object oldItem

NotifyRemoveItemAsync(Int32, Object)

Declaration
public Task NotifyRemoveItemAsync(int index, object oldItem)
Parameters
Type Name Description
System.Int32 index
System.Object oldItem
Returns
Type Description
System.Threading.Tasks.Task

NotifySetItem(Int32, Object, Object)

Declaration
public void NotifySetItem(int index, object oldItem, object newItem)
Parameters
Type Name Description
System.Int32 index
System.Object oldItem
System.Object newItem

NotifySetItemAsync(Int32, Object, Object)

Declaration
public Task NotifySetItemAsync(int index, object oldItem, object newItem)
Parameters
Type Name Description
System.Int32 index
System.Object oldItem
System.Object newItem
Returns
Type Description
System.Threading.Tasks.Task

UnscaleValue(Double)

Declaration
public virtual double UnscaleValue(double unscaledValue)
Parameters
Type Name Description
System.Double unscaledValue
Returns
Type Description
System.Double

UnscaleValueAsync(Double)

Unscales a value from screen space into axis space.

Declaration
public virtual Task<double> UnscaleValueAsync(double unscaledValue)
Parameters
Type Name Description
System.Double unscaledValue

The scaled value in screen coordinates to unscale into axis space.
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

Implements

System.IDisposable