Class IgbDataAnnotationShapeLayer

Represents a base annotation layer that renders shapes defined by derived data annotation, e.g. line, strip, slice, rect, band

Inheritance
System.Object
BaseRendererElement
IgbSeries
IgbAnnotationLayer
IgbDataAnnotationAxisLayer
IgbDataAnnotationShapeLayer
IgbDataAnnotationRangeLayer
IgbDataAnnotationSliceLayer
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDataAnnotationShapeLayer : IgbDataAnnotationAxisLayer, JsonSerializable, IDisposable

Constructors

IgbDataAnnotationShapeLayer()

Declaration
public IgbDataAnnotationShapeLayer()

Properties

AnnotationShapeVisible

Gets or sets whether to draw shape of annotations in the plot area

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

IsTargetingHorizontalAxis

Gets whether the annotation layer is currently targeting horizontal axis.

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

ItemsUseWorldCoordinates

Gets or sets whether the data items of the annotations use world coordinates (0.0 - 1.0) or they default to using axes coordinates (data indexes for category axis or data values for numeric axis).

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

OverlayText

Gets or sets the text that will be displayed as the overlay annotation.

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

OverlayTextAngle

Gets or sets the angle rotation (in degrees) of the overlay text in relation to shape of data annotation.

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

OverlayTextBackground

Gets or sets the background the overlay text.

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

OverlayTextBackgroundMatchLayer

Gets or sets whether the overlay text background matches brush of the layer

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

OverlayTextBackgroundMode

Gets or sets the mode used for shifting the background of overlay text based on the target series.

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

OverlayTextBackgroundShift

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.

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

OverlayTextBorderColor

Gets or sets the border stroke of the overlay text.

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

OverlayTextBorderMatchLayer

Gets or sets whether the overlay text border matches brush of the layer

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

OverlayTextBorderMode

Gets or sets the mode used for shifting the border of overlay text based on the target series.

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

OverlayTextBorderRadius

Gets or sets the border corner of the overlay text.

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

OverlayTextBorderShift

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.

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

OverlayTextBorderThickness

Gets or sets the border thickness of the overlay text.

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

OverlayTextColor

Gets or sets the color the overlay text.

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

OverlayTextColorMatchLayer

Gets or sets whether the overlay text color matches brush of the layer

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

OverlayTextColorMode

Gets or sets the mode used for shifting the background of overlay text based on the target series.

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

OverlayTextColorShift

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.

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

OverlayTextFontFamily

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

OverlayTextFontSize

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

OverlayTextFontStyle

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

OverlayTextFontWeight

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

OverlayTextHorizontalMargin

Gets or sets the horizontal margin of the overlay text in relation to shape of data annotation.

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

OverlayTextHorizontalPadding

Gets or sets the horizontal padding of the overlay text in relation to shape of data annotation.

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

OverlayTextLocation

Gets or sets location of the overlay text in relation to shape of data annotation.

Declaration
public OverlayTextLocation OverlayTextLocation { get; set; }
Property Value
Type Description
OverlayTextLocation

OverlayTextMemberPath

Gets or sets name of data column with text that will be displayed as overlay text.

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

OverlayTextVerticalMargin

Gets or sets the vertical margin of the overlay text in relation to shape of data annotation.

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

OverlayTextVerticalPadding

Gets or sets the vertical padding of the overlay text in relation to shape of data annotation.

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

OverlayTextVisible

Gets or sets whether the overlay text is visible in shape of data annotation

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

StylingAxisAnnotation

Declaration
public EventCallback<IgbDataAnnotationInfo> StylingAxisAnnotation { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataAnnotationInfo>

StylingAxisAnnotationScript

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

StylingOverlayText

Declaration
public EventCallback<IgbOverlayTextUpdatingEventArgs> StylingOverlayText { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbOverlayTextUpdatingEventArgs>

StylingOverlayTextScript

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

StylingShapeAnnotation

Declaration
public EventCallback<IgbDataAnnotationItem> StylingShapeAnnotation { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDataAnnotationItem>

StylingShapeAnnotationScript

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

Type

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

Methods

FindByName(String)

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

FromWorld(Point)

Declaration
public Point FromWorld(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
Point

FromWorldAsync(Point)

Converts world coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's size

Declaration
public Task<Point> FromWorldAsync(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Threading.Tasks.Task<Point>

FromWorldX(Double)

Declaration
public double FromWorldX(double x)
Parameters
Type Name Description
System.Double x
Returns
Type Description
System.Double

FromWorldXAsync(Double)

Converts world X coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's width

Declaration
public Task<double> FromWorldXAsync(double x)
Parameters
Type Name Description
System.Double x
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

FromWorldY(Double)

Declaration
public double FromWorldY(double y)
Parameters
Type Name Description
System.Double y
Returns
Type Description
System.Double

FromWorldYAsync(Double)

Converts world Y coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's height

Declaration
public Task<double> FromWorldYAsync(double y)
Parameters
Type Name Description
System.Double y
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

ToWorld(Point)

Declaration
public Point ToWorld(Point pixel)
Parameters
Type Name Description
Point pixel
Returns
Type Description
Point

ToWorldAsync(Point)

Converts pixel coordinate (relative to component's size) to world coordinate (0.0 - 1.0)

Declaration
public Task<Point> ToWorldAsync(Point pixel)
Parameters
Type Name Description
Point pixel
Returns
Type Description
System.Threading.Tasks.Task<Point>

ToWorldX(Double)

Declaration
public double ToWorldX(double x)
Parameters
Type Name Description
System.Double x
Returns
Type Description
System.Double

ToWorldXAsync(Double)

Converts pixel X coordinate (relative to component's width) to world coordinate (0.0 - 1.0)

Declaration
public Task<double> ToWorldXAsync(double x)
Parameters
Type Name Description
System.Double x
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

ToWorldY(Double)

Declaration
public double ToWorldY(double y)
Parameters
Type Name Description
System.Double y
Returns
Type Description
System.Double

ToWorldYAsync(Double)

Converts pixel Y coordinate (relative to component's height) to world coordinate (0.0 - 1.0)

Declaration
public Task<double> ToWorldYAsync(double y)
Parameters
Type Name Description
System.Double y
Returns
Type Description
System.Threading.Tasks.Task<System.Double>

Implements

System.IDisposable