Show / Hide Table of Contents

Class IgbTimeAxisBase

Represents an category-based horizontal X axis that uses a DateTime scale.

Inheritance
System.Object
BaseRendererElement
IgbAxis
IgbCategoryAxisBase
IgbTimeAxisBase
IgbCategoryDateTimeXAxis
IgbTimeXAxis
Implements
JsonSerializable
System.IDisposable
Inherited Members
IgbCategoryAxisBase.GetCurrentItemsCountAsync()
IgbCategoryAxisBase.GetCurrentItemsCount()
IgbCategoryAxisBase.GetCategoryBoundingBoxAsync(Point, Boolean, Double)
IgbCategoryAxisBase.GetCategoryBoundingBox(Point, Boolean, Double)
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.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.EnsureModulesLoaded()
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 IgbTimeAxisBase : IgbCategoryAxisBase, JsonSerializable, IDisposable

Constructors

IgbTimeAxisBase()

Declaration
public IgbTimeAxisBase()

Properties

ActualMaximumValue

Gets the coerced maximum value.

Declaration
public DateTime ActualMaximumValue { get; set; }
Property Value
Type Description
System.DateTime

ActualMaximumValueChanged

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

ActualMaximumValueChangedScript

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

ActualMinimumValue

Gets the coerced minimum value.

Declaration
public DateTime ActualMinimumValue { get; set; }
Property Value
Type Description
System.DateTime

ActualMinimumValueChanged

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

ActualMinimumValueChangedScript

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

DateTimeMemberPath

Gets or sets the DateTime mapping property for the axis.

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

IsDataPreSorted

Gets or sets whether the data assigned to the date time axis should be considered pre-sorted by date/time.

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

MaximumValue

Gets or sets the axis MaximumValue.

Declaration
public DateTime MaximumValue { get; set; }
Property Value
Type Description
System.DateTime

MinimumValue

Gets or sets the axis MinimumValue.

Declaration
public DateTime MinimumValue { get; set; }
Property Value
Type Description
System.DateTime

Type

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

Methods

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)

GetCurrentActualMaximumValue()

Declaration
public DateTime GetCurrentActualMaximumValue()
Returns
Type Description
System.DateTime

GetCurrentActualMaximumValueAsync()

Declaration
public Task<DateTime> GetCurrentActualMaximumValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.DateTime>

GetCurrentActualMinimumValue()

Declaration
public DateTime GetCurrentActualMinimumValue()
Returns
Type Description
System.DateTime

GetCurrentActualMinimumValueAsync()

Declaration
public Task<DateTime> GetCurrentActualMinimumValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.DateTime>

GetFullRange()

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

GetFullRangeAsync()

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

GetIndexClosestToUnscaledValue(Double)

Declaration
public virtual int GetIndexClosestToUnscaledValue(double unscaledValue)
Parameters
Type Name Description
System.Double unscaledValue
Returns
Type Description
System.Int32

GetIndexClosestToUnscaledValueAsync(Double)

Gets the index of the data item with the value nearest the given value.

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

The value to find a value close to.

Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

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
IgbAxis.GetItemValue(Object, String)

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
IgbAxis.GetItemValueAsync(Object, String)

NotifyDataChanged()

Declaration
public void NotifyDataChanged()

NotifyDataChangedAsync()

Updates the axis when the data has been changed.

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

Implements

JsonSerializable
System.IDisposable