Show / Hide Table of Contents

Class IgbAxisAnnotation

Represents an axis annotation

Inheritance
System.Object
BaseRendererElement
IgbAxisAnnotation
Implements
JsonSerializable
System.IDisposable
Inherited Members
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 IgbAxisAnnotation : BaseRendererElement, JsonSerializable, IDisposable

Constructors

IgbAxisAnnotation()

Declaration
public IgbAxisAnnotation()

Properties

ActualLabelFormatSpecifiers

Declaration
public IgbFormatSpecifierCollection ActualLabelFormatSpecifiers { get; }
Property Value
Type Description
IgbFormatSpecifierCollection

AxisParent

Declaration
protected BaseRendererElement AxisParent { get; set; }
Property Value
Type Description
BaseRendererElement

Background

Gets or sets the background to use for tha axis annotation box.

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

BackgroundCornerRadius

Gets or sets the corner radius to use for the axis annotation borders.

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

BackgroundPaddingBottom

Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

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

BackgroundPaddingLeft

Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

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

BackgroundPaddingRight

Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

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

BackgroundPaddingTop

Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins.

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

BadgeBackground

Gets or sets the background color to use for the badge inside the axis annotation box.

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

BadgeCornerRadius

Gets or sets the corner radius for the badge inside the axis annotation box.

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

BadgeImagePath

Gets or sets the image path to use for the badge.

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

BadgeMargin

Gets or sets the spacing between the badge and text inside the axis annotation box.

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

BadgeOutline

Gets or sets the outline color to use for the badge inside the axis annotation box.

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

BadgeOutlineThickness

Gets or sets the outline thickness for the badge inside the axis annotation box.

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

BadgeSize

Gets or sets the size of the badge inside the axis annotation box.

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

ContentLabelFormatSpecifiers

Declaration
public IgbFormatSpecifierCollection ContentLabelFormatSpecifiers { get; }
Property Value
Type Description
IgbFormatSpecifierCollection

FormatLabelScript

Provides a means of setting FormatLabel in the JavaScript environment.

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

IsBadgeEnabled

Gets or sets whether the badge is enabled in the annotation.

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

IsPillShaped

Gets or sets whether the annotation is pill shaped. This will automatically adjust the background corner radius to make it appear pill shaped.

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

LabelFormat

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

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

LabelFormatSpecifiers

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

Declaration
public IgbFormatSpecifierCollection LabelFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

Outline

Gets or sets the Outline to use for tha axis annotation box.

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

ParentTypeName

Declaration
protected override string ParentTypeName { get; }
Property Value
Type Description
System.String
Overrides
BaseRendererElement.ParentTypeName

StrokeThickness

Gets or sets the border stroke thickness to use for tha axis annotation box.

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

Text

Gets or sets the text that should be displayed for the annotation. Leave null to display the value automatically.

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

TextColor

Gets or sets the color to use for the text in the annotation.

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

Type

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

Value

Gets or sets the value at which this annotation is displayed on the axis.

Declaration
public object Value { get; set; }
Property Value
Type Description
System.Object

Methods

Dispose()

Declaration
public void Dispose()

FindByName(String)

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

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

ResetCachedExtent()

Declaration
public void ResetCachedExtent()

ResetCachedExtentAsync()

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

ResolveLabelValue()

Declaration
public string ResolveLabelValue()
Returns
Type Description
System.String

ResolveLabelValueAsync()

Declaration
public Task<string> ResolveLabelValueAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

Implements

JsonSerializable
System.IDisposable