Class ScaleBreak

Namespace

LightningChartLib.WinForms.Charting.Axes

Assembly

LightningChart.WinForms.Charting.NET4.dll

Exclude range for excluding defined values from axis values. Also contains Gap, which tells in DIPs, how large the range will be on window. The gap can be rendered by diagonal line or fill or just remain empty.

[TypeConverter(typeof(ExpandableObjectConverter))]
public class ScaleBreak : ChartNode, IChartNode, IDisposable, IComparable<ScaleBreak>

Inheritance

object

ChartNode

ScaleBreak

Implements

IChartNode

IDisposable

IComparable<ScaleBreak>

Inherited Members

ChartNode.Dispose()

ChartNode.CheckIfInvalidRefAndComplain(object[])

ChartNode.CheckIfInvalidRefAndComplain(object)

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

ScaleBreak()

Constructor for Form designer's list editor.

public ScaleBreak()

ScaleBreak(AxisBase)

Constructor.

public ScaleBreak(AxisBase owner)

Parameters

owner AxisBase

Parent.

ScaleBreak(AxisBase, double, double, float)

Constructor.

public ScaleBreak(AxisBase owner, double begin, double end, float gap)

Parameters

owner AxisBase

Owner axis.

begin double

Begin value.

end double

End value.

gap float

Gap in DIPs.

Properties

Begin

Range begin value.

public double Begin { get; set; }

Property Value

double

DiagonalLineSpacing

Gap of lines in pixels. Applied, if fill style is line.

public double DiagonalLineSpacing { get; set; }

Property Value

double

Enabled

Enabled.

public bool Enabled { get; set; }

Property Value

bool

End

Range end value.

public double End { get; set; }

Property Value

double

Fill

Gap Fill. Applicable if Style is set to Fill.

public Fill Fill { get; set; }

Property Value

Fill

Gap

Gap of range in pixels.

public double Gap { get; set; }

Property Value

double

LineStyle

Gap line style, if style is diagonal line.

public LineStyle LineStyle { get; set; }

Property Value

LineStyle

Style

Gap style.

public AxisRangeGapStyle Style { get; set; }

Property Value

AxisRangeGapStyle

Methods

CompareTo(ScaleBreak)

IComparison implementation based on Begin value. If Begin values are same, order is determined by End values.

public int CompareTo(ScaleBreak other)

Parameters

other ScaleBreak

Other instance to compare to.

Returns

int

-1 if this is before other, 0 if equal (Begins are same), 1 of this is after other.

Dispose(bool)

Clean up any resources being used.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True if managed resources should be disposed, otherwise false.

Overlap(ScaleBreak)

Tells if another ScaleBreaks overlaps this.

public bool Overlap(ScaleBreak excludeRange)

Parameters

excludeRange ScaleBreak

Compared ScaleBreaks.

Returns

bool

True, if overlaps, false otherwise.

ToString()

Convert class description to string.

public override string ToString()

Returns

string

String.