ChartModifierBase

StockSharp.Xaml.Charting.ChartModifiers

Defines the base class to a Chart Modifier, which can be used to extend the interactivity or rendering of the UltrachartSurface

Erbt von: ApiElementBase

Implementiert: IChartModifier, IChartModifierBase, IReceiveMouseEvents, INotifyPropertyChanged, IXmlSerializable

Konstruktoren

ChartModifierBase()

Initializes a new instance of the ChartModifierBase class.

Eigenschaften

ExecuteOn : ExecuteOn

Determines when the ZoomExtentsModifier executes, args.g. MouseDoubleClick will cause a zoom extents on mouse double click of the parent UltrachartSurface

IsEnabled : bool

Gets or sets a value indicating whether this element is enabled in the user interface (UI).

Rückgabe: true if the element is enabled; otherwise, false. The default value is true.

IsMouseLeftButtonDown : bool

Gets if the Left mouse button is currently down

IsMouseMiddleButtonDown : bool

Gets if the Middle mouse button is currently down

IsMouseRightButtonDown : bool

Gets of the right mouse button is currently down

ModifierName : string

Gets modifier name

MouseEventGroup : string

Gets or sets a Mouse Event Group, an ID used to share mouse events across multiple targets

ParentSurface : IUltrachartSurface

Gets or sets the parent UltrachartSurface to perform operations on

ReceiveHandledEvents : bool

Gets or sets a value, indicates whether current modifier handles events which have already been marked as handled

Services : IServiceContainer

Gets the ServiceContainer which provides access to services throughout Ultrachart. ServiceContainers are created one per UltrachartSurface instance, and shared between peripheral components such as AxisBase, BaseRenderableSeries, ChartModifierBase instances. For a full list of available services, see the remarks on ServiceContainer

Methoden

CanReceiveMouseEvents() : bool

Returns a value indicating whether mouse events should be propagated to the mouse target.

GetPointRelativeTo(Point, IHitTestable) : Point

Transforms the input point relative to the IHitTestable element. Can be used to transform points relative to the ModifierSurface, or XAxis for instance.

point
The input point
relativeTo
The IHitTestable element to translate points relative to

Rückgabe: The output point

GetRelativePosition(Point, IHitTestable) : Point

OBSOLETE

point
relativeTo
GetSchema() : XmlSchema

Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method

IsPointWithinBounds(Point, IHitTestable) : bool

Gets whether the mouse point is within the bounds of the hit-testable element. Assumes the mouse-point has not been translated yet (performs translation)

mousePoint
hitTestable
MatchesExecuteOn(MouseButtons, ExecuteOn) : bool

Determines whether the currently pressed mouse buttons matches the ExecuteOn. Used to filter events such as zoom or pan on right mouse button

mouseButtons
executeOn
OnAnnotationCollectionChanged(object, NotifyCollectionChangedEventArgs)

Called when the AnnotationCollection changes. Overridden in derived classes.

OnAttached()

Called when the element is attached to the Chart Surface

OnDataContextChanged(object, DependencyPropertyChangedEventArgs)

Called when the DataContext of the ChartModifierBase changes

sender
e
OnDetached()

Called immediately before the element is detached from the Chart Surface

OnIsEnabledChanged()

Called when the IsEnabled property changes on this ChartModifierBase instance

OnMasterMouseLeave(ModifierMouseArgs)

Called when the mouse leaves the Master of current MouseEventGroup

e
OnModifierDoubleClick(ModifierMouseArgs)

Called when a Mouse DoubleClick occurs on the parent UltrachartSurface

e
Arguments detailing the mouse button operation
OnModifierMouseDown(ModifierMouseArgs)

Called when a Mouse Button is pressed on the parent UltrachartSurface

e
Arguments detailing the mouse button operation
OnModifierMouseMove(ModifierMouseArgs)

Called when the Mouse is moved on the parent UltrachartSurface

e
Arguments detailing the mouse move operation
OnModifierMouseUp(ModifierMouseArgs)

Called when a Mouse Button is released on the parent UltrachartSurface

e
Arguments detailing the mouse button operation
OnModifierMouseWheel(ModifierMouseArgs)

Called when the Mouse Wheel is scrolled on the parent UltrachartSurface

e
Arguments detailing the mouse wheel operation
OnModifierTouchDown(ModifierTouchManipulationArgs)

Called when a Multi-Touch Down interaction occurs on the parent UltrachartSurface

e
Arguments detailing the manipulation operation
OnModifierTouchMove(ModifierTouchManipulationArgs)

Called when a Multi-Touch Move interaction occurs on the parent UltrachartSurface

e
Arguments detailing the manipulation operation
OnModifierTouchUp(ModifierTouchManipulationArgs)

Called when a Multi-Touch Up interaction occurs on the parent UltrachartSurface

e
Arguments detailing the manipulation operation
OnParentSurfaceMouseEnter()

Called when the mouse enters the parent UltrachartSurface

OnParentSurfaceMouseLeave()

Called when the mouse leaves the parent UltrachartSurface

OnParentSurfaceRendered(UltrachartRenderedMessage)

Called when the parent UltrachartSurface is rendered

e
The UltrachartRenderedMessage which contains the event arg data
OnParentSurfaceResized(UltrachartResizedMessage)

Called when the parent UltrachartSurface is resized

e
The UltrachartResizedMessage which contains the event arg data
OnSelectedSeriesChanged(IEnumerable<IRenderableSeries>, IEnumerable<IRenderableSeries>)

Called when the parent surface SelectedSeries collection changes

OnXAxesCollectionChanged(object, NotifyCollectionChangedEventArgs)

Called with the XAxesAxisCollection changes. Overridden in derived classes.

OnYAxesCollectionChanged(object, NotifyCollectionChangedEventArgs)

Called with the YAxesAxisCollection changes. Overridden in derived classes.

ReadXml(XmlReader)

Generates ChartModifierBase from its XML representation.

reader
ResetInertia()

Instantly stops any inertia that can be associated with this modifier.

SetCursor(Cursor)

Sets the Cursor on the parent UltrachartSurface

cursor
WriteXml(XmlWriter)

Converts ChartModifierBase into its XML representation.

writer

Felder

ExecuteOnProperty : DependencyProperty

Defines the ExecuteOn DependencyProperty

IsEnabledProperty : DependencyProperty

Defines the IsEnabled Attached Property

MouseModifierProperty : DependencyProperty

Defines the MouseModifier DependencyProperty

ReceiveHandledEventsProperty : DependencyProperty

Defines the ReceiveHandledEvents DependencyProperty