Represents the base class from which all axis types are derived.

Inheritance

object

Classes that extend this class.

Derived Classes
Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable
  • IDisposable

constructor

public IgbAxis()

Returns IgbAxis

Inherited from: BaseRendererElement

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

Inherited from: BaseRendererElement

public bool IsComponentRooted { get; }

Inherited from: BaseRendererElement

protected virtual bool UseDirectRender { get; }

Inherited from: BaseRendererElement

[Parameter]
public RenderFragment ChildContent { get; set; }

Inherited from: BaseRendererElement

protected virtual bool SupportsVisualChildren { get; }

Inherited from: BaseRendererElement

[Parameter]
public string Name { get; set; }

Inherited from: BaseRendererElement

public object Parent { get; }

Inherited from: BaseRendererElement

protected virtual string MethodTarget { get; }

Inherited from: BaseRendererElement

protected object CurrParent { get; }
public IgbAxisAnnotationCollection ActualAnnotations { get; }
public IgbFormatSpecifierCollection ActualLabelFormatSpecifiers { get; }

Gets or sets the ActualMajorStroke property.

[Parameter]
public string ActualMajorStroke { get; set; }

Gets or sets the ActualMinorStroke property.

[Parameter]
public string ActualMinorStroke { get; set; }

Gets or sets the effective stroke used for the axis.

[Parameter]
public string ActualStroke { get; set; }

Gets the current annotations for the axis.

public IgbAxisAnnotationCollection Annotations { get; protected set; }

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.

[Parameter]
public object CoercionMethods { get; set; }

Provides a means of setting CoercionMethods in the JavaScript environment.

[Parameter]
public string CoercionMethodsScript { get; set; }

Gets or sets crossing axis for the companion axis.

[Parameter]
public IgbAxis CompanionAxisCrossingAxis { get; set; }

Gets or sets the name to use to resolve companionAxisCrossingAxis from markup.

[Parameter]
public string CompanionAxisCrossingAxisName { get; set; }

Provides a means of setting CompanionAxisCrossingAxis in the JavaScript environment.

[Parameter]
public string CompanionAxisCrossingAxisScript { get; set; }

Gets or sets crossing value for the companion axis.

[Parameter]
public double CompanionAxisCrossingValue { get; set; }

Gets or sets whether or not the companion axis is enabled for this axis.

[Parameter]
public bool CompanionAxisEnabled { get; set; }

Gets or sets whether or not the companion axis is inverted.

[Parameter]
public FeatureState CompanionAxisIsInverted { get; set; }

Gets or sets label angle on the companion axis.

[Parameter]
public double CompanionAxisLabelAngle { get; set; }

Gets or sets color of labels on the companion axis.

[Parameter]
public string CompanionAxisLabelColor { get; set; }

Gets or sets extent of labels on the companion axis.

[Parameter]
public double CompanionAxisLabelExtent { get; set; }

CompanionAxisLabelHorizontalAlignment

Section titled "CompanionAxisLabelHorizontalAlignment"

Gets or sets horizontal alignment of labels on the companion axis.

[Parameter]
public HorizontalAlignment CompanionAxisLabelHorizontalAlignment { get; set; }

Gets or sets location of labels on the companion axis.

[Parameter]
public AxisLabelsLocation CompanionAxisLabelLocation { get; set; }

Gets or sets whether or not the companion axis has opposite location of this axis.

[Parameter]
public bool CompanionAxisLabelOpposite { get; set; }

CompanionAxisLabelVerticalAlignment

Section titled "CompanionAxisLabelVerticalAlignment"

Gets or sets vertical alignment of the companion axis.

[Parameter]
public VerticalAlignment CompanionAxisLabelVerticalAlignment { get; set; }

Gets or sets whether or not the companion axis has visible labels.

[Parameter]
public FeatureState CompanionAxisLabelVisible { get; set; }

Gets or sets stroke of major gridlines on the companion axis.

[Parameter]
public string CompanionAxisMajorStroke { get; set; }

Gets or sets thickness of major gridlines on the companion axis.

[Parameter]
public double CompanionAxisMajorStrokeThickness { get; set; }

Gets or sets label angle on the companion axis.

[Parameter]
public double CompanionAxisMinExtent { get; set; }

Gets or sets stroke of minior gridlines on the companion axis.

[Parameter]
public string CompanionAxisMinorStroke { get; set; }

Gets or sets thickness of minior gridlines on the companion axis.

[Parameter]
public double CompanionAxisMinorStrokeThickness { get; set; }

