Class IgbCrosshairLayer
Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor.
Inheritance
System.Object
IgbCrosshairLayer
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCrosshairLayer : IgbAnnotationLayer, JsonSerializable, IDisposable
Constructors
IgbCrosshairLayer()
Declaration
public IgbCrosshairLayer()
Properties
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 |
|
HorizontalLineVisibility
Gets or sets whether to display the horizontal line.
Declaration
public Visibility HorizontalLineVisibility { get; set; }
Property Value
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 |
|
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 |
|
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
TargetSeriesName
Gets or sets the name of the series to target this annotation to. If null, this annotation targets all series simultaneously.
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 |
|
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 |
|
VerticalLineVisibility
Gets or sets whether to display the vertical line.
Declaration
public Visibility VerticalLineVisibility { get; set; }
Property Value
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 |
|
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 |
|
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
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
Implements
System.IDisposable