Table of Contents

Class Band

Namespace
LightningChartLib.WinForms.Charting.SeriesXY
Assembly
LightningChart.WinForms.Charting.NET4.dll

Band series is X or Y axis bound vertical or horizontal rectangular area, which ranges from graph bottom to top (X bound) or left to right (Y bound) from left to right having full width of the graph.

public class Band : SeriesBaseXY, IChartNode, IDisposable, IHighlightingItem
Inheritance
Band
Implements
Inherited Members

Constructors

Band()

Constructor for Form designer list editor.

public Band()

Band(ViewXY, AxisX, AxisY)

Constructor.

public Band(ViewXY owner, AxisX axisX, AxisY axisY)

Parameters

owner ViewXY

Parent.

axisX AxisX

X-axis you want to bind.

axisY AxisY

Y-axis you want to bind.

Properties

AllowMoveByUser

Allows moving the band by user. Move the band by dragging the band anywhere but not from its edge.

public bool AllowMoveByUser { get; set; }

Property Value

bool

Remarks

AllowUserInteraction must be true for AllowMoveByUser to take effect

AllowResizeByUser

Allows resizing the band by user. Resize the band by dragging the band from its edge.

public bool AllowResizeByUser { get; set; }

Property Value

bool

Remarks

AllowUserInteraction must be true for AllowResizeByUser to take effect

Behind

Is the band behind line series or on front of it.

public bool Behind { get; set; }

Property Value

bool

Binding

Is the band bound to X or Y axis

public AxisBinding Binding { get; set; }

Property Value

AxisBinding

BorderColor

Border color

public Color BorderColor { get; set; }

Property Value

Color

BorderType

Border type. Default is Outer.

public BorderType BorderType { get; set; }

Property Value

BorderType

BorderWidth

Border width

public double BorderWidth { get; set; }

Property Value

double

Fill

Fill

public Fill Fill { get; set; }

Property Value

Fill

MaxLimit

Maximum value for ValueBegin or ValueEnd

public double MaxLimit { get; set; }

Property Value

double

MinLimit

Minimum value for ValueBegin or ValueEnd

public double MinLimit { get; set; }

Property Value

double

ResizeBorderWidth

Band resize border width.

public int ResizeBorderWidth { get; set; }

Property Value

int

Title

Series title

public SeriesTitle Title { get; set; }

Property Value

SeriesTitle

UseLimits

Limit the ValueBegin and ValueEnd inside the MinLimit...MaxLimit range, if enabled.

public bool UseLimits { get; set; }

Property Value

bool

ValueBegin

Band begin value

public double ValueBegin { get; set; }

Property Value

double

ValueEnd

Band end value

public double ValueEnd { get; set; }

Property Value

double

Methods

Clear()

Does nothing on this series type.

public override void Clear()

Construct()

Create members.

protected override void Construct()

CreateTitle()

summary M:LightningChartLib.WinForms.Charting.SeriesXY.Band.CreateTitle 
protected override void CreateTitle()

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.

InvokeDraggedByUserEvent()

Invoke dragged by user event.

protected virtual bool InvokeDraggedByUserEvent()

Returns

bool
returns M:LightningChartLib.WinForms.Charting.SeriesXY.Band.InvokeDraggedByUserEvent

InvokeResizedByUserEvent()

Invoke resized by user event.

protected virtual bool InvokeResizedByUserEvent()

Returns

bool
returns M:LightningChartLib.WinForms.Charting.SeriesXY.Band.InvokeResizedByUserEvent

IsOverBorder(int, int)

Check if position is over border.

public virtual Band.OverBorderStatus IsOverBorder(int x, int y)

Parameters

x int

x-coordinate

y int

y-coordinate

Returns

Band.OverBorderStatus

Edge on which user interactive device is

IsPositionOver(int, int, bool)

Is position over band.

public override bool IsPositionOver(int x, int y, bool useDIP = false)

Parameters

x int

x-coordinate

y int

y-coordinate

useDIP bool

Use DIP instead of pixels as parameters

Returns

bool

true if position is over item, false otherwise

OnDeserialized(StreamingContext)

OnDeserialized is called just after the object has been deserialized

[OnDeserialized]
protected void OnDeserialized(StreamingContext context)

Parameters

context StreamingContext

Context

SetProperCursor()

Set proper dragging cursor, or over cursor.

public override void SetProperCursor()

SetValues(double, double)

Set begin and end values.

public void SetValues(double begin, double end)

Parameters

begin double

Begin value.

end double

End value.

ToString()

Description of class.

public override string ToString()

Returns

string

description

Events

DraggedByUser

Moved by user.

public virtual event EventHandler<EventArgs> DraggedByUser

Event Type

EventHandler<EventArgs>

ResizedByUser

Band has been resized by user.

public virtual event Band.ResizedByUserEventHandler ResizedByUser

Event Type

Band.ResizedByUserEventHandler

ValuesChanged

Band begin and/or end value have been changed.

public event Band.ValuesChangedEventHandler ValuesChanged

Event Type

Band.ValuesChangedEventHandler