Represents an axis annotation
Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbAxisAnnotation() Returns IgbAxisAnnotation
Properties
Section titled "Properties"IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererElement
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; } IsComponentRooted
Section titled "IsComponentRooted"Inherited from: BaseRendererElement
public bool IsComponentRooted { get; } UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererElement
protected virtual bool UseDirectRender { get; } ChildContent
Section titled "ChildContent"Inherited from: BaseRendererElement
[Parameter]
public RenderFragment ChildContent { get; set; } SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererElement
protected virtual bool SupportsVisualChildren { get; } Inherited from: BaseRendererElement
[Parameter]
public string Name { get; set; } Parent
Section titled "Parent"Inherited from: BaseRendererElement
public object Parent { get; } MethodTarget
Section titled "MethodTarget"Inherited from: BaseRendererElement
protected virtual string MethodTarget { get; } CurrParent
Section titled "CurrParent"Inherited from: BaseRendererElement
protected object CurrParent { get; } ActualLabelFormatSpecifiers
Section titled "ActualLabelFormatSpecifiers"public IgbFormatSpecifierCollection ActualLabelFormatSpecifiers { get; } AxisParent
Section titled "AxisParent"[CascadingParameter(Name = "AxisParent")]
protected BaseRendererElement AxisParent { get; set; } Background
Section titled "Background"Gets or sets the background to use for tha axis annotation box.
[Parameter]
public string Background { get; set; } BackgroundCornerRadius
Section titled "BackgroundCornerRadius"Gets or sets the corner radius to use for the axis annotation borders.
[Parameter]
public double BackgroundCornerRadius { get; set; } BackgroundPaddingBottom
Section titled "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.
[Parameter]
public double BackgroundPaddingBottom { get; set; } BackgroundPaddingLeft
Section titled "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.
[Parameter]
public double BackgroundPaddingLeft { get; set; } BackgroundPaddingRight
Section titled "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.
[Parameter]
public double BackgroundPaddingRight { get; set; } BackgroundPaddingTop
Section titled "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.
[Parameter]
public double BackgroundPaddingTop { get; set; } BadgeBackground
Section titled "BadgeBackground"Gets or sets the background color to use for the badge inside the axis annotation box.
[Parameter]
public string BadgeBackground { get; set; } BadgeCornerRadius
Section titled "BadgeCornerRadius"Gets or sets the corner radius for the badge inside the axis annotation box.
[Parameter]
public double BadgeCornerRadius { get; set; } BadgeImagePath
Section titled "BadgeImagePath"Gets or sets the image path to use for the badge.
[Parameter]
public string BadgeImagePath { get; set; } BadgeMargin
Section titled "BadgeMargin"Gets or sets the spacing between the badge and text inside the axis annotation box.
[Parameter]
public double BadgeMargin { get; set; } BadgeOutline
Section titled "BadgeOutline"Gets or sets the outline color to use for the badge inside the axis annotation box.
[Parameter]
public string BadgeOutline { get; set; } BadgeOutlineThickness
Section titled "BadgeOutlineThickness"Gets or sets the outline thickness for the badge inside the axis annotation box.
[Parameter]
public double BadgeOutlineThickness { get; set; } BadgeSize
Section titled "BadgeSize"Gets or sets the size of the badge inside the axis annotation box.
[Parameter]
public double BadgeSize { get; set; } ContentLabelFormatSpecifiers
Section titled "ContentLabelFormatSpecifiers"public IgbFormatSpecifierCollection ContentLabelFormatSpecifiers { get; } FormatLabelScript
Section titled "FormatLabelScript"Provides a means of setting FormatLabel in the JavaScript environment.
[Parameter]
public string FormatLabelScript { get; set; } IsBadgeEnabled
Section titled "IsBadgeEnabled"Gets or sets whether the badge is enabled in the annotation.
[Parameter]
public bool IsBadgeEnabled { get; set; } IsPillShaped
Section titled "IsPillShaped"Gets or sets whether the annotation is pill shaped. This will automatically adjust the background corner radius to make it appear pill shaped.
[Parameter]
public bool IsPillShaped { get; set; } LabelFormat
Section titled "LabelFormat"Gets or sets the label format string to use for the label.
[Parameter]
public string LabelFormat { get; set; } LabelFormatSpecifiers
Section titled "LabelFormatSpecifiers"Gets or sets the format specifiers to use with the LabelFormat string.
public IgbFormatSpecifierCollection LabelFormatSpecifiers { get; set; } Outline
Section titled "Outline"Gets or sets the Outline to use for tha axis annotation box.
[Parameter]
public string Outline { get; set; } ParentTypeName
Section titled "ParentTypeName"protected override string ParentTypeName { get; } StrokeThickness
Section titled "StrokeThickness"Gets or sets the border stroke thickness to use for tha axis annotation box.
[Parameter]
public double StrokeThickness { get; set; } Gets or sets the text that should be displayed for the annotation. Leave null to display the value automatically.
[Parameter]
public string Text { get; set; } TextColor
Section titled "TextColor"Gets or sets the color to use for the text in the annotation.
[Parameter]
public string TextColor { get; set; } public override string Type { get; } Value
Section titled "Value"Gets or sets the value at which this annotation is displayed on the axis.
[Parameter]
public object Value { get; set; } Accessors
Section titled "Accessors"_name
Section titled "_name"Inherited from: BaseRendererElement
protected string _name eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererElement
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache _cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererElement
protected string _cachedSerializedContent Methods
Section titled "Methods"EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"Inherited from: BaseRendererElement
protected virtual void EnsureModulesLoaded() Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"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
IsPropDirty(string)
Section titled "IsPropDirty(string)"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
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererElement
public string Serialize() Returns any
EnsureValid()
Section titled "EnsureValid()"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
Dispose()
Section titled "Dispose()"public void Dispose() Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name) Parameters
- name:
string
Returns any
OnInitializedAsync()
Section titled "OnInitializedAsync()"protected override Task OnInitializedAsync() Returns any
ResetCachedExtent()
Section titled "ResetCachedExtent()"public void ResetCachedExtent() Returns any
ResetCachedExtentAsync()
Section titled "ResetCachedExtentAsync()"public Task ResetCachedExtentAsync() Returns any
ResolveLabelValue()
Section titled "ResolveLabelValue()"public string ResolveLabelValue() Returns any
ResolveLabelValueAsync()
Section titled "ResolveLabelValueAsync()"public Task<string> ResolveLabelValueAsync()