LineSeriesCursor Class

LightningChart .NET Help

Line series cursor allows tracking and evaluating line series values

Inheritance Hierarchy

DependencyObject
  LightningChartLib.UWP.ChartingMVVMChartNode
    LightningChartLib.UWP.ChartingMVVMUserInteractiveObjectInt
      LightningChartLib.UWP.ChartingMVVMUserInteractiveObject
        LightningChartLib.UWP.ChartingMVVMHighlightingItemBase
          LightningChartLib.UWP.ChartingMVVMDraggableObject
            LightningChartLib.UWP.ChartingMVVM.Views.ViewXYLineSeriesCursor

Namespace: LightningChartLib.UWP.ChartingMVVM.Views.ViewXY
Assembly: LightningChart.UWP.ChartingMVVM (in LightningChart.UWP.ChartingMVVM.dll) Version: 11.0.1
XMLNS for XAML: Not mapped to an xmlns.

Syntax

C++

Copy

[SerializableAttribute]
public class LineSeriesCursor : DraggableObject, 
	IDisposable

<SerializableAttribute>
Public Class LineSeriesCursor
	Inherits DraggableObject
	Implements IDisposable

[SerializableAttribute]
public ref class LineSeriesCursor : public DraggableObject, 
	IDisposable

The LineSeriesCursor type exposes the following members.

Constructors

	Name	Description
	LineSeriesCursor	Simple constructor for Form designer's list editor.
	LineSeriesCursor(ViewXY, AxisX)	Constructor.

Top

Properties

	Name	Description
	AllowDragging	Gets or sets if allow dragging by user. This is a dependency property. (Inherited from DraggableObject)
	AllowUserInteraction	Gets or sets if user interaction is allowed. This is a dependency property. (Inherited from UserInteractiveObject)
	AssignXAxisIndex	Gets or sets index of X axis assigned to this cursor. This is a dependency property.
	Behind	Gets or sets if cursor is behind series or front. This is a dependency property.
	FullHeight	Gets or sets is use full cursor height. This is a dependency property. If true, the cursor height will be the height of the control. If false, the cursor is vertically painted in the graph area only.
	GrabPadding	Gets or sets grab padding, which is used to widen the active area. The area is widened on both sides the specified amount. This is a dependency property.
	HairCrossColorMixing	Gets or sets if use cursor and dataseries colors or just cursor color for haircross. This is a dependency property.
	Highlight	Gets or sets highlight style. Item can be highlighted by user interactive device or by code. This is a dependency property. (Inherited from HighlightingItemBase)
	IndicateTrackingYRange	Gets or sets if cursor style is set to 'TrackSeries', and multiple series values hit on same cursor X position, adjusts series tracking horizontal line height to match the minimum and maximum value on current cursor position. This is a dependency property.
	LineStyle	Gets or sets line style. This is a dependency property.
	SnapToPoints	Gets or sets if moving the cursor, jumps the cursor to neareast series point. This is a dependency property.
	SolveYValue	Override LineSeriesCursor's Y-value solving/tracking method. Func (predefined generic) delegate type can be used with an anonymous method or lambda expression. Input parameter is series, which implements ITrackable interface. Output parameter is LineSeriesCoordinateSolveResult struct.
	Style	Gets or sets cursor style. This is a dependency property.
	ThinHairCross	Gets or sets if draw haircross horizontal line as 1px width, otherwise as wide as vertical. This is a dependency property.
	TrackLineSeries	Predicate to determine if the cursor should draw/resolve TrackPoint for a series implementing ITrackable interface.
	TrackPoint	Gets or sets tracking point style. This is a dependency property. Applies only when Style is set to PointTrack.
	ValueAtXAxis	Gets or sets X value. This is a dependency property.
	Visible	Gets or sets if cursor is visible or not. This is a dependency property.

Top

Methods

	Name	Description
	Dispose	Release all resources used by this instance. (Inherited from ChartNode)
	IsHighlighted	returns true if the object is highlighted. (Inherited from HighlightingItemBase)
	IsPositionOver	Is position over item. (Overrides UserInteractiveObjectIsPositionOver(Int32, Int32, Boolean))
	RemoveHighlight	Removes forced highlighting. (Inherited from HighlightingItemBase)
	ResetLocation	Reset location, if moved by mouse. (Inherited from DraggableObject)
	SetHighlight	Highlights the object. This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set. (Inherited from HighlightingItemBase)
	SetProperCursor	Set proper cursor. Default for dragging is VSplit. (Overrides DraggableObjectSetProperCursor)
	ToString	Convert class description to string. (Overrides HighlightingItemBaseToString)

Top

Events

	Name	Description
	DoubleTapped	Item has been doubletapped. (Inherited from UserInteractiveObject)
	DraggedByUser	Dragged by user. (Inherited from DraggableObject)
	HighlightedStateChanged	Event telling that highlighted state has changed. Contains information of the new state. (Inherited from HighlightingItemBase)
	PointerEntered	Pointer has been moved over object. (Inherited from UserInteractiveObject)
	PointerExited	Pointer has been moved outside of object. (Inherited from UserInteractiveObject)
	PointerPressed	Pointer has been pressed down. (Inherited from UserInteractiveObject)
	PointerReleased	Pointer has been released. (Inherited from UserInteractiveObject)
	PositionChanged	Cursor position on X-axis has changed.
	Tapped	Item has been tapped. (Inherited from UserInteractiveObject)
	ValueChangedInternallyEvent	Value has changed internally by chart or by user manipulation of chart object. (Inherited from ChartNode)

Top

Fields

	Name	Description
	AssignXAxisIndexProperty	Identifies the AssignXAxisIndex dependency property.
	BehindProperty	Identifies the Behind dependency property.
	FullHeightProperty	Identifies the FullHeight dependency property.
	GrabPaddingProperty	Identifies the GrabPadding dependency property.
	HairCrossColorMixingProperty	Identifies the HairCrossColorMixing dependency property.
	IndicateTrackingYRangeProperty	Identifies the IndicateTrackingYRange dependency property.
	LineStyleProperty	Identifies the LineStyle dependency property.
	SnapToPointsProperty	Identifies the SnapToPoints dependency property.
	StyleProperty	Identifies the Style dependency property.
	Tag	Tag. Freely assignable object. (Inherited from UserInteractiveObjectInt)
	ThinHairCrossProperty	Identifies the ThinHairCross dependency property.
	TrackPointProperty	Identifies the TrackPoint dependency property.
	ValueAtXAxisProperty	Identifies the ValueAtXAxis dependency property.
	VisibleProperty	Identifies the Visible dependency property.

Top

Remarks

Tracking and values evaluation is available only for series implementing ITrackable

Reference

LightningChartLib.UWP.ChartingMVVM.Views.ViewXY Namespace