Represents an user annotation for rendering data strip annotation
Inheritance
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
Constructors
Section titled "Constructors"constructor
public IgbUserStripAnnotation()Returns IgbUserStripAnnotation
Properties
Section titled "Properties"ValueDisplayMode
Section titled "ValueDisplayMode"Inherited from: IgbUserShapeAnnotation
Gets or sets display mode of label in the center annotation.
[Parameter]
public DataAnnotationDisplayMode ValueDisplayMode { get; set; }ShapeBackground
Section titled "ShapeBackground"Inherited from: IgbUserShapeAnnotation
Gets or sets background of the annotation shape displayed in the plot area of the chart.
[Parameter]
public string ShapeBackground { get; set; }ShapeOutline
Section titled "ShapeOutline"Inherited from: IgbUserShapeAnnotation
Gets or sets border color of the annotation shape displayed in the plot area of the chart.
[Parameter]
public string ShapeOutline { get; set; }ShapeThickness
Section titled "ShapeThickness"Inherited from: IgbUserShapeAnnotation
Gets or sets border thickness of the annotation shape displayed in the plot area of the chart.
[Parameter]
public double ShapeThickness { get; set; }OverlayText
Section titled "OverlayText"Inherited from: IgbUserShapeAnnotation
Gets or sets the text that should be overlayed in plot area of the chart.
[Parameter]
public string OverlayText { get; set; }OverlayTextLocation
Section titled "OverlayTextLocation"Inherited from: IgbUserShapeAnnotation
Gets or sets location of the overlay text in relation to the annotation shape.
[Parameter]
public OverlayTextLocation OverlayTextLocation { get; set; }OverlayTextHorizontalMargin
Section titled "OverlayTextHorizontalMargin"Inherited from: IgbUserShapeAnnotation
Gets or sets the horizontal margin of the overlay text in relation to the annotation shape.
[Parameter]
public double OverlayTextHorizontalMargin { get; set; }OverlayTextVerticalMargin
Section titled "OverlayTextVerticalMargin"Inherited from: IgbUserShapeAnnotation
Gets or sets the vertical margin of the overlay text in relation to the annotation shape.
[Parameter]
public double OverlayTextVerticalMargin { get; set; }OverlayTextHorizontalPadding
Section titled "OverlayTextHorizontalPadding"Inherited from: IgbUserShapeAnnotation
Gets or sets the horizontal padding of the overlay text in relation to the annotation shape.
[Parameter]
public double OverlayTextHorizontalPadding { get; set; }OverlayTextVerticalPadding
Section titled "OverlayTextVerticalPadding"Inherited from: IgbUserShapeAnnotation
Gets or sets the vertical padding of the overlay text in relation to the annotation shape.
[Parameter]
public double OverlayTextVerticalPadding { get; set; }OverlayTextAngle
Section titled "OverlayTextAngle"Inherited from: IgbUserShapeAnnotation
Gets or sets the angle rotation (in degrees) of the overlay text in relation to the annotation shape.
[Parameter]
public double OverlayTextAngle { get; set; }OverlayTextColor
Section titled "OverlayTextColor"Inherited from: IgbUserShapeAnnotation
Gets or sets the color the overlay text.
[Parameter]
public string OverlayTextColor { get; set; }OverlayTextColorShift
Section titled "OverlayTextColorShift"Inherited from: IgbUserShapeAnnotation
Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift.
[Parameter]
public double OverlayTextColorShift { get; set; }OverlayTextColorMode
Section titled "OverlayTextColorMode"Inherited from: IgbUserShapeAnnotation
Gets or sets the mode used for shifting the background of overlay text.
[Parameter]
public AnnotationAppearanceMode OverlayTextColorMode { get; set; }OverlayTextBackground
Section titled "OverlayTextBackground"Inherited from: IgbUserShapeAnnotation
Gets or sets the background the overlay text.
[Parameter]
public string OverlayTextBackground { get; set; }OverlayTextBackgroundShift
Section titled "OverlayTextBackgroundShift"Inherited from: IgbUserShapeAnnotation
Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift.
[Parameter]
public double OverlayTextBackgroundShift { get; set; }OverlayTextBackgroundMode
Section titled "OverlayTextBackgroundMode"Inherited from: IgbUserShapeAnnotation
Gets or sets the mode used for shifting the background of overlay text.
[Parameter]
public AnnotationAppearanceMode OverlayTextBackgroundMode { get; set; }OverlayTextBorderColor
Section titled "OverlayTextBorderColor"Inherited from: IgbUserShapeAnnotation
Gets or sets the border color of the overlay text.
[Parameter]
public string OverlayTextBorderColor { get; set; }OverlayTextBorderRadius
Section titled "OverlayTextBorderRadius"Inherited from: IgbUserShapeAnnotation
Gets or sets the border radius corner of the overlay text.
[Parameter]
public double OverlayTextBorderRadius { get; set; }OverlayTextBorderThickness
Section titled "OverlayTextBorderThickness"Inherited from: IgbUserShapeAnnotation
Gets or sets the border thickness of the overlay text.
[Parameter]
public double OverlayTextBorderThickness { get; set; }OverlayTextBorderShift
Section titled "OverlayTextBorderShift"Inherited from: IgbUserShapeAnnotation
Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift.
[Parameter]
public double OverlayTextBorderShift { get; set; }OverlayTextBorderMode
Section titled "OverlayTextBorderMode"Inherited from: IgbUserShapeAnnotation
Gets or sets the mode used for shifting the border of overlay text.
[Parameter]
public AnnotationAppearanceMode OverlayTextBorderMode { get; set; }OverlayTextVisible
Section titled "OverlayTextVisible"Inherited from: IgbUserShapeAnnotation
Gets or sets whether the overlay text is visible in plot area of the chart
[Parameter]
public bool OverlayTextVisible { get; set; }OverlayTextFontFamily
Section titled "OverlayTextFontFamily"Inherited from: IgbUserShapeAnnotation
[Parameter]
public string OverlayTextFontFamily { get; set; }OverlayTextFontSize
Section titled "OverlayTextFontSize"Inherited from: IgbUserShapeAnnotation
[Parameter]
public double OverlayTextFontSize { get; set; }OverlayTextFontStyle
Section titled "OverlayTextFontStyle"Inherited from: IgbUserShapeAnnotation
[Parameter]
public string OverlayTextFontStyle { get; set; }OverlayTextFontWeight
Section titled "OverlayTextFontWeight"Inherited from: IgbUserShapeAnnotation
[Parameter]
public string OverlayTextFontWeight { get; set; }TargetAxis
Section titled "TargetAxis"Inherited from: IgbUserAxisAnnotation
Gets or sets the target axis that will display the annotation.
[Parameter]
public IgbAxis TargetAxis { get; set; }TargetAxisScript
Section titled "TargetAxisScript"Inherited from: IgbUserAxisAnnotation
Provides a means of setting TargetAxis in the JavaScript environment.
[Parameter]
public string TargetAxisScript { get; set; }TargetAxisName
Section titled "TargetAxisName"Inherited from: IgbUserAxisAnnotation
Gets or sets the name to use to resolve targetAxis from markup.
[Parameter]
public string TargetAxisName { get; set; }TargetAxisMatcher
Section titled "TargetAxisMatcher"Inherited from: IgbUserAxisAnnotation
Gets or sets a matcher for matching an axis that will display the annotation.
[Parameter]
public IgbAxisMatcher TargetAxisMatcher { get; set; }Value
Section titled "Value"Inherited from: IgbUserAxisAnnotation
Gets or sets the value that determines location of annotation on axis.
[Parameter]
public double Value { get; set; }Identifier
Section titled "Identifier"Inherited from: IgbUserBaseAnnotation
[Parameter]
public string Identifier { get; set; }Label
Section titled "Label"Inherited from: IgbUserBaseAnnotation
Gets or sets the text that should be displayed on axis annotation.
[Parameter]
public string Label { get; set; }AnnotationData
Section titled "AnnotationData"Inherited from: IgbUserBaseAnnotation
Gets or sets the additional data that should be stored with the annotation.
[Parameter]
public string AnnotationData { get; set; }IsVisible
Section titled "IsVisible"Inherited from: IgbUserBaseAnnotation
Gets or sets whether to the annotations is rendered
[Parameter]
public bool IsVisible { get; set; }LabelColor
Section titled "LabelColor"Inherited from: IgbUserBaseAnnotation
Gets or sets the color of text displayed in the annotation.
[Parameter]
public string LabelColor { get; set; }LabelBackground
Section titled "LabelBackground"Inherited from: IgbUserBaseAnnotation
Gets or sets the background text displayed in the annotation.
[Parameter]
public string LabelBackground { get; set; }LabelBorderColor
Section titled "LabelBorderColor"Inherited from: IgbUserBaseAnnotation
Gets or sets the border color of the axis annotation.
[Parameter]
public string LabelBorderColor { get; set; }LabelBorderThickness
Section titled "LabelBorderThickness"Inherited from: IgbUserBaseAnnotation
Gets or sets border thickness of the axis annotations.
[Parameter]
public double LabelBorderThickness { get; set; }LabelBorderRadius
Section titled "LabelBorderRadius"Inherited from: IgbUserBaseAnnotation
Gets or sets the border radius of the annotation.
[Parameter]
public double LabelBorderRadius { get; set; }LabelPadding
Section titled "LabelPadding"Inherited from: IgbUserBaseAnnotation
Gets or sets padding around the label in annotation.
[Parameter]
public double LabelPadding { get; set; }BadgeVisible
Section titled "BadgeVisible"Inherited from: IgbUserBaseAnnotation
Gets or sets whether to draw the badge in annotation
[Parameter]
public bool BadgeVisible { get; set; }BadgeBackground
Section titled "BadgeBackground"Inherited from: IgbUserBaseAnnotation
Gets or sets the background of badge annotation.
[Parameter]
public string BadgeBackground { get; set; }BadgeOutline
Section titled "BadgeOutline"Inherited from: IgbUserBaseAnnotation
Gets or sets the outline of badge annotation.
[Parameter]
public string BadgeOutline { get; set; }BadgeThickness
Section titled "BadgeThickness"Inherited from: IgbUserBaseAnnotation
Gets or sets thickness of the badge annotations.
[Parameter]
public double BadgeThickness { get; set; }BadgeSize
Section titled "BadgeSize"Inherited from: IgbUserBaseAnnotation
Gets or sets size of the badge annotations.
[Parameter]
public double BadgeSize { get; set; }BadgeCornerRadius
Section titled "BadgeCornerRadius"Inherited from: IgbUserBaseAnnotation
Gets or sets border radius of the badge annotations.
[Parameter]
public double BadgeCornerRadius { get; set; }BadgeMargin
Section titled "BadgeMargin"Inherited from: IgbUserBaseAnnotation
Gets or sets margin of the badge annotations.
[Parameter]
public double BadgeMargin { get; set; }BadgeImagePath
Section titled "BadgeImagePath"Inherited from: IgbUserBaseAnnotation
Gets or sets image path for displayed in the badge annotations.
[Parameter]
public string BadgeImagePath { get; set; }IsPillShaped
Section titled "IsPillShaped"Inherited from: IgbUserBaseAnnotation
Gets or sets whether the annotation is pill shaped.
[Parameter]
public bool IsPillShaped { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererElement
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }IsComponentRooted
Section titled "IsComponentRooted"Inherited from: BaseRendererElement
public bool IsComponentRooted { get; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererElement
protected virtual string ParentTypeName { 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; }EndLabel
Section titled "EndLabel"Gets or sets optional text displayed in the label at the end of annotation.
[Parameter]
public string EndLabel { get; set; }EndLabelBackground
Section titled "EndLabelBackground"Gets or sets background of the label at the end of annotation.
[Parameter]
public string EndLabelBackground { get; set; }EndLabelBorderColor
Section titled "EndLabelBorderColor"Gets or sets border color of the label at the end of annotation.
[Parameter]
public string EndLabelBorderColor { get; set; }EndLabelColor
Section titled "EndLabelColor"Gets or sets text color of the label at the end of annotation.
[Parameter]
public string EndLabelColor { get; set; }EndValue
Section titled "EndValue"Gets or sets the value that determines end of the annotation on an axis.
[Parameter]
public double EndValue { get; set; }EndValueDisplayMode
Section titled "EndValueDisplayMode"Gets or sets display mode of end value of annotation.
[Parameter]
public DataAnnotationDisplayMode EndValueDisplayMode { get; set; }StartLabel
Section titled "StartLabel"Gets or sets optional text displayed in the label at the start of annotation.
[Parameter]
public string StartLabel { get; set; }StartLabelBackground
Section titled "StartLabelBackground"Gets or sets background of the label at the start of annotation.
[Parameter]
public string StartLabelBackground { get; set; }StartLabelBorderColor
Section titled "StartLabelBorderColor"Gets or sets border color of the label at the start of annotation.
[Parameter]
public string StartLabelBorderColor { get; set; }StartLabelColor
Section titled "StartLabelColor"Gets or sets text color of the label at the start of annotation.
[Parameter]
public string StartLabelColor { get; set; }StartValue
Section titled "StartValue"Gets or sets the value that determines start of the annotation on an axis.
[Parameter]
public double StartValue { get; set; }StartValueDisplayMode
Section titled "StartValueDisplayMode"Gets or sets display mode of start value of annotation.
[Parameter]
public DataAnnotationDisplayMode StartValueDisplayMode { get; set; }public override string Type { get; }Accessors
Section titled "Accessors"_name
Section titled "_name"Inherited from: BaseRendererElement
protected string _nameeventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererElement
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererElement
protected string _cachedSerializedContentMethods
Section titled "Methods"BindAxes(IgbAxis[])
Section titled "BindAxes(IgbAxis[])"Inherited from: IgbUserAxisAnnotation
protected override void BindAxes(IgbAxis[] Axes)Parameters
- Axes:
IgbAxis[]
Returns any
BindSeries(IgbSeries[])
Section titled "BindSeries(IgbSeries[])"Inherited from: IgbUserBaseAnnotation
protected virtual void BindSeries(IgbSeries[] Series)Parameters
- Series:
IgbSeries[]
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
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
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
FromEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"protected override 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>)"protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary