Class IgbValueOverlay

Represents the class of the value overlay. The value overlay is a line or circle representing a value on an axis.

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

Constructors

IgbValueOverlay()

Declaration
public IgbValueOverlay()

Properties

Axis

Gets or sets the axis used by the value overlay.

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

AxisAnnotationBackground

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

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

AxisAnnotationBackgroundCornerRadius

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

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

AxisAnnotationFormatLabel

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

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

AxisAnnotationFormatLabelScript

Provides a means of setting AxisAnnotationFormatLabel in the JavaScript environment.

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

AxisAnnotationInterpolatedValuePrecision

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

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

AxisAnnotationOutline

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

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

AxisAnnotationPaddingBottom

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 AxisAnnotationPaddingBottom { get; set; }
Property Value
Type Description
System.Double

AxisAnnotationPaddingLeft

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 AxisAnnotationPaddingLeft { get; set; }
Property Value
Type Description
System.Double

AxisAnnotationPaddingRight

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 AxisAnnotationPaddingRight { get; set; }
Property Value
Type Description
System.Double

AxisAnnotationPaddingTop

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 AxisAnnotationPaddingTop { get; set; }
Property Value
Type Description
System.Double

AxisAnnotationStrokeThickness

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

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

AxisAnnotationTextColor

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

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

AxisName

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

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

AxisScript

Provides a means of setting Axis in the JavaScript environment.

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

DateValue

Gets or sets the value of the overlay as a date. If this is set to something other than the minimum date, then it will be preferred over the Value property.

Declaration
public DateTime DateValue { get; set; }
Property Value
Type Description
System.DateTime

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

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

Type

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

Value

Gets or sets the value of the overlay.

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

Methods

BindAxes(IgbAxis[])

Declaration
protected override void BindAxes(IgbAxis[] Axes)
Parameters
Type Name Description
IgbAxis[] Axes
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

GetItem(Point)

Declaration
public override object GetItem(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Object
Overrides

GetItemAsync(Point)

Gets the item that is the best match for the specified world coordinates.

Declaration
public override Task<object> GetItemAsync(Point world)
Parameters
Type Name Description
Point world

The world coordinates to use.
Returns
Type Description
System.Threading.Tasks.Task<System.Object>
Overrides

GetItemIndex(Point)

Declaration
public override int GetItemIndex(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Int32
Overrides

GetItemIndexAsync(Point)

Gets the item index associated with the specified world position

Declaration
public override Task<int> GetItemIndexAsync(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
Overrides

GetLabel(Double)

Declaration
public string GetLabel(double value)
Parameters
Type Name Description
System.Double value
Returns
Type Description
System.String

GetLabelAsync(Double)

Gets the label for a data item.

Declaration
public Task<string> GetLabelAsync(double value)
Parameters
Type Name Description
System.Double value

The unscaled value to get a label for.
Returns
Type Description
System.Threading.Tasks.Task<System.String>

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

GetSeriesValuePosition(Point, Boolean, Boolean)

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

GetSeriesValuePositionAsync(Point, Boolean, Boolean)

Declaration
public override Task<Point> GetSeriesValuePositionAsync(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<Point>
Overrides

ScrollIntoView(Object)

Declaration
public override bool ScrollIntoView(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
System.Boolean
Overrides

ScrollIntoViewAsync(Object)

Requests that the provided item should be brought into view if possible.

Declaration
public override Task<bool> ScrollIntoViewAsync(object item)
Parameters
Type Name Description
System.Object item

The item to attempt to bring into view.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Overrides

Implements

System.IDisposable