Band Class

LightningChart .NET Help

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.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        Arction.Wpf.ChartingMVVMChartNode
          Arction.Wpf.ChartingMVVMUserInteractiveObjectInt
            Arction.Wpf.ChartingMVVMUserInteractiveObject
              Arction.Wpf.ChartingMVVMHighlightingItemBase
                Arction.Wpf.ChartingMVVM.SeriesXYSeriesBaseXY
                  Arction.Wpf.ChartingMVVM.SeriesXYBand

Namespace: Arction.Wpf.ChartingMVVM.SeriesXY
Assembly: Arction.Wpf.ChartingMVVM.LightningChart (in Arction.Wpf.ChartingMVVM.LightningChart.dll) Version: 10.3.1

Syntax

C++

Copy

[SerializableAttribute]
public class Band : SeriesBaseXY

<SerializableAttribute>
Public Class Band
	Inherits SeriesBaseXY

[SerializableAttribute]
public ref class Band : public SeriesBaseXY

The Band type exposes the following members.

Constructors

	Name	Description
	Band	Constructor for Form designer list editor.
	Band(ViewXY, AxisX, AxisY)	Constructor.

Top

Properties

	Name	Description
	AllowMoveByUser	Gets or sets if allows user to move the band. This is a dependency property. Move the band by dragging the band anywhere but not from its edge.
	AllowResizeByUser	Gets or sets if allows user to resize the band. This is a dependency property. Resize the band by dragging the band from its edge.
	AllowUserInteraction	Gets or sets if user interaction is allowed. This is a dependency property. (Inherited from UserInteractiveObject.)
	AssignXAxisIndex	Gets or sets index of X axis assigned to this series. Give -1 when you don't want to assign it yet to any X axis. This is a dependency property. (Inherited from SeriesBaseXY.)
	AssignYAxisIndex	Gets or sets index of Y axis assigned to this series. Give -1 when you don't want to assign it yet to any Y axis. This is a dependency property. (Inherited from SeriesBaseXY.)
	Behind	Gets or sets if the band is behind line series or on front of it. This is a dependency property.
	Binding	Gets or sets if the band is bound to X or Y axis. This is a dependency property.
	BorderColor	Gets or sets border color. This is a dependency property.
	BorderWidth	Gets or sets border width. This is a dependency property.
	CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	DisableDragToAnotherAxis	Gets or sets if disable dragging from Y axis to another Y axis or from chart to another chart. This is a dependency property. Set this true if you want to zoom in the series area, and keep other user interactive device interactivity features available. (Inherited from SeriesBaseXY.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	Fill	Gets or sets fill. This is a dependency property.
	Highlight	Gets or sets highlight style. Item can be highlighted by user interactive device or by code. This is a dependency property. (Inherited from HighlightingItemBase.)
	IncludeInAutoFit	Gets or sets if includes series values in automatic fit. This is a dependency property. (Inherited from SeriesBaseXY.)
	IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
	LegendBoxIndex	Gets or sets legendbox index. This is a dependency property. (Inherited from SeriesBaseXY.)
	LimitYToStackSegment	Gets or sets if limit Y draw range to segment area when y-axes are stacked. This is a dependency property. (Inherited from SeriesBaseXY.)
	MaxLimit	Gets or sets maximum value for ValueBegin or ValueEnd. This is a dependency property.
	MinLimit	Gets or sets minimum value for ValueBegin or ValueEnd. This is a dependency property.
	OwnerView	Owner view. (Inherited from SeriesBaseXY.)
	ResizeBorderWidth	Gets or sets band resize border width. This is a dependency property.
	ShowInLegendBox	Gets or sets if enlists the series title text in Legend box of the chart. This is a dependency property. (Inherited from SeriesBaseXY.)
	Title	Gets or sets series title. This is a dependency property.
	UseLimits	Gets or sets if limit the ValueBegin and ValueEnd inside the MinLimit...MaxLimit range. This is a dependency property.
	ValueBegin	Gets or sets band begin value. This is a dependency property.
	ValueEnd	Gets or sets band end value. This is a dependency property.
	Visible	Gets or sets series visible state. This is a dependency property. (Inherited from SeriesBaseXY.)

Top

Methods

	Name	Description
	Clear	Does nothing on this series type. (Overrides SeriesBaseXYClear.)
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone	Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values. (Inherited from Freezable.)
	CloneCurrentValue	Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable.)
	CoerceValue	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
	Dispose	Release all resources used by this instance. (Inherited from ChartNode.)
	Equals	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
	Freeze	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	GetAsFrozen	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetClipAreas	Get clipping areas. (Inherited from SeriesBaseXY.)
	GetCurrentValueAsFrozen	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetHashCode	Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
	GetLocalValueEnumerator	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	InvalidateData	Series data has been modified directly by it's array. Use this method to notify chart that this series needs a refresh (Inherited from SeriesBaseXY.)
	InvalidateProperty	Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
	IsHighlighted	returns true if the object is highlighted. (Inherited from HighlightingItemBase.)
	IsOverBorder	Check if position is over border.
	IsPositionOver	Is position over band. (Overrides SeriesBaseXYIsPositionOver(Int32, Int32, Boolean).)
	LoadFromCSV	Loads series data from a CSV file. (Inherited from SeriesBaseXY.)
	ReadLocalValue	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	RemoveHighlight	Removes forced highlighting. (Inherited from HighlightingItemBase.)
	SaveToCSV	Saves series data into CSV file (Inherited from SeriesBaseXY.)
	SetClipAreas	Set clipping areas. Give null to disable all clip areas. (Inherited from SeriesBaseXY.)
	SetCurrentValue	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetHighlight	Highlights the object. This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set. (Inherited from HighlightingItemBase.)
	SetProperCursor	Set proper dragging cursor, or over cursor. (Overrides UserInteractiveObjectSetProperCursor.)
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	SetValues	Set begin and end values.
	ToString	Description of class. (Overrides SeriesBaseXYToString.)

