ScaleBreakOptions.Color Property

Gets or sets the color of the axis’ scale breaks.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v19.1.dll

Declaration

C#

[XtraSerializableProperty]
public Color Color { get; set; }

VB.NET

<XtraSerializableProperty>
Public Property Color As Color

Property Value

Type	Description
Color	A Color value which specifies the color of the axis’ scale breaks.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Color
Axis	.ScaleBreakOptions.Color
AxisX	.ScaleBreakOptions.Color
AxisXBase	.ScaleBreakOptions.Color
AxisY	.ScaleBreakOptions.Color
AxisYBase	.ScaleBreakOptions.Color
GanttAxisX	.ScaleBreakOptions.Color
SecondaryAxisX	.ScaleBreakOptions.Color
SecondaryAxisY	.ScaleBreakOptions.Color

Remarks

Use the Color property, to define the color of scale breaks edges.

Note

The Color property simultaneously affects all the scale breaks available for an axis (both automatic and manual).

If the Color value is Empty (the default value of the property), the color used to draw scale breaks’ edges is obtained from the current chart appearance.

In addition, to adjust scale breaks appearance, you can use the following properties: 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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Color 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#

how-to-enable-automatic-scale-breaks-for-an-axis-e1621/CS/UseScaleBreaks/Form1.cs#L26

    diagram.AxisY.ScaleBreakOptions.SizeInPixels = 30;
    diagram.AxisY.ScaleBreakOptions.Color = Color.Turquoise;
}

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

    ((XYDiagram)chartControl1.Diagram).AxisY.ScaleBreakOptions.SizeInPixels = 20;
    ((XYDiagram)chartControl1.Diagram).AxisY.ScaleBreakOptions.Color = Color.RoyalBlue;
}

VB.NET

how-to-enable-automatic-scale-breaks-for-an-axis-e1621/VB/UseScaleBreaks/Form1.vb#L28

    diagram.AxisY.ScaleBreakOptions.SizeInPixels = 30
    diagram.AxisY.ScaleBreakOptions.Color = Color.Turquoise
End Sub

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

    CType(chartControl1.Diagram, XYDiagram).AxisY.ScaleBreakOptions.SizeInPixels = 20
    CType(chartControl1.Diagram, XYDiagram).AxisY.ScaleBreakOptions.Color = Color.RoyalBlue
End If