CursorModifier Class

The CursorModifier provides a cross-hairs (cursor) plus tooltip with X,Y data values under the mouse as the mouse moves. Add to a SciChart.Charting.Visuals.SciChartSurface and set IsEnabled to True to enable this behaviour.

Object Model

Syntax

[DefaultProperty("Content")]
[ContentProperty("Content")]
[Localizability(LocalizationCategory.None, Readability=Readability.Unreadable)]
[StyleTypedProperty(Property="FocusVisualStyle", StyleTargetType=System.Windows.Controls.Control)]
[XmlLangProperty("Language")]
[UsableDuringInitialization(true)]
[RuntimeNameProperty("Name")]
[UidProperty("Uid")]
[TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
[NameScopeProperty("NameScope", System.Windows.NameScope)]
public class CursorModifier : TooltipModifierBase, IChartModifier, IChartModifierBase, SciChart.Core.Utility.Mouse.IReceiveMouseEvents, SciChart.Core.Utility.Mouse.IReceiveTouchEvents

Example

Shows how to assign a CursorModifier to a SciChartSurface in XAMLShows how to assign a CursorModifier to a SciChartSurface in C#

xaml
C#

<!-- where xmlns:s="http://schemas.abtsoftware.co.uk/SciChart" -->
<s:SciChartSurface>
   <s:SciChartSurface.ChartModifier>
      <s:ModifierGroup>
     	  <s:CursorModifier IsEnabled="True" ShowAxisLabels="True" 
                               ShowTooltip="True" ShowTooltipOn="MouseOver" 
                               SnappingMode="TooltipToSeries"/>
      </s:ModifierGroup>
   </s:SciChartSurface.ChartModifier>
</s:SciChartSurface>

var sciChartSurface = new SciChartSurface();
sciChartSurface.ChartModifier = new ModifierGroup(new CursorModifier() 
{
   IsEnabled = true,
   ShowAxisLabels = true, 
   ShowTooltip = true, 
   ShowTooltipOn = ShowTooltipOptions.MouseOver, 
   SnappingMode = CursorSnappingMode.TooltipToSeries,
});

Inheritance Hierarchy

System.Object
   System.Windows.Threading.DispatcherObject
      System.Windows.DependencyObject
         System.Windows.Media.Visual
            System.Windows.UIElement
               System.Windows.FrameworkElement
                  System.Windows.Controls.Control
                     System.Windows.Controls.ContentControl
                        SciChart.Charting.ChartModifiers.ApiElementBase
                           SciChart.Charting.ChartModifiers.ChartModifierBase
                              SciChart.Charting.ChartModifiers.InspectSeriesModifierBase
                                 SciChart.Charting.ChartModifiers.TooltipModifierBase
                                    SciChart.Charting.ChartModifiers.CursorModifier

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

CursorModifier Members
SciChart.Charting.ChartModifiers Namespace
RolloverModifier Class
TooltipModifier Class
VerticalSliceModifier Class
TooltipModifier Class