Class IgbValueLayer

Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor.

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

Constructors

IgbValueLayer()

Declaration
public IgbValueLayer()

Properties

ActualValueLayerBrush

Gets the effective brush for the current value layer. Can be null for value modes that target multiple series.

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

HorizontalLineStroke

Gets or sets the color to use for the horizontal line. Leave null for an automatic value.

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

IsAxisAnnotationEnabled

Gets or sets whether to draw annotations over the axes where the crosshair meets with them.

Declaration
public bool IsAxisAnnotationEnabled { 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

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

SkipUnknownValues

Gets or sets whether to skip unknown values when searching for series values.

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

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

TargetAxis

Gets or sets the axis to target this annotation to. If null, this annotation targets all value axis simultaneously.

Declaration
public IgbAxis TargetAxis { get; set; }
Property Value
Type Description
IgbAxis

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

TargetSeries

Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously.

Declaration
public IgbSeries TargetSeries { get; set; }
Property Value
Type Description
IgbSeries

TargetSeriesName

Gets or sets the name to use to resolve targetSeries from markup.

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

TargetSeriesScript

Provides a means of setting TargetSeries in the JavaScript environment.

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

Type

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

UseInterpolation

Gets or sets whether to use value interpolation when drawing a line through the best value for the cursor position.

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

ValueMode

Gets or sets the value mode for the overlay.

Declaration
public ValueLayerValueMode ValueMode { get; set; }
Property Value
Type Description
ValueLayerValueMode

VerticalLineStroke

Gets or sets the color to use for vertical line. Leave null for an automatic value.

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

XAxisAnnotationBackground

Gets or sets the color to use for the x axis annotation backing. Leave unset for an automatic value.

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

XAxisAnnotationBackgroundCornerRadius

Gets or sets the corner radius to use for the x axis annotation backing. Leave unset for an automatic value.

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

XAxisAnnotationFormatLabel

Sets or gets a function which takes an object that produces a formatted label for the x axis annotation.

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

XAxisAnnotationFormatLabelScript

Provides a means of setting XAxisAnnotationFormatLabel in the JavaScript environment.

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

XAxisAnnotationInterpolatedValuePrecision

Gets or sets the precision to use displaying values for interpolated crosshair positions.

Declaration
public int XAxisAnnotationInterpolatedValuePrecision { get; set; }
Property Value
Type Description
System.Int32

XAxisAnnotationOutline

Gets or sets the color to use for the x axis annotation outline. Leave unset for an automatic value.

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

XAxisAnnotationPaddingBottom

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.

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

XAxisAnnotationPaddingLeft

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.

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

XAxisAnnotationPaddingRight

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.

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

XAxisAnnotationPaddingTop

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.

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

XAxisAnnotationStrokeThickness

Gets or sets the stroke thickness for the x axis annotation backing. Leave unset for an automatic value.

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

XAxisAnnotationTextColor

Gets or sets the color to use for the x axis annotation text. Leave unset for an automatic value.

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

YAxisAnnotationBackground

Gets or sets the color to use for the y axis annotation backing. Leave unset for an automatic value.

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

YAxisAnnotationBackgroundCornerRadius

Gets or sets the corner radius to use for the y axis annotation backing. Leave unset for an automatic value.

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

YAxisAnnotationFormatLabel

Sets or gets a function which takes an object that produces a formatted label for the y axis annotation.

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

YAxisAnnotationFormatLabelScript

Provides a means of setting YAxisAnnotationFormatLabel in the JavaScript environment.

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

YAxisAnnotationInterpolatedValuePrecision

Gets or sets the precision to use displaying values for interpolated crosshair positions.

Declaration
public int YAxisAnnotationInterpolatedValuePrecision { get; set; }
Property Value
Type Description
System.Int32

YAxisAnnotationOutline

Gets or sets the color to use for the y axis annotation outline. Leave unset for an automatic value.

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

YAxisAnnotationPaddingBottom

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.

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

YAxisAnnotationPaddingLeft

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.

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

YAxisAnnotationPaddingRight

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.

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

YAxisAnnotationPaddingTop

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.

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

YAxisAnnotationStrokeThickness

Gets or sets the stroke thickness for the y axis annotation backing. Leave unset for an automatic value.

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

YAxisAnnotationTextColor

Gets or sets the color to use for the y axis annotation text. Leave unset for an automatic value.

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

Methods

BindAxes(IgbAxis[])

Declaration
protected override void BindAxes(IgbAxis[] Axes)
Parameters
Type Name Description
IgbAxis[] Axes
Overrides

BindSeries(IgbSeries[])

Declaration
protected override void BindSeries(IgbSeries[] Series)
Parameters
Type Name Description
IgbSeries[] Series
Overrides

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

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

GetSeriesValue(Point, Boolean, Boolean)

Declaration
public override double GetSeriesValue(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Double
Overrides

GetSeriesValueAsync(Point, Boolean, Boolean)

Declaration
public override Task<double> GetSeriesValueAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<System.Double>
Overrides

Implements

System.IDisposable