Class IgbAxis
Represents the base class from which all axis types are derived.
Inheritance
System.Object
IgbAxis
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbAxis : BaseRendererElement, JsonSerializable
Constructors
IgbAxis()
Declaration
Properties
ActualAnnotations
Declaration
public IgbAxisAnnotationCollection ActualAnnotations { get; }
Property Value
Declaration
public IgbFormatSpecifierCollection ActualLabelFormatSpecifiers { get; }
Property Value
ActualMajorStroke
Gets or sets the ActualMajorStroke property.
Declaration
public string ActualMajorStroke { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualMinorStroke
Gets or sets the ActualMinorStroke property.
Declaration
public string ActualMinorStroke { get; set; }
Property Value
Type |
Description |
System.String |
|
ActualStroke
Gets or sets the effective stroke used for the axis.
Declaration
public string ActualStroke { get; set; }
Property Value
Type |
Description |
System.String |
|
Annotations
Gets the current annotations for the axis.
Declaration
public IgbAxisAnnotationCollection Annotations { get; protected set; }
Property Value
CoercionMethods
Gets or sets the coercion methods to use when loading data from data sources.
Should be specified before setting any member paths, if being used. Setting it later
will not cause data to be re-imported into the chart.
Declaration
public object CoercionMethods { get; set; }
Property Value
Type |
Description |
System.Object |
|
CoercionMethodsScript
Provides a means of setting CoercionMethods in the JavaScript environment.
Declaration
public string CoercionMethodsScript { get; set; }
Property Value
Type |
Description |
System.String |
|
ContentAnnotations
Declaration
public IgbAxisAnnotationCollection ContentAnnotations { get; }
Property Value
ContentLabelFormatSpecifiers
Declaration
public IgbFormatSpecifierCollection ContentLabelFormatSpecifiers { get; }
Property Value
CrossingAxis
Gets or sets the CrossingAxis property.
Declaration
public IgbAxis CrossingAxis { get; set; }
Property Value
CrossingAxisName
Gets or sets the name to use to resolve crossingAxis from markup.
Declaration
public string CrossingAxisName { get; set; }
Property Value
Type |
Description |
System.String |
|
CrossingAxisScript
Provides a means of setting CrossingAxis in the JavaScript environment.
Declaration
public string CrossingAxisScript { get; set; }
Property Value
Type |
Description |
System.String |
|
CrossingValue
Gets or sets the CrossingValue property.
Declaration
public object CrossingValue { get; set; }
Property Value
Type |
Description |
System.Object |
|
EnhancedIntervalMinimumCharacters
Gets or sets the minimum desired characters to be displayed for horizontal axes when using advanced label heuristics. -1 will attempt to adjust the interval to precisely fit the horizontal labels.
Declaration
public int EnhancedIntervalMinimumCharacters { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
EnhancedIntervalPreferMoreCategoryLabels
Gets or sets whether the enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval.
Declaration
public bool EnhancedIntervalPreferMoreCategoryLabels { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ExpectFunctions
Gets or sets whether the series should expect that properties in its items source may be functions that need to be
evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature.
This value must be set before assigning an item's source to take effect.
Declaration
public virtual bool ExpectFunctions { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsDisabled
Gets or sets the IsDisabled property. If true, the axis will not be rendered.
Declaration
public bool IsDisabled { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsInverted
Gets or sets the IsInverted property.
Declaration
public bool IsInverted { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Label
Declaration
public string Label { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelAngle
Gets or sets the angle of the {0}.
Declaration
public double LabelAngle { get; set; }
Property Value
Type |
Description |
System.Double |
|
LabelBottomMargin
Margin applied below the {0}.
Declaration
public double LabelBottomMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
LabelExtent
Distance between the axis and the edge of the control.
Declaration
public double LabelExtent { get; set; }
Property Value
Type |
Description |
System.Double |
|
LabelFontFamily
Declaration
public string LabelFontFamily { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelFontSize
Declaration
public double LabelFontSize { get; set; }
Property Value
Type |
Description |
System.Double |
|
LabelFontStyle
Declaration
public string LabelFontStyle { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelFontWeight
Declaration
public string LabelFontWeight { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the label format string to use for the label.
Declaration
public string LabelFormat { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the format specifiers to use with the LabelFormat string.
Declaration
public IgbFormatSpecifierCollection LabelFormatSpecifiers { get; set; }
Property Value
LabelHorizontalAlignment
Gets or sets the horizontal alignment of the {0}.
Declaration
public HorizontalAlignment LabelHorizontalAlignment { get; set; }
Property Value
LabelLeftMargin
Margin applied to the left of the {0}.
Declaration
public double LabelLeftMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
LabelLocation
Gets or sets the location of the {0}.
Declaration
public AxisLabelsLocation LabelLocation { get; set; }
Property Value
LabelRightMargin
Margin applied to the right of the {0}.
Declaration
public double LabelRightMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
LabelShowFirstLabel
Gets or sets whether the first label is displayed when the zoom level is set to 1.
Declaration
public bool LabelShowFirstLabel { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
LabelTextColor
Declaration
public string LabelTextColor { get; set; }
Property Value
Type |
Description |
System.String |
|
LabelTopMargin
Margin applied above the {0}.
Declaration
public double LabelTopMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
LabelVerticalAlignment
Gets or sets the vertical alignment of the {0}.
Declaration
public VerticalAlignment LabelVerticalAlignment { get; set; }
Property Value
LabelVisibility
Gets or sets the visibility of the {0}.
Declaration
public Visibility LabelVisibility { get; set; }
Property Value
MajorStroke
Gets or sets the MajorStroke property.
Declaration
public string MajorStroke { get; set; }
Property Value
Type |
Description |
System.String |
|
MajorStrokeDashArray
Declaration
public double[] MajorStrokeDashArray { get; set; }
Property Value
Type |
Description |
System.Double[] |
|
MajorStrokeThickness
Gets or sets the MajorStrokeThickness property.
Declaration
public double MajorStrokeThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
MinorStroke
Gets or sets the MinorStroke property.
Declaration
public string MinorStroke { get; set; }
Property Value
Type |
Description |
System.String |
|
MinorStrokeDashArray
Declaration
public double[] MinorStrokeDashArray { get; set; }
Property Value
Type |
Description |
System.Double[] |
|
MinorStrokeThickness
Gets or sets the MinorStrokeThickness property.
Declaration
public double MinorStrokeThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
ParentTypeName
Declaration
protected override string ParentTypeName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
RangeChanged
Declaration
public EventCallback<IgbAxisRangeChangedEventArgs> RangeChanged { get; set; }
Property Value
RangeChangedScript
Declaration
public string RangeChangedScript { get; set; }
Property Value
Type |
Description |
System.String |
|
RenderRequested
Declaration
public EventCallback<IgbRenderRequestedEventArgs> RenderRequested { get; set; }
Property Value
RenderRequestedScript
Declaration
public string RenderRequestedScript { get; set; }
Property Value
Type |
Description |
System.String |
|
SeriesViewerParent
Declaration
protected BaseRendererControl SeriesViewerParent { get; set; }
Property Value
ShouldAvoidAnnotationCollisions
Gets or sets whether annotations should be shifted to avoid collision, even if this would result in them appearing where they shouldn't be along the scale.
Declaration
public bool ShouldAvoidAnnotationCollisions { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ShouldKeepAnnotationsInView
ets or sets whether annotations should be kept in view, even if they aren't positioned where they should appear on the scale.
Declaration
public bool ShouldKeepAnnotationsInView { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Strip
Gets or sets the Strip property.
Declaration
public string Strip { get; set; }
Property Value
Type |
Description |
System.String |
|
Stroke
Gets or sets the Stroke property.
Declaration
public string Stroke { get; set; }
Property Value
Type |
Description |
System.String |
|
StrokeDashArray
Declaration
public double[] StrokeDashArray { get; set; }
Property Value
Type |
Description |
System.Double[] |
|
StrokeThickness
Gets or sets the StrokeThickness property.
Declaration
public double StrokeThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
TickLength
Gets or sets the TickLength property.
Declaration
public double TickLength { get; set; }
Property Value
Type |
Description |
System.Double |
|
TickStroke
Gets or sets the TickStroke property.
Declaration
public string TickStroke { get; set; }
Property Value
Type |
Description |
System.String |
|
TickStrokeDashArray
Declaration
public double[] TickStrokeDashArray { get; set; }
Property Value
Type |
Description |
System.Double[] |
|
TickStrokeThickness
Gets or sets the TickStrokeThickness property.
Declaration
public double TickStrokeThickness { get; set; }
Property Value
Type |
Description |
System.Double |
|
Title
Gets or sets the Title property.
Declaration
public string Title { get; set; }
Property Value
Type |
Description |
System.String |
|
TitleAngle
Gets or sets the angle of the {0}.
Declaration
public double TitleAngle { get; set; }
Property Value
Type |
Description |
System.Double |
|
TitleBottomMargin
Margin applied below the {0}.
Declaration
public double TitleBottomMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
TitleExtent
Distance between the axis and the edge of the control.
Declaration
public double TitleExtent { get; set; }
Property Value
Type |
Description |
System.Double |
|
TitleFontFamily
Declaration
public string TitleFontFamily { get; set; }
Property Value
Type |
Description |
System.String |
|
TitleFontSize
Declaration
public double TitleFontSize { get; set; }
Property Value
Type |
Description |
System.Double |
|
TitleFontStyle
Declaration
public string TitleFontStyle { get; set; }
Property Value
Type |
Description |
System.String |
|
TitleFontWeight
Declaration
public string TitleFontWeight { get; set; }
Property Value
Type |
Description |
System.String |
|
TitleHorizontalAlignment
Gets or sets the horizontal alignment of the {0}.
Declaration
public HorizontalAlignment TitleHorizontalAlignment { get; set; }
Property Value
TitleLeftMargin
Margin applied to the left of the {0}.
Declaration
public double TitleLeftMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
TitleLocation
Gets or sets the location of the {0}.
Declaration
public AxisLabelsLocation TitleLocation { get; set; }
Property Value
TitlePosition
Gets or sets the title position relative to the axis labels.
Declaration
public AxisTitlePosition TitlePosition { get; set; }
Property Value
TitleRightMargin
Margin applied to the right of the {0}.
Declaration
public double TitleRightMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
TitleShowFirstLabel
Gets or sets whether the first label is displayed when the zoom level is set to 1.
Declaration
public bool TitleShowFirstLabel { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
TitleTextColor
Declaration
public string TitleTextColor { get; set; }
Property Value
Type |
Description |
System.String |
|
TitleTopMargin
Margin applied above the {0}.
Declaration
public double TitleTopMargin { get; set; }
Property Value
Type |
Description |
System.Double |
|
TitleVerticalAlignment
Gets or sets the vertical alignment of the {0}.
Declaration
public VerticalAlignment TitleVerticalAlignment { get; set; }
Property Value
TitleVisibility
Gets or sets the visibility of the {0}.
Declaration
public Visibility TitleVisibility { get; set; }
Property Value
Type
Declaration
public override string Type { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
UseEnhancedIntervalManagement
Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.
Declaration
public bool UseEnhancedIntervalManagement { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
UsePerLabelHeightMeasurement
Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.
Declaration
public bool UsePerLabelHeightMeasurement { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Methods
BindAxes(IgbAxis[])
Declaration
protected virtual void BindAxes(IgbAxis[] Axes)
Parameters
Type |
Name |
Description |
IgbAxis[] |
Axes |
|
Dispose()
Declaration
FindByName(String)
Declaration
public override object FindByName(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
Type |
Description |
System.Object |
|
Overrides
GetItemValue(Object, String)
Declaration
public virtual object GetItemValue(object item, string memberPathName)
Parameters
Type |
Name |
Description |
System.Object |
item |
|
System.String |
memberPathName |
|
Returns
Type |
Description |
System.Object |
|
GetItemValueAsync(Object, String)
Declaration
public virtual 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> |
|
GetValueLabel(Double)
Declaration
public virtual string GetValueLabel(double value)
Parameters
Type |
Name |
Description |
System.Double |
value |
|
Returns
Type |
Description |
System.String |
|
GetValueLabelAsync(Double)
Gets the label for a data item.
Declaration
public virtual Task<string> GetValueLabelAsync(double value)
Parameters
Type |
Name |
Description |
System.Double |
value |
The unscaled value to get a label for.
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.String> |
|
OnInitializedAsync()
Declaration
protected override Task OnInitializedAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
RenderAxis()
Declaration
RenderAxisAsync()
Renders the axis with no animation.
Declaration
public Task RenderAxisAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
ResetCachedEnhancedInterval()
Declaration
public void ResetCachedEnhancedInterval()
ResetCachedEnhancedIntervalAsync()
If using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels.
Declaration
public Task ResetCachedEnhancedIntervalAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
ScaleValue(Double)
Declaration
public virtual double ScaleValue(double unscaledValue)
Parameters
Type |
Name |
Description |
System.Double |
unscaledValue |
|
Returns
Type |
Description |
System.Double |
|
ScaleValueAsync(Double)
Scales a value from axis space into screen space.
Declaration
public virtual Task<double> ScaleValueAsync(double unscaledValue)
Parameters
Type |
Name |
Description |
System.Double |
unscaledValue |
The unscaled axis value to scale.
|
Returns
Type |
Description |
System.Threading.Tasks.Task<System.Double> |
|
Implements
System.IDisposable