Show / Hide Table of Contents

Class IgbCategoryYAxis

Represents a IgbDataChart category Y axis.

Inheritance
System.Object
BaseRendererElement
IgbAxis
IgbCategoryAxisBase
IgbCategoryYAxis
Implements
JsonSerializable
System.IDisposable
Inherited Members
IgbCategoryAxisBase.GetCurrentItemsCountAsync()
IgbCategoryAxisBase.GetCurrentItemsCount()
IgbCategoryAxisBase.GetFullRangeAsync()
IgbCategoryAxisBase.GetFullRange()
IgbCategoryAxisBase.GetCategoryBoundingBoxHelperAsync(Point, Boolean, Double, Boolean)
IgbCategoryAxisBase.GetCategoryBoundingBoxHelper(Point, Boolean, Double, Boolean)
IgbCategoryAxisBase.UnscaleValueAsync(Double)
IgbCategoryAxisBase.UnscaleValue(Double)
IgbCategoryAxisBase.NotifySetItemAsync(Int32, Object, Object)
IgbCategoryAxisBase.NotifySetItem(Int32, Object, Object)
IgbCategoryAxisBase.NotifyClearItemsAsync()
IgbCategoryAxisBase.NotifyClearItems()
IgbCategoryAxisBase.NotifyInsertItemAsync(Int32, Object)
IgbCategoryAxisBase.NotifyInsertItem(Int32, Object)
IgbCategoryAxisBase.NotifyRemoveItemAsync(Int32, Object)
IgbCategoryAxisBase.NotifyRemoveItem(Int32, Object)
IgbCategoryAxisBase.DataSource
IgbCategoryAxisBase.DataSourceScript
IgbCategoryAxisBase.ItemsCount
IgbCategoryAxisBase.Gap
IgbCategoryAxisBase.MaximumGap
IgbCategoryAxisBase.MinimumGapSize
IgbCategoryAxisBase.Overlap
IgbCategoryAxisBase.UseClusteringMode
IgbCategoryAxisBase.ItemsCountChangedScript
IgbCategoryAxisBase.ItemsCountChanged
IgbAxis.Dispose()
IgbAxis.OnInitializedAsync()
IgbAxis.BindAxes(IgbAxis[])
IgbAxis.RenderAxisAsync()
IgbAxis.RenderAxis()
IgbAxis.ResetCachedEnhancedIntervalAsync()
IgbAxis.ResetCachedEnhancedInterval()
IgbAxis.GetItemValueAsync(Object, String)
IgbAxis.GetItemValue(Object, String)
IgbAxis.GetValueLabelAsync(Double)
IgbAxis.GetValueLabel(Double)
IgbAxis.ScaleValueAsync(Double)
IgbAxis.ScaleValue(Double)
IgbAxis.SeriesViewerParent
IgbAxis.ParentTypeName
IgbAxis.Label
IgbAxis.ContentLabelFormatSpecifiers
IgbAxis.ActualLabelFormatSpecifiers
IgbAxis.ContentAnnotations
IgbAxis.ActualAnnotations
IgbAxis.FormatLabelScript
IgbAxis.Title
IgbAxis.Stroke
IgbAxis.ActualStroke
IgbAxis.StrokeThickness
IgbAxis.StrokeDashArray
IgbAxis.Strip
IgbAxis.MajorStroke
IgbAxis.ActualMajorStroke
IgbAxis.MajorStrokeThickness
IgbAxis.MajorStrokeDashArray
IgbAxis.MinorStroke
IgbAxis.ActualMinorStroke
IgbAxis.MinorStrokeThickness
IgbAxis.MinorStrokeDashArray
IgbAxis.TickStroke
IgbAxis.TickStrokeThickness
IgbAxis.TickStrokeDashArray
IgbAxis.TickLength
IgbAxis.IsDisabled
IgbAxis.IsInverted
IgbAxis.ShouldAvoidAnnotationCollisions
IgbAxis.ShouldKeepAnnotationsInView
IgbAxis.UsePerLabelHeightMeasurement
IgbAxis.UseEnhancedIntervalManagement
IgbAxis.EnhancedIntervalMinimumCharacters
IgbAxis.EnhancedIntervalPreferMoreCategoryLabels
IgbAxis.LabelFontFamily
IgbAxis.LabelFontSize
IgbAxis.LabelFontStyle
IgbAxis.LabelFontWeight
IgbAxis.LabelTextColor
IgbAxis.LabelLocation
IgbAxis.LabelVisibility
IgbAxis.LabelShowFirstLabel
IgbAxis.LabelAngle
IgbAxis.LabelExtent
IgbAxis.LabelMaximumExtent
IgbAxis.LabelMaximumExtentPercentage
IgbAxis.LabelLeftMargin
IgbAxis.LabelRightMargin
IgbAxis.LabelTopMargin
IgbAxis.LabelBottomMargin
IgbAxis.LabelHorizontalAlignment
IgbAxis.LabelVerticalAlignment
IgbAxis.CrossingAxis
IgbAxis.CrossingAxisScript
IgbAxis.CrossingAxisName
IgbAxis.CrossingValue
IgbAxis.TitlePosition
IgbAxis.TitleFontFamily
IgbAxis.TitleFontSize
IgbAxis.TitleFontStyle
IgbAxis.TitleFontWeight
IgbAxis.TitleTextColor
IgbAxis.TitleLocation
IgbAxis.TitleVisibility
IgbAxis.TitleShowFirstLabel
IgbAxis.TitleAngle
IgbAxis.TitleExtent
IgbAxis.TitleMaximumExtent
IgbAxis.TitleMaximumExtentPercentage
IgbAxis.TitleLeftMargin
IgbAxis.TitleRightMargin
IgbAxis.TitleTopMargin
IgbAxis.TitleBottomMargin
IgbAxis.TitleHorizontalAlignment
IgbAxis.TitleVerticalAlignment
IgbAxis.Annotations
IgbAxis.CoercionMethods
IgbAxis.CoercionMethodsScript
IgbAxis.ExpectFunctions
IgbAxis.LabelFormat
IgbAxis.LabelFormatSpecifiers
IgbAxis.RangeChangedScript
IgbAxis.RangeChanged
IgbAxis.RenderRequestedScript
IgbAxis.RenderRequested
BaseRendererElement._name
BaseRendererElement.eventCallbacksCache
BaseRendererElement._cachedSerializedContent
BaseRendererElement.BuildRenderTree(RenderTreeBuilder)
BaseRendererElement.OnElementNameChanged(BaseRendererElement, String, String)
BaseRendererElement.InvokeMethod(String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodSync(String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodHelper(String, String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodHelperSync(String, String, Object[], String[], ElementReference[])
BaseRendererElement.IsPropDirty(String)
BaseRendererElement.Serialize(SerializationContext, String)
BaseRendererElement.Serialize()
BaseRendererElement.EnsureValid()
BaseRendererElement.FromEventJson(BaseRendererControl, Dictionary<String, Object>)
BaseRendererElement.ToEventJson(BaseRendererControl, Dictionary<String, Object>)
BaseRendererElement.SetResourceStringAsync(String, String, String)
BaseRendererElement.SetResourceStringAsync(String, String)
BaseRendererElement.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)
BaseRendererElement.IgBlazor
BaseRendererElement.IsComponentRooted
BaseRendererElement.UseDirectRender
BaseRendererElement.ChildContent
BaseRendererElement.SupportsVisualChildren
BaseRendererElement.Name
BaseRendererElement.Parent
BaseRendererElement.MethodTarget
BaseRendererElement.CurrParent
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCategoryYAxis : IgbCategoryAxisBase, JsonSerializable, IDisposable

Constructors

IgbCategoryYAxis()

Declaration
public IgbCategoryYAxis()

Properties

ActualInterval

Gets the effective value for the current Interval.

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

ActualIntervalChanged

Declaration
public Action<double> ActualIntervalChanged { get; set; }
Property Value
Type Description
System.Action<System.Double>

ActualIntervalChangedScript

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

ActualMinorInterval

Gets the effective value for the current MinorInterval.

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

ActualMinorIntervalChanged

Declaration
public Action<double> ActualMinorIntervalChanged { get; set; }
Property Value
Type Description
System.Action<System.Double>

ActualMinorIntervalChangedScript

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

Interval

Gets or sets the frequency of displayed labels.

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

The set value is a factor that determines which labels will be hidden. For example, an interval of 2 will display every other label.

MinorInterval

Gets or sets the frequency of displayed minor lines.

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

The set value is a factor that determines how the minor lines will be displayed.

Type

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

ZoomMaximumCategoryRange

Gets or sets number of visible categories at maximum zooming level

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

This property is overridden by chart's WindowRectMinWidth property

ZoomMaximumItemSpan

Gets or sets maximum pixel span of series item that will be visible at maximum zooming level This property ensures that series item does not get stretch above specified value.

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

This property is overridden by chart's WindowRectMinWidth property

ZoomToCategoryRange

Gets or sets range of categories that the chart will zoom in and fill plot area

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

This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

ZoomToCategoryStart

Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items

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

This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

ZoomToItemSpan

Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span Chart will automaticlly zoom in until series item has specified pixel span.

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

This property is overridden by chart's WindowRect or WindowScaleHorizontal properties

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides
BaseRendererElement.EnsureModulesLoaded()

FindByName(String)

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

GetCategoryBoundingBox(Point, Boolean, Double)

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

GetCategoryBoundingBoxAsync(Point, Boolean, Double)

Declaration
public override 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>
Overrides
IgbCategoryAxisBase.GetCategoryBoundingBoxAsync(Point, Boolean, Double)

GetCurrentActualInterval()

Declaration
public double GetCurrentActualInterval()
Returns
Type Description
System.Double

GetCurrentActualIntervalAsync()

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

GetCurrentActualMinorInterval()

Declaration
public double GetCurrentActualMinorInterval()
Returns
Type Description
System.Double

GetCurrentActualMinorIntervalAsync()

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

GetWindowZoomFromCategories(Double)

Declaration
public double GetWindowZoomFromCategories(double categoriesCount)
Parameters
Type Name Description
System.Double categoriesCount
Returns
Type Description
System.Double

GetWindowZoomFromCategoriesAsync(Double)

Gets window zoom scale required to zoom to specified number of categories

Declaration
public Task<double> GetWindowZoomFromCategoriesAsync(double categoriesCount)
Parameters
Type Name Description
System.Double categoriesCount
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

GetWindowZoomFromItemSpan(Double)

Declaration
public double GetWindowZoomFromItemSpan(double pixels)
Parameters
Type Name Description
System.Double pixels
Returns
Type Description
System.Double

GetWindowZoomFromItemSpanAsync(Double)

Gets window zoom scale required to zoom to specified span of series item

Declaration
public Task<double> GetWindowZoomFromItemSpanAsync(double pixels)
Parameters
Type Name Description
System.Double pixels
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

ScrollIntoView(Object)

Declaration
public void ScrollIntoView(object item)
Parameters
Type Name Description
System.Object item

ScrollIntoViewAsync(Object)

Scrolls the specified item into view.

Declaration
public Task ScrollIntoViewAsync(object item)
Parameters
Type Name Description
System.Object item

Data item to scroll into view

Returns
Type Description
System.Threading.Tasks.Task

ScrollRangeIntoView(Double, Double)

Declaration
public void ScrollRangeIntoView(double minimum, double maximum)
Parameters
Type Name Description
System.Double minimum
System.Double maximum

ScrollRangeIntoViewAsync(Double, Double)

Declaration
public Task ScrollRangeIntoViewAsync(double minimum, double maximum)
Parameters
Type Name Description
System.Double minimum
System.Double maximum
Returns
Type Description
System.Threading.Tasks.Task

Implements

JsonSerializable
System.IDisposable