TdxChartCrosshairOptions.SnapToSeriesMode Property
Specifies how the Chart control chooses target series for Crosshair Cursor.
#Declaration
property SnapToSeriesMode: TdxChartCrosshairSnapToSeriesMode read; write; default TdxChartCrosshairSnapToSeriesMode.All;
#Property Value
Type | Default | Description |
---|---|---|
Tdx |
All | The active snap to series mode. |
#Remarks
Use SnapToPointMode, SnapToSeriesMode
, SnapToOutRangePoints, and StickyLines properties to customize crosshair line and label behavior in XY diagrams.
#Property Value Examples
The following table demonstrates the difference between all snap to series modes under the same conditions:
Value | Description | Example[1] |
---|---|---|
All (default) | All series in a diagram can be targets for Crosshair Cursor. An XY diagram can display multiple sets of crosshair lines in this mode. Note An XY series can be a target for Crosshair Cursor only if the Tool This mode is compatible with all possible Snap | |
Crosshair Cursor targets only the series point nearest to the mouse pointer. This mode is compatible with all possible Snap | ||
Crosshair Cursor targets only the series point nearest to the crosshair line that follows the mouse pointer. The Refer to the following section for details: Property Setter Behavior. |
#Property Setter Behavior
The SnapToSeriesMode
property setter changes the SnapToPointMode property value to Argument if the following conditions are met:
- The new
SnapToSeriesMode
property value is NearestToFreeLine. - The current SnapToPointMode property value is NearestToCursor.
Otherwise, the SnapToPointMode property value remains unchanged.
#Default Value
The SnapToSeriesMode
property’s default value is TdxChartCrosshairSnapToSeriesMode.All.
-
These examples demonstrate all possible
SnapToSeriesMode
property values for the same XY diagram with three simple Line series under the following conditions:- The SnapToPointMode property is set to Value.
- The StickyLines property is set to SingleAxis.
- ArgumentLines.Visible and ValueLines.Visible properties are set to
True
. - The ShowArgumentLabels property is set to
False
.