ScaleBreakOptions Class

Represents the common appearance settings of the axis’ scale breaks.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[TypeConverter(typeof(ScaleBreakOptionsTypeConverter))]
public class ScaleBreakOptions :
    ChartElement,
    IScaleBreakOptions

VB.NET

<TypeConverter(GetType(ScaleBreakOptionsTypeConverter))>
Public Class ScaleBreakOptions
    Inherits ChartElement
    Implements IScaleBreakOptions

Related API Members

The following members return ScaleBreakOptions objects:

• Axis.ScaleBreakOptions

Remarks

The ScaleBreakOptions class provides access to the properties that define the common appearance of the axis’ scale breaks (both manual and automatic). These properties are: ScaleBreakOptions.Color, ScaleBreakOptions.SizeInPixels and ScaleBreakOptions.Style.

For more information, refer to Scale Breaks.

Example

This example demonstrates how scale breaks can be created within an axis, and customized at runtime.

C#

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

// Add scale breaks to the Y-axis collection, 
// with their Edge1 and Edge2 properties defined in the constructor.
diagram.AxisY.ScaleBreaks.Add(new ScaleBreak("Scale Break 1", 10, 100));
diagram.AxisY.ScaleBreaks.Add(new ScaleBreak("Scale Break 2", 110, 2000));

// Define the scale breaks' options.
diagram.AxisY.ScaleBreakOptions.Style = ScaleBreakStyle.Ragged;
diagram.AxisY.ScaleBreakOptions.SizeInPixels = 20;
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)

' Add scale breaks to the Y-axis collection, 
' with their Edge1 and Edge2 properties defined in the constructor.
diagram.AxisY.ScaleBreaks.Add(New ScaleBreak("Scale Break 1", 10, 100))
diagram.AxisY.ScaleBreaks.Add(New ScaleBreak("Scale Break 2", 110, 2000))

' Define the scale breaks' options.
diagram.AxisY.ScaleBreakOptions.Style = ScaleBreakStyle.Ragged
diagram.AxisY.ScaleBreakOptions.SizeInPixels = 20
diagram.AxisY.ScaleBreakOptions.Color = Color.Turquoise

Inheritance

Object

ChartElement

ScaleBreakOptions