Click or drag to resize

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

Namespace:  Arction.Wpf.Charting.SeriesXY
Assembly:  Arction.Wpf.Charting.LightningChart (in Arction.Wpf.Charting.LightningChart.dll) Version: 10.3.1
Syntax
[SerializableAttribute]
public class Band : SeriesBaseXY

The Band type exposes the following members.

Constructors
  NameDescription
Public methodBand
Constructor for Form designer list editor.
Public methodBand(ViewXY, AxisX, AxisY)
Constructor.
Top
Properties
  NameDescription
Public propertyAllowMoveByUser
Allows moving the band by user. Move the band by dragging the band anywhere but not from its edge.
Public propertyAllowResizeByUser
Allows resizing the band by user. Resize the band by dragging the band from its edge.
Public propertyAllowUserInteraction
Allow series reacting to user interaction device movement. Device hit testing with objects cause CPU overhead when the device is moved. If user interaction is not absolute necessary directly within chart and if you want to maximize the performance, set this false.
(Inherited from SeriesBaseXY.)
Public propertyAssignableXAxes
List of assignable X axes
(Inherited from SeriesBaseXY.)
Public propertyAssignableYAxes
List of assignable Y axes
(Inherited from SeriesBaseXY.)
Public propertyAssignXAxisIndex
Index of X axis assigned to this series. Give -1 when you don't want to assign it yet to any X axis.
(Inherited from SeriesBaseXY.)
Public propertyAssignYAxisIndex
Index of Y axis assigned to this series. Give -1 when you don't want to assign it yet to any Y axis.
(Inherited from SeriesBaseXY.)
Public propertyBehind
Is the band behind line series or on front of it.
Public propertyBinding
Is the band bound to X or Y axis
Public propertyBorderColor
Border color
Public propertyBorderWidth
Border width
Public propertyCanFreeze
Gets a value that indicates whether the object can be made unmodifiable.
(Inherited from Freezable.)
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDisableDragToAnotherAxis
Disable dragging from Y axis to another Y axis or from chart to another chart. Set this true if you want to zoom in the series area, and keep other user interactive device interactivity features available.
(Inherited from SeriesBaseXY.)
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyFill
Fill
Public propertyHighlight
Gets or sets highlight style. Item can be highlighted by user interactive device or by code.
(Inherited from HighlightingItemBase.)
Public propertyIncludeInAutoFit
Include series values in automatic fit.
(Inherited from SeriesBaseXY.)
Public propertyIsFrozen
Gets a value that indicates whether the object is currently modifiable.
(Inherited from Freezable.)
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyLegendBoxIndex
Legendbox index.
(Inherited from SeriesBaseXY.)
Public propertyLimitYToStackSegment
Limit Y draw range to segment area when y-axes are stacked.
(Inherited from SeriesBaseXY.)
Public propertyMaxLimit
Maximum value for ValueBegin or ValueEnd
Public propertyMinLimit
Minimum value for ValueBegin or ValueEnd
Public propertyOwnerView
Owner view.
(Inherited from SeriesBaseXY.)
Public propertyResizeBorderWidth
Band resize border width.
Public propertyShowInLegendBox
Enlists the series title text in Legend box of the chart
(Inherited from SeriesBaseXY.)
Public propertyTitle
Series title
Public propertyUseLimits
Limit the ValueBegin and ValueEnd inside the MinLimit...MaxLimit range, if enabled.
Public propertyValueBegin
Band begin value
Public propertyValueEnd
Band end value
Public propertyVisible
Is the series visible
(Inherited from SeriesBaseXY.)
Top
Methods
  NameDescription
Public methodClear
Does nothing on this series type.
(Overrides SeriesBaseXYClear.)
Public methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodClone
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.)
Public methodCloneCurrentValue
Creates a modifiable clone (deep copy) of the Freezable using its current values.
(Inherited from Freezable.)
Public methodCoerceValue
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.)
Public methodDispose
Release all resources used by this instance.
(Inherited from ChartNode.)
Public methodEquals
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Public methodFreeze
Makes the current object unmodifiable and sets its IsFrozen property to true.
(Inherited from Freezable.)
Public methodGetAsFrozen
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.)
Public methodGetClipAreas
Get clipping areas.
(Inherited from SeriesBaseXY.)
Public methodGetCurrentValueAsFrozen
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.)
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
Public methodInvalidateData
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.)
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
Public methodIsHighlighted
returns true if the object is highlighted.
(Inherited from HighlightingItemBase.)
Public methodIsOverBorder
Check if position is over border.
Public methodIsPositionOver
Is position over band.
(Overrides SeriesBaseXYIsPositionOver(Int32, Int32, Boolean).)
Public methodLoadFromCSV
Loads series data from a CSV file.
(Inherited from SeriesBaseXY.)
Public methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
Public methodRemoveHighlight
Removes forced highlighting.
(Inherited from HighlightingItemBase.)
Public methodSaveToCSV
Saves series data into CSV file
(Inherited from SeriesBaseXY.)
Public methodSetClipAreas
Set clipping areas. Give null to disable all clip areas.
(Inherited from SeriesBaseXY.)
Public methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
Public methodSetHighlight
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.)
Public methodSetProperCursor
Set proper dragging cursor, or over cursor.
(Overrides UserInteractiveObjectSetProperCursor.)
Public methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
Public methodSetValues
Set begin and end values.
Public methodToString
Description of class.
(Overrides SeriesBaseXYToString.)
Top
Events
  NameDescription
Public eventBeforeSeriesRendering
Occurs just before the rendering of the series takes place.
(Inherited from SeriesBaseXY.)
Public eventChanged
Occurs when the Freezable or an object it contains is modified.
(Inherited from Freezable.)
Public eventDraggedByUser
Moved by user.
Public eventHighlightedStateChanged
Event telling that highlighted state has changed. Contains information of the new state.
(Inherited from HighlightingItemBase.)
Public eventMouseClick
Mouse button has been clicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDoubleClick
Mouse button has been doubleclicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDown
Mouse button has been pressed down.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOff
Mouse has been moved outside of object.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOn
Mouse has been moved over object.
(Inherited from UserInteractiveObject.)
Public eventMouseUp
Mouse button has been released.
(Inherited from UserInteractiveObject.)
Public eventResizedByUser
Band has been resized by user.
Public eventValuesChanged
Band begin and/or end value have been changed.
Top
Fields
  NameDescription
Public fieldTag
Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt.)
Top
See Also