BandAnnotation Class
Definition
A shaded band/range annotation between two values.
public class BandAnnotation
Constructors
| Name | Description |
|---|---|
| BandAnnotation | No summary available. |
BandAnnotation Constructor
public BandAnnotation()
Methods
| Name | Description |
|---|---|
| Bind (8 overloads) | Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject. |
| CheckAccess | Returns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject. |
| ClearValue (4 overloads) | Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject. |
| CoerceValue | Coerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject. |
| Equals | Compares two objects using reference equality. Inherited from AvaloniaObject. |
| GetBaseValue | Inherited from AvaloniaObject. |
| GetHashCode | Gets the hash code for the object. Inherited from AvaloniaObject. |
| GetValue (3 overloads) | Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| IsAnimating | Checks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject. |
| IsSet | Checks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject. |
| SetCurrentValue (2 overloads) | Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject. |
| SetValue (3 overloads) | Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject. |
| VerifyAccess | Checks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject. |
Properties
| Name | Description |
|---|---|
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Fill | Gets or sets the fill brush for the band. |
| FontSize | Gets or sets the font size used for annotation text or labels. Inherited from ChartAnnotation. |
| Foreground | Gets or sets the brush used for annotation text or labels. When unset, text-capable annotations fall back to their local defaults or to Avalonia.Controls.Charts.ChartAnnotation.Stroke where appropriate. Inherited from ChartAnnotation. |
| FromValue | Gets or sets the start value of the band in axis space. Horizontal bands use vertical-axis values; vertical bands use horizontal-axis values. |
| IsBandAnnotation | Gets whether this annotation is a band annotation. Used by the rendering pipeline to distinguish bands from line/text annotations without requiring a cross-assembly type check. |
| IsVisible | Gets or sets whether this annotation is visible. Inherited from ChartAnnotation. |
| Item | Inherited from AvaloniaObject. |
| Label | Gets or sets the label text displayed in the band. Avalonia.Controls.Charts.ChartAnnotation.Foreground controls label color and falls back to Avalonia.Controls.Charts.ChartAnnotation.Stroke when unset. |
| Opacity | Gets or sets the opacity applied to the entire annotation. Inherited from ChartAnnotation. |
| Orientation | Gets or sets the orientation (Horizontal or Vertical). |
| Stroke | Gets or sets the stroke brush for annotation geometry. Text-based annotations can also use this as an outline brush. Inherited from ChartAnnotation. |
| StrokeThickness | Gets or sets the stroke thickness for annotation geometry or text outlines. Inherited from ChartAnnotation. |
| ToValue | Gets or sets the end value of the band in axis space. |
Fill Property
Gets or sets the fill brush for the band.
public Avalonia.Media.IBrush Fill { get; set; }
FromValue Property
Gets or sets the start value of the band in axis space. Horizontal bands use vertical-axis values; vertical bands use horizontal-axis values.
public double FromValue { get; set; }
IsBandAnnotation Property
Gets whether this annotation is a band annotation. Used by the rendering pipeline to distinguish bands from line/text annotations without requiring a cross-assembly type check.
public bool IsBandAnnotation { get; set; }
Label Property
Gets or sets the label text displayed in the band. Avalonia.Controls.Charts.ChartAnnotation.Foreground controls label color and falls back to Avalonia.Controls.Charts.ChartAnnotation.Stroke when unset.
public string Label { get; set; }
Orientation Property
Gets or sets the orientation (Horizontal or Vertical).
public Avalonia.Layout.Orientation Orientation { get; set; }
ToValue Property
Gets or sets the end value of the band in axis space.
public double ToValue { get; set; }
Fields
FillProperty Field
Identifies the Avalonia.Controls.Charts.BandAnnotation.Fill Avalonia property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> FillProperty
FromValueProperty Field
Identifies the Avalonia.Controls.Charts.BandAnnotation.FromValue Avalonia property.
public Avalonia.StyledProperty<double> FromValueProperty
LabelProperty Field
Identifies the Avalonia.Controls.Charts.BandAnnotation.Label Avalonia property.
public Avalonia.StyledProperty<string> LabelProperty
OrientationProperty Field
Identifies the Avalonia.Controls.Charts.BandAnnotation.Orientation Avalonia property.
public Avalonia.StyledProperty<Avalonia.Layout.Orientation> OrientationProperty
ToValueProperty Field
Identifies the Avalonia.Controls.Charts.BandAnnotation.ToValue Avalonia property.
public Avalonia.StyledProperty<double> ToValueProperty
Events
| Name | Description |
|---|---|
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |