Class IgbTimeAxisLabelFormat

Settings for a label format on a time axis.

Inheritance
System.Object
BaseRendererElement
IgbTimeAxisLabelFormat
Implements
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbTimeAxisLabelFormat : BaseRendererElement, JsonSerializable
Remarks

Label formats can be applied to a time axis, which are dynamic, according to the visible range. During zooming, the visible range of the axis can change, and so a different label format is selected. The label format selected will be the one with the largest range smaller than the visible range of the axis.

Constructors

IgbTimeAxisLabelFormat()

Declaration
public IgbTimeAxisLabelFormat()

Properties

Format

The DateTime format string to apply.

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

Some common DateTime format strings are: yyyy, MM/dd/yy, and hh:mm:ss.

LabelFormatOverride

Declaration
public EventCallback<IgbLabelFormatOverrideEventArgs> LabelFormatOverride { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbLabelFormatOverrideEventArgs>

LabelFormatOverrideScript

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

Range

The visible axis range at which to apply this label format.

Declaration
public TimeSpan Range { get; set; }
Property Value
Type Description
System.TimeSpan

RepeatedDayFormat

The DateTime format string to apply, if the day is repeated from the prior date.

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

Some common DateTime format strings are: yyyy, MM/dd/yy, and hh:mm:ss.

RepeatedMonthFormat

The DateTime format string to apply, if the month is repeated from the prior date.

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

Some common DateTime format strings are: yyyy, MM/dd/yy, and hh:mm:ss.

RepeatedYearFormat

The DateTime format string to apply, if the year is repeated from the prior date.

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

Some common DateTime format strings are: yyyy, MM/dd/yy, and hh:mm:ss.

Type

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

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

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

Implements