AutoScaleBreaks.Enabled Property

Gets or sets a value indicating whether automatic scale breaks are enabled.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[TypeConverter(typeof(BooleanTypeConverter))]
[XtraSerializableProperty]
public bool Enabled { get; set; }

VB.NET

<TypeConverter(GetType(BooleanTypeConverter))>
<XtraSerializableProperty>
Public Property Enabled As Boolean

Property Value

Type	Description
Boolean	true if automatic scale breaks are enabled; otherwise, false.

Remarks

When the Enabled property is set to true, you can define the maximum number of automatic scale breaks via the AutoScaleBreaks.MaxCount property.

Note

Both automatic and manual scale breaks can co-exist along the same axis. The scale breaks calculation is performed in such a way so that if their ranges interfere, scale breaks are merged.

To access the collection of manual scale breaks, use the Axis.ScaleBreaks property.

For more information, refer to Scale Breaks.

Example

Use the following code, to enable automatic scale breaks at runtime.

C#

// Cast your diagram object to an appropriate diagram type,
// to access its axes.
XYDiagram diagram = (XYDiagram)chartControl1.Diagram;

// Enable automatic scale breaks creation, 
// and define their maximum number.
diagram.AxisY.AutoScaleBreaks.Enabled = true;
diagram.AxisY.AutoScaleBreaks.MaxCount = 5;

// Define the scale breaks' options, which are common
// for both manual and automatic scale breaks.
diagram.AxisY.ScaleBreakOptions.Style = ScaleBreakStyle.Waved;
diagram.AxisY.ScaleBreakOptions.SizeInPixels = 30;
diagram.AxisY.ScaleBreakOptions.Color = Color.Turquoise;

VB.NET

' Cast your diagram object to an appropriate diagram type,
' to access its axes.
Dim diagram As XYDiagram = CType(chartControl1.Diagram, XYDiagram)

' Enable automatic scale breaks creation, 
' and define their maximum number.
diagram.AxisY.AutoScaleBreaks.Enabled = True
diagram.AxisY.AutoScaleBreaks.MaxCount = 5

' Define the scale breaks' options, which are common
' for both manual and automatic scale breaks.
diagram.AxisY.ScaleBreakOptions.Style = ScaleBreakStyle.Waved
diagram.AxisY.ScaleBreakOptions.SizeInPixels = 30
diagram.AxisY.ScaleBreakOptions.Color = Color.Turquoise

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Enabled property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/ChartScaleBreakModule.cs#L76

    bool scaleBreakEnabled = Convert.ToBoolean(dashboardItem.CustomProperties.GetValue(PropertyName));
    diagram.SecondaryAxesY[0].AutoScaleBreaks.Enabled = scaleBreakEnabled;
}

wpf-dashboard-custom-properties/CS/Wpf-Dashboard-Custom-Properties/Modules/ChartItemModule/ChartOptions/ScaleBreak.cs#L32

    bool scaleBreakEnabled = Convert.ToBoolean(chartItem.CustomProperties[ChartItemModule.ScaleBreakPropertyName]);
    ((DevExpress.XtraCharts.XYDiagram)xrChart.Diagram).SecondaryAxesY[0].AutoScaleBreaks.Enabled = scaleBreakEnabled;
}

VB.NET

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/ChartScaleBreakModule.vb#L80

    Dim scaleBreakEnabled As Boolean = Convert.ToBoolean(dashboardItem.CustomProperties.GetValue(PropertyName))
    diagram.SecondaryAxesY(0).AutoScaleBreaks.Enabled = scaleBreakEnabled
End If

wpf-dashboard-custom-properties/VB/Wpf-Dashboard-Custom-Properties/Modules/ChartItemModule/ChartOptions/ScaleBreak.vb#L36

    Dim scaleBreakEnabled As Boolean = Convert.ToBoolean(chartItem.CustomProperties(ChartItemModule.ScaleBreakPropertyName))
    CType(xrChart.Diagram, DevExpress.XtraCharts.XYDiagram).SecondaryAxesY(0).AutoScaleBreaks.Enabled = scaleBreakEnabled
End If