Class IgbAnnotationLayer

Represents the base class for annotation layer types. Annotations will usually disable some of the default hover/touch behaviors of the chart when they are introduced to the series collection. In return they provide some valuable information as the cursor is moved by hovering over the chart, or performing a press-hold-drag interaction in touch mode.

Inheritance
System.Object
BaseRendererElement
IgbSeries
IgbAnnotationLayer
IgbCalloutLayer
IgbCategoryHighlightLayer
IgbCategoryItemHighlightLayer
IgbCategoryToolTipLayer
IgbCrosshairLayer
IgbDataAnnotationAxisLayer
IgbDataToolTipLayer
IgbFinalValueLayer
IgbItemToolTipLayer
IgbTrendLineLayer
IgbUserAnnotationToolTipLayer
IgbValueLayer
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbAnnotationLayer : IgbSeries, JsonSerializable, IDisposable

Constructors

IgbAnnotationLayer()

Declaration
public IgbAnnotationLayer()

Properties

ActualAppearanceMode

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public AnnotationAppearanceMode ActualAppearanceMode { get; set; }
Property Value
Type Description
AnnotationAppearanceMode

ActualDashArray

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public double[] ActualDashArray { get; set; }
Property Value
Type Description
System.Double[]

ActualDashCap

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public PenLineCap ActualDashCap { get; set; }
Property Value
Type Description
PenLineCap

ActualHorizontalAppearanceMode

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public AnnotationAppearanceMode ActualHorizontalAppearanceMode { get; set; }
Property Value
Type Description
AnnotationAppearanceMode

ActualHorizontalDashArray

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public double[] ActualHorizontalDashArray { get; set; }
Property Value
Type Description
System.Double[]

ActualHorizontalShiftAmount

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

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

ActualShiftAmount

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

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

ActualVerticalAppearanceMode

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public AnnotationAppearanceMode ActualVerticalAppearanceMode { get; set; }
Property Value
Type Description
AnnotationAppearanceMode

ActualVerticalDashArray

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public double[] ActualVerticalDashArray { get; set; }
Property Value
Type Description
System.Double[]

ActualVerticalShiftAmount

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

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

AppearanceMode

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public AnnotationAppearanceMode AppearanceMode { get; set; }
Property Value
Type Description
AnnotationAppearanceMode

CursorPosition

Gets or sets the world position to use instead of the pointer position for this annotation layer. If you set this value, rather than responding to the pointer, this layer will be fixed on the provided world position. A world position has x and y values that range from 0 to 1 that represent the global position of the cursor relative to the entire ranges of the axes. The default of (NaN, NaN) means that the layer should react to pointer movement.

Declaration
public Point CursorPosition { get; set; }
Property Value
Type Description
Point

CursorPositionUpdatesOnMove

Gets or sets whether the annotation layer updates on moving cursor position

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

HorizontalAppearanceMode

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public AnnotationAppearanceMode HorizontalAppearanceMode { get; set; }
Property Value
Type Description
AnnotationAppearanceMode

HorizontalDashArray

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public double[] HorizontalDashArray { get; set; }
Property Value
Type Description
System.Double[]

HorizontalShiftAmount

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

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

IsDefaultCrosshairDisabled

Gets or sets whether the series viewer's default crosshair should be disabled by the presence of this layer.

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

ShiftAmount

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

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

ShouldRenderAsOverlay

Gets or sets whether this layer renders as an overlay or not.

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

Type

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

UseIndex

Gets or sets whether this series should take up an index for auto brush coloring.

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

UseLegend

Gets or sets whether this series interacts with the chart legend.

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

VerticalAppearanceMode

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public AnnotationAppearanceMode VerticalAppearanceMode { get; set; }
Property Value
Type Description
AnnotationAppearanceMode

VerticalDashArray

Gets or sets the mode used for shifting the annotation layer color based on the target series.

Declaration
public double[] VerticalDashArray { get; set; }
Property Value
Type Description
System.Double[]

VerticalShiftAmount

Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0.

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

Methods

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