WPF Charting Documentation - SciChart WPF Charts SDK v5.x
IChartModifier Interface Members
Properties  Methods 

The following tables list the members exposed by IChartModifier.

Public Properties
 NameDescription
 PropertyDataContextGets or sets the DataContext for this Chart Modifier (Inherited from SciChart.Charting.ChartModifiers.IChartModifierBase)
 PropertyIsAttachedGets or sets whether this Chart Modifier is attached to a parent SciChart.Charting.Visuals.SciChartSurface (Inherited from SciChart.Charting.ChartModifiers.IChartModifierBase)
 PropertyIsEnabledGets or sets whether the mouse target is enabled. (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 PropertyIsSynchronizedGets or sets a value indicating whether this modifier receives events from other modifiers within the same MouseManager.MouseEventGroup.  
 PropertyModifierNameGets modifier name (Inherited from SciChart.Charting.ChartModifiers.IChartModifierBase)
 PropertyModifierSurfaceGets the SciChart.Charting.Visuals.IChartModifierSurface instance on the parent SciChart.Charting.Visuals.SciChartSurface, which acts as a canvas to place UIElements (Inherited from SciChart.Charting.ChartModifiers.IChartModifierBase)
 PropertyMouseEventGroupGets or sets a Mouse Event Group, an ID used to share mouse events across multiple targets. (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 PropertyParentSurfaceGets or sets the parent SciChart.Charting.Visuals.SciChartSurface to perform operations on  
 PropertyReceiveHandledEventsIf true, this IChartModifier can receive handled events. Chart modifiers work similarly to mouse event handlers in WPF and Silverlight. If a modifier further up the stack receives an event and handles it, then subsequent modifiers do not receive the event. This property overrides this behaviour. (Inherited from SciChart.Charting.ChartModifiers.IChartModifierBase)
 PropertyServicesGets the SciChart.Core.Utility.ServiceContainer which provides access to services throughout SciChart. ServiceContainers are created one per SciChart.Charting.Visuals.SciChartSurface instance, and shared between peripheral components such as SciChart.Charting.Visuals.Axes.AxisBase, SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries, ChartModifierBase instances. For a full list of available services, see the remarks on SciChart.Core.Utility.ServiceContainer (Inherited from SciChart.Charting.ChartModifiers.IChartModifierBase)
 PropertyXAxisGets the XAxis SciChart.Charting.Visuals.Axes.IAxis instance on the parent SciChart.Charting.Visuals.SciChartSurface  
 PropertyYAxesReturns the YAxes on the parent SciChart.Charting.Visuals.SciChartSurface  
 PropertyYAxisGets the primary YAxis, this is the first axis in the YAxes collection  
Top
Public Methods
 NameDescription
 MethodCanReceiveMouseEventsReturns a value indicating whether mouse events should be propagated to the mouse target. (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 MethodGetYAxisGets the YAxis SciChart.Charting.Visuals.Axes.IAxis instance on the parent SciChart.Charting.Visuals.SciChartSurface with the specified Id  
 MethodIsPointWithinBoundsGets whether the mouse point is within the bounds of the hit-testable element. Assumes the mouse-point has not been translated yet (performs translation)  
 MethodOnAnnotationCollectionChangedCalled when the AnnotationCollection changes  
 MethodOnAttachedCalled when the Chart Modifier is attached to the Chart Surface (Inherited from SciChart.Charting.ChartModifiers.IChartModifierBase)
 MethodOnDetachedCalled immediately before the Chart Modifier is detached from the Chart Surface (Inherited from SciChart.Charting.ChartModifiers.IChartModifierBase)
 MethodOnMasterMouseLeaveCalled when the MouseLeave event is fired for a Master of current SciChart.Core.Utility.Mouse.IReceiveMouseEvents.MouseEventGroup. (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 MethodOnModifierDoubleClickCalled when a Mouse DoubleClick occurs. (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 MethodOnModifierKeyDownCalled when the KeyDown event is fired for the Master of the current SciChart.Core.Utility.Mouse.IReceiveMouseEvents.MouseEventGroup (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 MethodOnModifierKeyUpCalled when the KeyUp event is fired for the Master of the current SciChart.Core.Utility.Mouse.IReceiveMouseEvents.MouseEventGroup (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 MethodOnModifierMouseDownCalled when a Mouse Button is pressed. (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 MethodOnModifierMouseMoveCalled when the Mouse is moved. (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 MethodOnModifierMouseUpCalled when a Mouse Button is released. (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 MethodOnModifierMouseWheelCalled when the Mouse Wheel is scrolled. (Inherited from SciChart.Core.Utility.Mouse.IReceiveMouseEvents)
 MethodOnModifierTouchDownCalled when a Touch Down event is registered (Inherited from SciChart.Core.Utility.Mouse.IReceiveTouchEvents)
 MethodOnModifierTouchManipulationCompletedCalled when a manipulation is completed (Inherited from SciChart.Core.Utility.Mouse.IReceiveTouchEvents)
 MethodOnModifierTouchManipulationDeltaCalled when a touch manipulation delta occurs (Inherited from SciChart.Core.Utility.Mouse.IReceiveTouchEvents)
 MethodOnModifierTouchManipulationInertiaStartingCalled when a manipulation ineritia is starting (Inherited from SciChart.Core.Utility.Mouse.IReceiveTouchEvents)
 MethodOnModifierTouchManipulationStartedCalled when a manipulation is starting (Inherited from SciChart.Core.Utility.Mouse.IReceiveTouchEvents)
 MethodOnModifierTouchManipulationStartingCalled when a manipulation is starting (Inherited from SciChart.Core.Utility.Mouse.IReceiveTouchEvents)
 MethodOnModifierTouchMoveCalled after each touch position change during a manipulation. (Inherited from SciChart.Core.Utility.Mouse.IReceiveTouchEvents)
 MethodOnModifierTouchUpCalled when a Touch Up is complete. (Inherited from SciChart.Core.Utility.Mouse.IReceiveTouchEvents)
 MethodOnXAxesCollectionChangedCalled with the SciChart.Charting.Visuals.SciChartSurface.XAxes SciChart.Charting.Model.AxisCollection changes  
 MethodOnYAxesCollectionChangedCalled with the SciChart.Charting.Visuals.SciChartSurface.XAxes SciChart.Charting.Model.AxisCollection changes  
 MethodResetInertiaInstantly stops any inertia that can be associated with this modifier.  
Top
See Also

Reference

IChartModifier Interface
SciChart.Charting.ChartModifiers Namespace

 

 


SCICHART ® is a Registered Trademark in the UK, US and EU. Copyright SciChart Ltd 2011-2018.

Send Feedback