Class ChartCrossHairBehavior
ChartCrossHairBehavior enables viewing of informations related to Chart coordinates, at mouse over position or at touch contact point inside a Chart.
Implements
Inherited Members
Namespace: Syncfusion.UI.Xaml.Charts
Assembly: Syncfusion.SfChart.WPF.dll
Syntax
public class ChartCrossHairBehavior : ChartBehavior, ICloneable
Remarks
ChartCrossHairBehavior displays a vertical line, horizontal line and a popup like control displaying information about the data point at touch contact point or at mouse over position. You can also customize the look of cross hair and information displayed in a label.
Examples
This example, we are using ChartCrossHairBehavior.
<syncfusion:SfChart>
<syncfusion:SfChart.Behaviors>
<syncfusion:ChartCrossHairBehavior/>
</syncfusion:SfChart.Behaviors>
</syncfusion:SfChart>
ChartCrossHairBehavior crossHair = new ChartCrossHairBehavior();
chartArea.Behaviors.Add(crossHair);
Constructors
ChartCrossHairBehavior()
Called when instance created for ChartCrossHairBehavior.
Declaration
public ChartCrossHairBehavior()
Fields
CurrentPoint
Used to specify the current location.
Declaration
protected Point CurrentPoint
Field Value
| Type |
|---|
| System.Windows.Point |
HorizontalAxisLabelAlignmentProperty
The DependencyProperty for HorizontalAxisLabelAlignment property.
Declaration
public static readonly DependencyProperty HorizontalAxisLabelAlignmentProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
HorizontalLineStyleProperty
The DependencyProperty for HorizontalLineStyle property.
Declaration
public static readonly DependencyProperty HorizontalLineStyleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
VerticalAxisLabelAlignmentProperty
The DependencyProperty for VerticalAxisLabelAlignment property.
Declaration
public static readonly DependencyProperty VerticalAxisLabelAlignmentProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
VerticalLineStyleProperty
The DependencyProperty for VerticalLineStyle property.
Declaration
public static readonly DependencyProperty VerticalLineStyleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Properties
HorizontalAxisLabelAlignment
Gets or sets the alignment for the label appearing in horizontal axis.
Declaration
public ChartAlignment HorizontalAxisLabelAlignment { get; set; }
Property Value
| Type | Description |
|---|---|
| ChartAlignment |
HorizontalLineStyle
Gets or sets the style for horizontal line.
Declaration
public Style HorizontalLineStyle { get; set; }
Property Value
| Type |
|---|
| System.Windows.Style |
IsActivated
Gets or sets a value indicating whether the crosshair is activated or not.
Declaration
protected bool IsActivated { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
PointInfos
Gets the collection of ChartPointInfo.
Declaration
public ObservableCollection<ChartPointInfo> PointInfos { get; }
Property Value
| Type |
|---|
| System.Collections.ObjectModel.ObservableCollection<ChartPointInfo> |
VerticalAxisLabelAlignment
Gets or sets the alignment for the label appearing in vertical axis.
Declaration
public ChartAlignment VerticalAxisLabelAlignment { get; set; }
Property Value
| Type | Description |
|---|---|
| ChartAlignment |
VerticalLineStyle
Gets or sets the style for vertical line.
Declaration
public Style VerticalLineStyle { get; set; }
Property Value
| Type |
|---|
| System.Windows.Style |
Methods
AddElement(UIElement)
Method implementation for add elements in UIElement.
Declaration
protected void AddElement(UIElement element)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.UIElement | element | UIElement |
AddLabel(ChartPointInfo, ChartAlignment, ChartAlignment, DataTemplate)
Method implementation for adding label in crosshair.
Declaration
protected void AddLabel(ChartPointInfo obj, ChartAlignment verticalAlignment, ChartAlignment horizontalAlignment, DataTemplate template)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartPointInfo | obj | ChartPointInfo |
| ChartAlignment | verticalAlignment | Used to specify ChartAlignment for vertical |
| ChartAlignment | horizontalAlignment | Used to specify ChartAlignment for horizontal |
| System.Windows.DataTemplate | template | DataTemplate |
AddLabel(Object, ChartAlignment, ChartAlignment, DataTemplate, Double, Double)
Method implementation for adding labels in Crosshair.
Declaration
protected virtual void AddLabel(object obj, ChartAlignment verticalAlignemnt, ChartAlignment horizontalAlignment, DataTemplate labelTemplate, double x, double y)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | ChartPointInfo |
| ChartAlignment | verticalAlignemnt | Used to specify ChartAlignment for vertical |
| ChartAlignment | horizontalAlignment | Used to specify ChartAlignment for horizontal |
| System.Windows.DataTemplate | labelTemplate | DataTemplate |
| System.Double | x | The X location |
| System.Double | y | The Y location |
AlignDefaultLabel(ChartAlignment, ChartAlignment, Double, Double, ContentControl)
Align the element inside the content control.
Declaration
protected override void AlignDefaultLabel(ChartAlignment verticalAlignemnt, ChartAlignment horizontalAlignment, double x, double y, ContentControl control)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartAlignment | verticalAlignemnt | Used to specify ChartAlignment for vertical |
| ChartAlignment | horizontalAlignment | Used to specify ChartAlignment for horizontal |
| System.Double | x | The X location |
| System.Double | y | The Y location |
| System.Windows.Controls.ContentControl | control | Used to specify corresponding content control |
Overrides
AttachElements()
Method implementation for AttachElements.
Declaration
protected override void AttachElements()
Overrides
CloneBehavior(DependencyObject)
Declaration
protected override DependencyObject CloneBehavior(DependencyObject obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.DependencyObject | obj |
Returns
| Type |
|---|
| System.Windows.DependencyObject |
Overrides
DetachElements()
Method implementation for DetachElements.
Declaration
protected override void DetachElements()
Overrides
GenerateLabel(ChartPointInfo, ChartAxis)
Method implementation to generate trackball label for axis.
Declaration
protected virtual void GenerateLabel(ChartPointInfo pointInfo, ChartAxis axis)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartPointInfo | pointInfo | ChartPointInfo |
| ChartAxis | axis | ChartAxis |
OnLayoutUpdated()
Called when the layout updated from chart.
Declaration
protected override void OnLayoutUpdated()
Overrides
OnMouseLeave(MouseEventArgs)
Called when mouse leave from the chart.
Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseEventArgs | e | MouseEventArgs |
Overrides
OnMouseLeftButtonDown(MouseButtonEventArgs)
Called when mouse left button was pressed in chart.
Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseButtonEventArgs | e | MouseButtonEventArgs |
Overrides
OnMouseLeftButtonUp(MouseButtonEventArgs)
Called when mouse left button was released.
Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseButtonEventArgs | e | MouseButtonEventArgs |
Overrides
OnMouseMove(MouseEventArgs)
Called when mouse moved in the chart.
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseEventArgs | e | MouseEventArgs |
Overrides
OnSizeChanged(SizeChangedEventArgs)
Called when size changed.
Declaration
protected override void OnSizeChanged(SizeChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.SizeChangedEventArgs | e | SizeChangedEventArgs |
Overrides
SetPosition(Point)
Method implementation for set positions for given point.
Declaration
protected virtual void SetPosition(Point point)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Point | point | Point |