Top

Events

	Name	Description
	BeforeSeriesRendering	Occurs just before the rendering of the series takes place. (Inherited from SeriesBaseXY.)
	Changed	Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
	DraggedByUser	Moved by user.
	HighlightedStateChanged	Event telling that highlighted state has changed. Contains information of the new state. (Inherited from HighlightingItemBase.)
	MouseClick	Mouse button has been clicked. (Inherited from UserInteractiveObject.)
	MouseDoubleClick	Mouse button has been doubleclicked. (Inherited from UserInteractiveObject.)
	MouseDown	Mouse button has been pressed down. (Inherited from UserInteractiveObject.)
	MouseOverOff	Mouse has been moved outside of object. (Inherited from UserInteractiveObject.)
	MouseOverOn	Mouse has been moved over object. (Inherited from UserInteractiveObject.)
	MouseUp	Mouse button has been released. (Inherited from UserInteractiveObject.)
	ResizedByUser	Band has been resized by user.
	ValuesChanged	Band begin and/or end value have been changed.

Top

Fields

	Name	Description
	AllowMoveByUserProperty	Identifies the AllowMoveByUser dependency property.
	AllowResizeByUserProperty	Identifies the AllowResizeByUser dependency property.
	BehindProperty	Identifies the Behind dependency property.
	BindingProperty	Identifies the Binding dependency property.
	BorderColorProperty	Identifies the BorderColor dependency property.
	BorderWidthProperty	Identifies the BorderWidth dependency property.
	FillProperty	Identifies the Fill dependency property.
	MaxLimitProperty	Identifies the MaxLimit dependency property.
	MinLimitProperty	Identifies the MinLimit dependency property.
	ResizeBorderWidthProperty	Identifies the ResizeBorderWidth dependency property.
	Tag	Tag. Freely assignable object. (Inherited from UserInteractiveObjectInt.)
	TitleProperty	Identifies the Title dependency property.
	UseLimitsProperty	Identifies the UseLimits dependency property.
	ValueBeginProperty	Identifies the ValueBegin dependency property.
	ValueEndProperty	Identifies the ValueEnd dependency property.

Top

Reference

Arction.Wpf.ChartingMVVM.SeriesXY Namespace