Show / Hide Table of Contents

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
BaseRendererElement
IgbSeries
IgbAnnotationLayer
IgbCrosshairLayer
Implements
JsonSerializable
System.IDisposable
Inherited Members
IgbAnnotationLayer.UseIndex
IgbAnnotationLayer.UseLegend
IgbAnnotationLayer.CursorPosition
IgbAnnotationLayer.IsDefaultCrosshairDisabled
IgbAnnotationLayer.AppearanceMode
IgbAnnotationLayer.ActualAppearanceMode
IgbAnnotationLayer.ShiftAmount
IgbAnnotationLayer.ActualShiftAmount
IgbAnnotationLayer.HorizontalAppearanceMode
IgbAnnotationLayer.ActualHorizontalAppearanceMode
IgbAnnotationLayer.VerticalAppearanceMode
IgbAnnotationLayer.ActualVerticalAppearanceMode
IgbAnnotationLayer.HorizontalShiftAmount
IgbAnnotationLayer.ActualHorizontalShiftAmount
IgbAnnotationLayer.VerticalShiftAmount
IgbAnnotationLayer.ActualVerticalShiftAmount
IgbAnnotationLayer.HorizontalDashArray
IgbAnnotationLayer.ActualHorizontalDashArray
IgbAnnotationLayer.VerticalDashArray
IgbAnnotationLayer.ActualVerticalDashArray
IgbAnnotationLayer.ShouldRenderAsOverlay
IgbSeries.Dispose()
IgbSeries.OnInitializedAsync()
IgbSeries.BindAxes(IgbAxis[])
IgbSeries.ResolveTooltipBrushAsync()
IgbSeries.ResolveTooltipBrush()
IgbSeries.GetItemValueAsync(Object, String)
IgbSeries.GetItemValue(Object, String)
IgbSeries.GetMemberPathValueAsync(String)
IgbSeries.GetMemberPathValue(String)
IgbSeries.GetExactItemIndexAsync(Point)
IgbSeries.GetExactItemIndex(Point)
IgbSeries.GetItemIndexAsync(Point)
IgbSeries.GetItemIndex(Point)
IgbSeries.GetItemAsync(Point)
IgbSeries.GetItem(Point)
IgbSeries.GetPreviousOrExactIndexAsync(Point, Boolean)
IgbSeries.GetPreviousOrExactIndex(Point, Boolean)
IgbSeries.GetNextOrExactIndexAsync(Point, Boolean)
IgbSeries.GetNextOrExactIndex(Point, Boolean)
IgbSeries.GetSeriesValueAsync(Point, Boolean, Boolean)
IgbSeries.GetSeriesValue(Point, Boolean, Boolean)
IgbSeries.GetSeriesValuePositionAsync(Point, Boolean, Boolean)
IgbSeries.GetSeriesValuePosition(Point, Boolean, Boolean)
IgbSeries.GetSeriesValueBoundingBoxAsync(Point)
IgbSeries.GetSeriesValueBoundingBox(Point)
IgbSeries.GetSeriesValueMarkerBoundingBoxAsync(Point)
IgbSeries.GetSeriesValueMarkerBoundingBox(Point)
IgbSeries.GetSeriesHighValueAsync(Point, Boolean, Boolean)
IgbSeries.GetSeriesHighValue(Point, Boolean, Boolean)
IgbSeries.GetSeriesHighValuePositionAsync(Point, Boolean, Boolean)
IgbSeries.GetSeriesHighValuePosition(Point, Boolean, Boolean)
IgbSeries.GetSeriesLowValueAsync(Point, Boolean, Boolean)
IgbSeries.GetSeriesLowValue(Point, Boolean, Boolean)
IgbSeries.GetSeriesLowValuePositionAsync(Point, Boolean, Boolean)
IgbSeries.GetSeriesLowValuePosition(Point, Boolean, Boolean)
IgbSeries.GetSeriesValuePositionFromSeriesPixelAsync(Point, Boolean, Boolean)
IgbSeries.GetSeriesValuePositionFromSeriesPixel(Point, Boolean, Boolean)
IgbSeries.GetSeriesValueFromSeriesPixelAsync(Point, Boolean, Boolean)
IgbSeries.GetSeriesValueFromSeriesPixel(Point, Boolean, Boolean)
IgbSeries.GetItemSpanAsync()
IgbSeries.GetItemSpan()
IgbSeries.GetSeriesValueTypeAsync(ValueLayerValueMode)
IgbSeries.GetSeriesValueType(ValueLayerValueMode)
IgbSeries.GetSeriesValueTypePositionAsync(ValueLayerValueMode)
IgbSeries.GetSeriesValueTypePosition(ValueLayerValueMode)
IgbSeries.HideToolTipsAsync()
IgbSeries.HideToolTips()
IgbSeries.HideToolTipsImmediateAsync()
IgbSeries.HideToolTipsImmediate()
IgbSeries.ToWorldPositionAsync(Point)
IgbSeries.ToWorldPosition(Point)
IgbSeries.ToWorldRectAsync(Rect)
IgbSeries.ToWorldRect(Rect)
IgbSeries.FromWorldPositionAsync(Point)
IgbSeries.FromWorldPosition(Point)
IgbSeries.ScrollIntoViewAsync(Object)
IgbSeries.ScrollIntoView(Object)
IgbSeries.RenderSeriesAsync(Boolean)
IgbSeries.RenderSeries(Boolean)
IgbSeries.GetMainContentViewportAsync()
IgbSeries.GetMainContentViewport()
IgbSeries.GetEffectiveViewportAsync()
IgbSeries.GetEffectiveViewport()
IgbSeries.RemoveAllAlternateViewsAsync()
IgbSeries.RemoveAllAlternateViews()
IgbSeries.RemoveAlternateViewAsync(String)
IgbSeries.RemoveAlternateView(String)
IgbSeries.NotifyIndexedPropertiesChangedAsync()
IgbSeries.NotifyIndexedPropertiesChanged()
IgbSeries.NotifyVisualPropertiesChangedAsync()
IgbSeries.NotifyVisualPropertiesChanged()
IgbSeries.ReplayTransitionInAsync()
IgbSeries.ReplayTransitionIn()
IgbSeries.PlayTransitionOutAsync()
IgbSeries.PlayTransitionOut()
IgbSeries.PlayTransitionInAsync()
IgbSeries.PlayTransitionIn()
IgbSeries.PlayTransitionOutAndRemoveAsync()
IgbSeries.PlayTransitionOutAndRemove()
IgbSeries.RemoveAxesAsync()
IgbSeries.RemoveAxes()
IgbSeries.SimulateHoverAsync(Point)
IgbSeries.SimulateHover(Point)
IgbSeries.StyleUpdatedAsync()
IgbSeries.StyleUpdated()
IgbSeries.SetNegativeColorsAsync(String, String)
IgbSeries.SetNegativeColors(String, String)
IgbSeries.MoveCursorPointAsync(Point)
IgbSeries.MoveCursorPoint(Point)
IgbSeries.SeriesViewerParent
IgbSeries.Title
IgbSeries.TooltipTemplate
IgbSeries.DataLegendGroup
IgbSeries.HighlightedValuesDataLegendGroup
IgbSeries.HighlightedValuesExtraPropertyOverlays
IgbSeries.DataSource
IgbSeries.DataSourceScript
IgbSeries.HighlightedDataSource
IgbSeries.HighlightedDataSourceScript
IgbSeries.Legend
IgbSeries.LegendScript
IgbSeries.LegendItemVisibility
IgbSeries.LegendItemBadgeTemplate
IgbSeries.LegendItemBadgeTemplateScript
IgbSeries.ActualLegendItemBadgeTemplate
IgbSeries.ActualLegendItemBadgeTemplateScript
IgbSeries.ActualLegendItemBadgeOutline
IgbSeries.ActualLegendItemBadgeBrush
IgbSeries.LegendItemBadgeShape
IgbSeries.LegendItemBadgeMode
IgbSeries.LegendItemTemplate
IgbSeries.LegendItemTemplateScript
IgbSeries.DiscreteLegendItemTemplate
IgbSeries.DiscreteLegendItemTemplateScript
IgbSeries.Index
IgbSeries.TransitionEasingFunction
IgbSeries.TransitionEasingFunctionScript
IgbSeries.TransitionInEasingFunction
IgbSeries.TransitionInEasingFunctionScript
IgbSeries.TransitionOutEasingFunction
IgbSeries.TransitionOutEasingFunctionScript
IgbSeries.TransitionDuration
IgbSeries.ActualResolution
IgbSeries.Resolution
IgbSeries.VisibleRangeMarginTop
IgbSeries.VisibleRangeMarginBottom
IgbSeries.VisibleRangeMarginLeft
IgbSeries.VisibleRangeMarginRight
IgbSeries.HighlightedTitleSuffix
IgbSeries.HighlightedLegendItemVisibility
IgbSeries.Brush
IgbSeries.ActualBrush
IgbSeries.SelectionBrush
IgbSeries.FocusBrush
IgbSeries.ActualSelectionBrush
IgbSeries.ActualFocusBrush
IgbSeries.SafeActualBrush
IgbSeries.Outline
IgbSeries.ActualOutline
IgbSeries.LineJoin
IgbSeries.HighlightedValuesDisplayMode
IgbSeries.ShouldAnimateOnDataSourceSwap
IgbSeries.Thickness
IgbSeries.ActualThickness
IgbSeries.DashArray
IgbSeries.ActualHighlightingMode
IgbSeries.ActualSelectionMode
IgbSeries.ActualFocusMode
IgbSeries.ActualHighlightedValuesFadeOpacity
IgbSeries.HighlightedValuesFadeOpacity
IgbSeries.ActualHighlightingFadeOpacity
IgbSeries.HighlightingFadeOpacity
IgbSeries.IsActualLegendFinancial
IgbSeries.IsComponentHighlightingModeIgnored
IgbSeries.IsHighlightingEnabled
IgbSeries.UseItemWiseColors
IgbSeries.ShouldShiftOpacityForSafeActualBrush
IgbSeries.ShouldRemoveHighlightedDataOnLayerHidden
IgbSeries.ShouldHideAutoCallouts
IgbSeries.IsDropShadowEnabled
IgbSeries.ShadowBlur
IgbSeries.ShadowColor
IgbSeries.UseSingleShadow
IgbSeries.ShadowOffsetX
IgbSeries.ShadowOffsetY
IgbSeries.AreaFillOpacity
IgbSeries.ActualAreaFillOpacity
IgbSeries.MarkerFillOpacity
IgbSeries.ActualMarkerFillOpacity
IgbSeries.IsDefaultToolTipSelected
IgbSeries.ShowDefaultTooltip
IgbSeries.VisibleRangeMode
IgbSeries.OutlineMode
IgbSeries.TransitionInDuration
IgbSeries.TransitionOutDuration
IgbSeries.TransitionInSpeedType
IgbSeries.TransitionOutSpeedType
IgbSeries.LineCap
IgbSeries.AutoCalloutLabelFormat
IgbSeries.AutoCalloutLabelFormatSpecifiers
IgbSeries.AutoCalloutValueLabelFormat
IgbSeries.AutoCalloutValueLabelFormatSpecifiers
IgbSeries.MouseOverEnabled
IgbSeries.CoercionMethods
IgbSeries.CoercionMethodsScript
IgbSeries.ExpectFunctions
IgbSeries.HitTestMode
IgbSeries.ActualHitTestMode
IgbSeries.FinalValue
IgbSeries.PercentChange
IgbSeries.Layers
IgbSeries.ActualLayers
IgbSeries.Opacity
IgbSeries.Visibility
IgbSeries.TransitionOutCompletedScript
IgbSeries.TransitionOutCompleted
IgbSeries.RenderRequestedScript
IgbSeries.RenderRequested
BaseRendererElement._name
BaseRendererElement._cachedSerializedContent
BaseRendererElement.BuildRenderTree(RenderTreeBuilder)
BaseRendererElement.OnElementNameChanged(BaseRendererElement, String, String)
BaseRendererElement.InvokeMethod(String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodSync(String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodHelper(String, String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodHelperSync(String, String, Object[], String[], ElementReference[])
BaseRendererElement.IsPropDirty(String)
BaseRendererElement.Serialize(SerializationContext, String)
BaseRendererElement.Serialize()
BaseRendererElement.EnsureValid()
BaseRendererElement.FromEventJson(BaseRendererControl, Dictionary<String, Object>)
BaseRendererElement.ToEventJson(BaseRendererControl, Dictionary<String, Object>)
BaseRendererElement.SetResourceStringAsync(String, String, String)
BaseRendererElement.SetResourceStringAsync(String, String)
BaseRendererElement.IgBlazor
BaseRendererElement.IsComponentRooted
BaseRendererElement.ParentTypeName
BaseRendererElement.UseDirectRender
BaseRendererElement.ChildContent
BaseRendererElement.SupportsVisualChildren
BaseRendererElement.Name
BaseRendererElement.Parent
BaseRendererElement.MethodTarget
BaseRendererElement.CurrParent
Namespace: IgniteUI.Blazor.Controls
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
Type Description
Visibility

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
Type Description
IgbSeries

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
IgbAnnotationLayer.Type

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
Type Description
Visibility

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

XAxisAnnotationFormatLabelScript

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

YAxisAnnotationFormatLabelScript

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
BaseRendererElement.EnsureModulesLoaded()

FindByName(String)

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

Implements

JsonSerializable
System.IDisposable