ScaleBreakCollection.Add(ScaleBreak) Method

Appends the specified ScaleBreak object to the current collection.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.dll

Declaration

C#

public int Add(
    ScaleBreak scaleBreak
)

VB.NET

Public Function Add(
    scaleBreak As ScaleBreak
) As Integer

Parameters

Name	Type	Description
scaleBreak	ScaleBreak	A ScaleBreak object to append to the collection.

Returns

Type	Description
Int32	An integer value indicating the position at which the new element was inserted.

Remarks

This method adds a ScaleBreak object to the end of the collection.

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Add(ScaleBreak) method.

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#

how-to-insert-a-scale-break-into-an-axis-e1493/CS/UseScaleBreaks/Form1.cs#L32

// with their Edge1 and Edge2 properties defined in the constructor.
((XYDiagram)chartControl1.Diagram).AxisY.ScaleBreaks.Add(new ScaleBreak("Scale Break 1", 10, 100));
((XYDiagram)chartControl1.Diagram).AxisY.ScaleBreaks.Add(new ScaleBreak("Scale Break 2", 110, 2000));

VB.NET

how-to-insert-a-scale-break-into-an-axis-e1493/VB/UseScaleBreaks/Form1.vb#L33

' with their Edge1 and Edge2 properties defined in the constructor.
CType(chartControl1.Diagram, XYDiagram).AxisY.ScaleBreaks.Add(New ScaleBreak("Scale Break 1", 10, 100))
CType(chartControl1.Diagram, XYDiagram).AxisY.ScaleBreaks.Add(New ScaleBreak("Scale Break 2", 110, 2000))