Class IgbDataAnnotationAxisLayer
Represents a base annotation layer that displays annotations over an axis.
Inheritance
System.Object
IgbDataAnnotationAxisLayer
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDataAnnotationAxisLayer : IgbAnnotationLayer, JsonSerializable, IDisposable
Constructors
IgbDataAnnotationAxisLayer()
Declaration
public IgbDataAnnotationAxisLayer()
Properties
AnnotationBackground
Gets or sets the color used for backing of the axis annotation.
Declaration
public string AnnotationBackground { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationBackgroundMatchLayer
Gets or sets whether the annotation background matches brush of the layer
Declaration
public bool AnnotationBackgroundMatchLayer { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AnnotationBackgroundMode
Gets or sets the mode used for shifting the background of axis annotation.
Declaration
public AnnotationAppearanceMode AnnotationBackgroundMode { get; set; }
Property Value
AnnotationBackgroundShift
Gets or sets the percentage used to shift AnnotationBackground. Value must range between -1.0 to 1.0, where 0 means no color shift.
Declaration
public double AnnotationBackgroundShift { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationBadgeBackground
Gets or sets background of the badge annotations.
Declaration
public string AnnotationBadgeBackground { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationBadgeCornerRadius
Gets or sets border radius of the badge annotations.
Declaration
public double AnnotationBadgeCornerRadius { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationBadgeEnabled
Gets or sets whether the badge are rendered in annotations.
Declaration
public bool AnnotationBadgeEnabled { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AnnotationBadgeImagePath
Gets or sets a member path for displaying an image in the badge annotations.
Declaration
public string AnnotationBadgeImagePath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationBadgeMargin
Gets or sets margin of the badge annotations.
Declaration
public double AnnotationBadgeMargin { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationBadgeOutline
Gets or sets border outline of the badge annotations.
Declaration
public string AnnotationBadgeOutline { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationBadgeOutlineThickness
Gets or sets border thickness of the badge annotations.
Declaration
public double AnnotationBadgeOutlineThickness { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationBadgeSize
Gets or sets size of the badge annotations.
Declaration
public double AnnotationBadgeSize { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationBorderColor
Gets or sets the color used for border color of the axis annotation.
Declaration
public string AnnotationBorderColor { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationBorderMatchLayer
Gets or sets whether the annotation border matches outline of the layer (if it has a fill visual) otherwise brush of the layer
Declaration
public bool AnnotationBorderMatchLayer { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AnnotationBorderMode
Gets or sets the mode used for shifting border color of the axis annotation.
Declaration
public AnnotationAppearanceMode AnnotationBorderMode { get; set; }
Property Value
AnnotationBorderRadius
Gets or sets the border radius used for displaying the axis annotation.
Declaration
public double AnnotationBorderRadius { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationBorderShift
Gets or sets the percentage amount used to shift AnnotationBorderColor. Value must range between -1.0 to 1.0, where 0 means no color shift.
Declaration
public double AnnotationBorderShift { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationBorderThickness
Gets or sets border thickness of the axis annotations.
Declaration
public double AnnotationBorderThickness { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationLabelDisplayMode
Gets or sets display mode of label on axis annotation.
Declaration
public DataAnnotationDisplayMode AnnotationLabelDisplayMode { get; set; }
Property Value
AnnotationLabelVisible
Gets or sets whether to show all annotations over target axis
Declaration
public bool AnnotationLabelVisible { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AnnotationPaddingBottom
Declaration
public double AnnotationPaddingBottom { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationPaddingLeft
Declaration
public double AnnotationPaddingLeft { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationPaddingRight
Declaration
public double AnnotationPaddingRight { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationPaddingTop
Declaration
public double AnnotationPaddingTop { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationTextColor
Gets or sets the text color used in the axis annotation.
Declaration
public string AnnotationTextColor { get; set; }
Property Value
| Type |
Description |
| System.String |
|
AnnotationTextColorMatchLayer
Gets or sets whether the annotation text color matches brush of the layer
Declaration
public bool AnnotationTextColorMatchLayer { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AnnotationTextColorMode
Gets or sets the mode used for shifting the text color in axis annotation.
Declaration
public AnnotationAppearanceMode AnnotationTextColorMode { get; set; }
Property Value
AnnotationTextColorShift
Gets or sets the percentage used to shift AnnotationTextColor. Value must range between -1.0 to 1.0, where 0 means no color shift.
Declaration
public double AnnotationTextColorShift { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
AnnotationValueMaxPrecision
Gets or sets maximum precision for displaying values on axis annotation.
Declaration
public int AnnotationValueMaxPrecision { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
AnnotationValueMinPrecision
Gets or sets minimum precision for displaying values on axis annotation.
Declaration
public int AnnotationValueMinPrecision { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
TargetAxis
Gets or sets the target axis for this annotation. If null, this annotation will use TargetMode to determine target axis.
Declaration
public IgbAxis TargetAxis { get; set; }
Property Value
TargetAxisName
Gets or sets the name to use to resolve targetAxis from markup.
Declaration
public string TargetAxisName { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TargetAxisScript
Provides a means of setting TargetAxis in the JavaScript environment.
Declaration
public string TargetAxisScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
TargetMode
Gets or sets the mode for targeting axes present in the chart. Defaults to targeting all category-axes present in the chart
Declaration
public DataAnnotationTargetMode TargetMode { get; set; }
Property Value
Type
Declaration
public override string Type { get; }
Property Value
| Type |
Description |
| System.String |
|
Overrides
Methods
BindAxes(IgbAxis[])
Declaration
protected override void BindAxes(IgbAxis[] Axes)
Parameters
| Type |
Name |
Description |
| IgbAxis[] |
Axes |
|
Overrides
FindByName(String)
Declaration
public override object FindByName(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Returns
| Type |
Description |
| System.Object |
|
Overrides
Implements
System.IDisposable