CompanionAxisShouldAutoTruncateAnnotations

Section titled "CompanionAxisShouldAutoTruncateAnnotations"

Gets or sets whether or not the companion axis should auto truncate annotations.

[Parameter]
public FeatureState CompanionAxisShouldAutoTruncateAnnotations { get; set; }

CompanionAxisShouldAvoidAnnotationCollisions

Section titled "CompanionAxisShouldAvoidAnnotationCollisions"

Gets or sets whether or not the companion axis should avoid annotation collisions.

[Parameter]
public FeatureState CompanionAxisShouldAvoidAnnotationCollisions { get; set; }

CompanionAxisShouldKeepAnnotationsInView

Section titled "CompanionAxisShouldKeepAnnotationsInView"

Gets or sets whether or not the companion axis should keep annotations in view.

[Parameter]
public FeatureState CompanionAxisShouldKeepAnnotationsInView { get; set; }

Gets or sets color of strips on the companion axis.

[Parameter]
public string CompanionAxisStrip { get; set; }

Gets or sets color of line stroke on the companion axis.

[Parameter]
public string CompanionAxisStroke { get; set; }

Gets or sets label angle on the companion axis.

[Parameter]
public double CompanionAxisStrokeThickness { get; set; }

CompanionAxisSyncronizedWithPrimaryAxis

Section titled "CompanionAxisSyncronizedWithPrimaryAxis"

Gets or sets whether or not the companion axis is syncronized with properties of primary axis unless CompanionAxis* properties are set

[Parameter]
public bool CompanionAxisSyncronizedWithPrimaryAxis { get; set; }

Gets or sets length of ticks on the companion axis.

[Parameter]
public double CompanionAxisTickLength { get; set; }

Gets or sets color of ticks on the companion axis.

[Parameter]
public string CompanionAxisTickStroke { get; set; }

Gets or sets label angle on the companion axis.

[Parameter]
public double CompanionAxisTickStrokeThickness { get; set; }

Gets or sets title on the companion axis.

[Parameter]
public string CompanionAxisTitle { get; set; }
public IgbAxisAnnotationCollection ContentAnnotations { get; }
public IgbFormatSpecifierCollection ContentLabelFormatSpecifiers { get; }

Gets or sets the CrossingAxis property.

[Parameter]
public IgbAxis CrossingAxis { get; set; }

Gets or sets the name to use to resolve crossingAxis from markup.

[Parameter]
public string CrossingAxisName { get; set; }

Provides a means of setting CrossingAxis in the JavaScript environment.

[Parameter]
public string CrossingAxisScript { get; set; }

Gets or sets the CrossingValue property.

[Parameter]
public object CrossingValue { get; set; }

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.

[Parameter]
public int EnhancedIntervalMinimumCharacters { get; set; }

EnhancedIntervalPreferMoreCategoryLabels

Section titled "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.

[Parameter]
public bool EnhancedIntervalPreferMoreCategoryLabels { get; set; }

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.

[Parameter]
public virtual bool ExpectFunctions { get; set; }

Provides a means of setting FormatLabel in the JavaScript environment.

[Parameter]
public string FormatLabelScript { get; set; }

Gets whether this is companion axis automatically created for a primary axis

[Parameter]
public bool IsCompanionAxis { get; set; }

Gets or sets the IsDisabled property. If true, the axis will not be rendered.

[Parameter]
public bool IsDisabled { get; set; }

Gets or sets the IsInverted property.

[Parameter]
public bool IsInverted { get; set; }
[Parameter]
public string Label { get; set; }

Gets or sets the angle of the {0}.

[Parameter]
public double LabelAngle { get; set; }

Margin applied below the {0}.

[Parameter]
public double LabelBottomMargin { get; set; }

Distance between the axis and the edge of the control.

[Parameter]
public double LabelExtent { get; set; }
[Parameter]
public string LabelFontFamily { get; set; }
[Parameter]
public double LabelFontSize { get; set; }
[Parameter]
public string LabelFontStyle { get; set; }
[Parameter]
public string LabelFontWeight { get; set; }

Gets or sets the label format string to use for the label.

[Parameter]
public string LabelFormat { get; set; }

Gets or sets the format specifiers to use with the LabelFormat string.

public IgbFormatSpecifierCollection LabelFormatSpecifiers { get; set; }

Gets or sets the horizontal alignment of the {0}.

[Parameter]
public HorizontalAlignment LabelHorizontalAlignment { get; set; }

Margin applied to the left of the {0}.

[Parameter]
public double LabelLeftMargin { get; set; }

Gets or sets the location of the {0}.

[Parameter]
public AxisLabelsLocation LabelLocation { get; set; }

Maximum distance between the axis and the edge of the control.

[Parameter]
public double LabelMaximumExtent { get; set; }

Maximum distance between the axis and the edge of the control, relative to Chart size.

[Parameter]
public double LabelMaximumExtentPercentage { get; set; }

Margin applied to the right of the {0}.

[Parameter]
public double LabelRightMargin { get; set; }

Gets or sets whether the first label is displayed when the zoom level is set to 1.

[Parameter]
public bool LabelShowFirstLabel { get; set; }

The color of the {0}.

[Parameter]
public string LabelTextColor { get; set; }

Margin applied above the {0}.

[Parameter]
public double LabelTopMargin { get; set; }

Gets or sets the vertical alignment of the {0}.

[Parameter]
public VerticalAlignment LabelVerticalAlignment { get; set; }

Gets or sets the visibility of the {0}.

[Parameter]
public Visibility LabelVisibility { get; set; }

Gets or sets the MajorStroke property.

[Parameter]
public string MajorStroke { get; set; }

Gets or sets the MajorStrokeDashArray property.

[Parameter]
public double[] MajorStrokeDashArray { get; set; }

Gets or sets the MajorStrokeThickness property.

[Parameter]
public double MajorStrokeThickness { get; set; }

Gets or sets the MinorStroke property.

[Parameter]
public string MinorStroke { get; set; }

Gets or sets the MinorStrokeDashArray property.

[Parameter]
public double[] MinorStrokeDashArray { get; set; }

Gets or sets the MinorStrokeThickness property.

[Parameter]
public double MinorStrokeThickness { get; set; }
protected override string ParentTypeName { get; }
[CascadingParameter(Name = "SeriesViewerParent")]
protected BaseRendererControl SeriesViewerParent { get; set; }

Gets or sets whether annotations on this axis will automatically truncate themselves to avoid colliding with each other. This only works if the ShouldAvoidAnnotationCollisions property is enabled.

[Parameter]
public bool ShouldAutoTruncateAnnotations { get; set; }

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.

[Parameter]
public bool ShouldAvoidAnnotationCollisions { get; set; }

ets or sets whether annotations should be kept in view, even if they aren't positioned where they should appear on the scale.

[Parameter]
public bool ShouldKeepAnnotationsInView { get; set; }

Gets or sets the Strip property.

[Parameter]
public string Strip { get; set; }

Gets or sets the Stroke property.

[Parameter]
public string Stroke { get; set; }

Gets or sets the StrokeDashArray property.

[Parameter]
public double[] StrokeDashArray { get; set; }

Gets or sets the StrokeThickness property.

[Parameter]
public double StrokeThickness { get; set; }

Gets or sets the TickLength property.

[Parameter]
public double TickLength { get; set; }

Gets or sets the TickStroke property.

[Parameter]
public string TickStroke { get; set; }

Gets or sets the TickStrokeDashArray property.

[Parameter]
public double[] TickStrokeDashArray { get; set; }

Gets or sets the TickStrokeThickness property.

[Parameter]
public double TickStrokeThickness { get; set; }

Gets or sets the Title property.

[Parameter]
public string Title { get; set; }

Gets or sets the angle of the {0}.

[Parameter]
public double TitleAngle { get; set; }

Margin applied below the {0}.

[Parameter]
public double TitleBottomMargin { get; set; }

Distance between the axis and the edge of the control.

[Parameter]
public double TitleExtent { get; set; }
[Parameter]
public string TitleFontFamily { get; set; }
[Parameter]
public double TitleFontSize { get; set; }
[Parameter]
public string TitleFontStyle { get; set; }
[Parameter]
public string TitleFontWeight { get; set; }

Gets or sets the horizontal alignment of the {0}.

[Parameter]
public HorizontalAlignment TitleHorizontalAlignment { get; set; }

Margin applied to the left of the {0}.

[Parameter]
public double TitleLeftMargin { get; set; }

Gets or sets the location of the {0}.

[Parameter]
public AxisLabelsLocation TitleLocation { get; set; }

Maximum distance between the axis and the edge of the control.

[Parameter]
public double TitleMaximumExtent { get; set; }

Maximum distance between the axis and the edge of the control, relative to Chart size.

[Parameter]
public double TitleMaximumExtentPercentage { get; set; }

Gets or sets the title position relative to the axis labels.

[Parameter]
public AxisTitlePosition TitlePosition { get; set; }

