ChartRangeControlClientGridOptions.SnapMode Property

Specifies the current snap mode of a chart range control client.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v21.1.dll

Declaration

public ChartRangeControlClientSnapMode SnapMode { get; set; }

Property Value

Type Description
ChartRangeControlClientSnapMode

A ChartRangeControlClientSnapMode enumeration value, which selects one of the modes.

Available values:

Name Description
Auto

Identifies the auto snap mode of the chart range control client, in which the values of ChartRangeControlClientGridOptions.SnapSpacing, ChartRangeControlClientGridOptions.SnapOffset, and ChartRangeControlClientDateTimeGridOptions.SnapAlignment properties are not specified and calculated according to the values of the corresponding ChartRangeControlClientGridOptions.GridSpacing, ChartRangeControlClientGridOptions.GridOffset and ChartRangeControlClientDateTimeGridOptions.GridAlignment properties.

In the image below, the SnapSpacing = GridSpacing = 4.

SnapAutoMode

ChartMeasureUnit

Identifies the chart measure unit mode of the chart range control client, in which the ChartRangeControlClientDateTimeGridOptions.SnapAlignment property is not specified and calculated according to the DateTimeScaleOptions.MeasureUnit (NumericScaleOptions.MeasureUnit) property. Note that the values of the ChartRangeControlClientGridOptions.SnapSpacing and ChartRangeControlClientGridOptions.SnapOffset properties should be equal to the default value.

For example, in the image below, the DateTimeScaleOptions.MeasureUnit property is set to Week.

SnapChartMeasureUnitMode

Manual

Identifies the manual snap mode of the chart range control client, meaning that the ChartRangeControlClientGridOptions.SnapSpacing, ChartRangeControlClientGridOptions.SnapOffset and ChartRangeControlClientDateTimeGridOptions.SnapAlignment properties are in effect, and they should be manually defined.

For example, in the image below, the ChartRangeControlClientGridOptions.SnapSpacing property is set to 6.

SnapManualMode

Property Paths

You can access this nested property as listed below:

Object Type Path to SnapMode
ChartRangeControlClientDateTimeOptions
ChartRangeControlClientNumericOptions
GanttDiagram
SwiftPlotDiagram
XYDiagram
XYDiagram2D

Remarks

Use the SnapMode property to define which snap mode of the chart range control client should be used: manual, automatic or chart measure unit.

Note that if you defined one of the ChartRangeControlClientGridOptions.SnapSpacing, ChartRangeControlClientGridOptions.SnapOffset or ChartRangeControlClientDateTimeGridOptions.SnapAlignment properties in the ChartRangeControlClientSnapMode.Auto snap mode, this mode is changed to ChartRangeControlClientSnapMode.Manual.

See Also