LineSeriesCursor Class

LightningChart .NET Help

Line series cursor allows tracking and evaluating line series values

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        Arction.Wpf.ChartingMVVMChartNode
          Arction.Wpf.ChartingMVVMUserInteractiveObjectInt
            Arction.Wpf.ChartingMVVMUserInteractiveObject
              Arction.Wpf.ChartingMVVMHighlightingItemBase
                Arction.Wpf.ChartingMVVMDraggableObject
                  Arction.Wpf.ChartingMVVM.Views.ViewXYLineSeriesCursor

Namespace: Arction.Wpf.ChartingMVVM.Views.ViewXY
Assembly: Arction.Wpf.ChartingMVVM.LightningChart (in Arction.Wpf.ChartingMVVM.LightningChart.dll) Version: 10.3.1

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.
	CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	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.
	IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
	LineStyle	Gets or sets line style. This is a dependency property.
	OwnerView	Owner view
	SnapToPoints	Gets or sets if moving the cursor, jumps the cursor to neareast series point. This is a dependency property.
	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.
	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
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone	Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values. (Inherited from Freezable.)
	CloneCurrentValue	Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable.)
	CoerceValue	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
	Dispose	Release all resources used by this instance. (Inherited from ChartNode.)
	Equals	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
	Freeze	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	GetAsFrozen	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetCurrentValueAsFrozen	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetHashCode	Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
	GetLocalValueEnumerator	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	InvalidateProperty	Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
	IsHighlighted	returns true if the object is highlighted. (Inherited from HighlightingItemBase.)
	IsPositionOver	Is position over item. (Overrides UserInteractiveObjectIsPositionOver(Int32, Int32, Boolean).)
	ReadLocalValue	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	RemoveHighlight	Removes forced highlighting. (Inherited from HighlightingItemBase.)
	ResetLocation	Reset location, if moved by mouse. (Inherited from DraggableObject.)
	SetCurrentValue	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	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.)
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	ToString	Convert class description to string. (Overrides HighlightingItemBaseToString.)

Top

Events

	Name	Description
	Changed	Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
	DraggedByUser	Dragged by user. (Inherited from DraggableObject.)
	HighlightedStateChanged	Event telling that highlighted state has changed. Contains information of the new state. (Inherited from HighlightingItemBase.)
	MouseClick	Mouse button has been clicked. (Inherited from UserInteractiveObject.)
	MouseDoubleClick	Mouse button has been doubleclicked. (Inherited from UserInteractiveObject.)
	MouseDown	Mouse button has been pressed down. (Inherited from UserInteractiveObject.)
	MouseOverOff	Mouse has been moved outside of object. (Inherited from UserInteractiveObject.)
	MouseOverOn	Mouse has been moved over object. (Inherited from UserInteractiveObject.)
	MouseUp	Mouse button has been released. (Inherited from UserInteractiveObject.)
	PositionChanged	Cursor position on X-axis has changed.

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

Reference

Arction.Wpf.ChartingMVVM.Views.ViewXY Namespace