Margin applied to the right of the {0}.

[Parameter]
public double TitleRightMargin { get; set; }

Gets or sets whether the first label is displayed when the zoom level is set to 1.

[Parameter]
public bool TitleShowFirstLabel { get; set; }

The color of the {0}.

[Parameter]
public string TitleTextColor { get; set; }

Margin applied above the {0}.

[Parameter]
public double TitleTopMargin { get; set; }

Gets or sets the vertical alignment of the {0}.

[Parameter]
public VerticalAlignment TitleVerticalAlignment { get; set; }

Gets or sets the visibility of the {0}.

[Parameter]
public Visibility TitleVisibility { get; set; }
public override string Type { get; }

Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc.

[Parameter]
public bool UseEnhancedIntervalManagement { get; set; }

Gets or sets whether to use label height measurement when determining the initial number of labels to render, before resolving collisions, etc.

[Parameter]
public bool UsePerLabelHeightMeasurement { get; set; }

Inherited from: BaseRendererElement

protected string _name

Inherited from: BaseRendererElement

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

Inherited from: BaseRendererElement

protected string _cachedSerializedContent

Inherited from: BaseRendererElement

protected virtual void EnsureModulesLoaded()

Returns any

Inherited from: BaseRendererElement

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Section titled "OnElementNameChanged(BaseRendererElement, string, string)"

Inherited from: BaseRendererElement

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

  • element: BaseRendererElement
  • oldName: string
  • newName: string

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Section titled "InvokeMethod(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodSync(string, object[], string[], ElementReference[])

Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodHelper(string, string, object[], string[], ElementReference[])

Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

  • target: string
  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])

Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

  • target: string
  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

Inherited from: BaseRendererElement

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererElement

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Inherited from: BaseRendererElement

public string Serialize()

Returns any

Inherited from: BaseRendererElement

protected void EnsureValid()

Returns any

FromEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"

Inherited from: BaseRendererElement

protected virtual void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

ToEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"

Inherited from: BaseRendererElement

protected virtual void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

SetResourceStringAsync(string, string, string)

Section titled "SetResourceStringAsync(string, string, string)"

Inherited from: BaseRendererElement

protected Task<object> SetResourceStringAsync(string grouping, string id, string value)

Parameters

  • grouping: string
  • id: string
  • value: string

Returns any

SetResourceStringAsync(string, string)

Section titled "SetResourceStringAsync(string, string)"

Inherited from: BaseRendererElement

protected Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

  • grouping: string
  • json: string

Returns any

protected virtual void BindAxes(IgbAxis[] Axes)

Parameters

  • Axes: IgbAxis[]

Returns any

public void Dispose()

Returns any

public override object FindByName(string name)

Parameters

  • name: string

Returns any

public virtual double[] GetFullRange()

Returns any

public virtual Task<double[]> GetFullRangeAsync()

Returns any

public virtual object GetItemValue(object item, string memberPathName)

Parameters

  • item: object
  • memberPathName: string

Returns any

public virtual Task<object> GetItemValueAsync(object item, string memberPathName)

Parameters

  • item: object
  • memberPathName: string

Returns any

public virtual string GetMemberPathValue(string memberPathName)

Parameters

  • memberPathName: string

Returns any

Gets the value of a requested member path from the series.

public virtual Task<string> GetMemberPathValueAsync(string memberPathName)

Parameters

  • memberPathName: string

Returns any

public virtual string GetValueLabel(double value)

Parameters

  • value: double

Returns any

Gets the label for a data item.

public virtual Task<string> GetValueLabelAsync(double value)

Parameters

  • value: double

Returns any

protected override Task OnInitializedAsync()

Returns any

public void RenderAxis()

Returns any

Renders the axis with no animation.

public Task RenderAxisAsync()

Returns any

public void ResetCachedEnhancedInterval()

Returns any

If using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels.

public Task ResetCachedEnhancedIntervalAsync()

Returns any

public virtual double ScaleValue(double unscaledValue)

Parameters

  • unscaledValue: double

Returns any

Scales a value from axis space into screen space.

public virtual Task<double> ScaleValueAsync(double unscaledValue)

Parameters

  • unscaledValue: double

Returns any

[Parameter]
public EventCallback<IgbAxisRangeChangedEventArgs> RangeChanged { get; set; }
[Parameter]
public EventCallback<IgbRenderRequestedEventArgs> RenderRequested { get; set; }
[Parameter]
public string RangeChangedScript { get; set; }
[Parameter]
public string RenderRequestedScript { get; set; }