ChartAnnotation Class
Definition
Base class for Cartesian chart annotations such as reference lines, bands, and text labels. Annotation coordinates are expressed in axis space and are converted to pixels by the shared Cartesian annotation rendering pipeline.
public class ChartAnnotation
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 |
|---|---|
| FontSize | Gets or sets the font size used for annotation text or labels. |
| 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. |
| 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. |
| Opacity | Gets or sets the opacity applied to the entire annotation. |
| Stroke | Gets or sets the stroke brush for annotation geometry. Text-based annotations can also use this as an outline brush. |
| StrokeThickness | Gets or sets the stroke thickness for annotation geometry or text outlines. |
| Dispatcher | Returns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject. |
| Item | Inherited from AvaloniaObject. |
FontSize Property
Gets or sets the font size used for annotation text or labels.
public double FontSize { get; set; }
Foreground Property
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.
public Avalonia.Media.IBrush Foreground { 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; }
IsVisible Property
Gets or sets whether this annotation is visible.
public bool IsVisible { get; set; }
Opacity Property
Gets or sets the opacity applied to the entire annotation.
public double Opacity { get; set; }
Stroke Property
Gets or sets the stroke brush for annotation geometry. Text-based annotations can also use this as an outline brush.
public Avalonia.Media.IBrush Stroke { get; set; }
StrokeThickness Property
Gets or sets the stroke thickness for annotation geometry or text outlines.
public double StrokeThickness { get; set; }
Fields
| Name | Description |
|---|---|
| FontSizeProperty | Identifies the Avalonia.Controls.Charts.ChartAnnotation.FontSize Avalonia property. |
| ForegroundProperty | Identifies the Avalonia.Controls.Charts.ChartAnnotation.Foreground Avalonia property. |
| IsVisibleProperty | Identifies the Avalonia.Controls.Charts.ChartAnnotation.IsVisible Avalonia property. |
| OpacityProperty | Identifies the Avalonia.Controls.Charts.ChartAnnotation.Opacity Avalonia property. |
| StrokeProperty | Identifies the Avalonia.Controls.Charts.ChartAnnotation.Stroke Avalonia property. |
| StrokeThicknessProperty | Identifies the Avalonia.Controls.Charts.ChartAnnotation.StrokeThickness Avalonia property. |
FontSizeProperty Field
Identifies the Avalonia.Controls.Charts.ChartAnnotation.FontSize Avalonia property.
public Avalonia.StyledProperty<double> FontSizeProperty
ForegroundProperty Field
Identifies the Avalonia.Controls.Charts.ChartAnnotation.Foreground Avalonia property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> ForegroundProperty
IsVisibleProperty Field
Identifies the Avalonia.Controls.Charts.ChartAnnotation.IsVisible Avalonia property.
public Avalonia.StyledProperty<bool> IsVisibleProperty
OpacityProperty Field
Identifies the Avalonia.Controls.Charts.ChartAnnotation.Opacity Avalonia property.
public Avalonia.StyledProperty<double> OpacityProperty
StrokeProperty Field
Identifies the Avalonia.Controls.Charts.ChartAnnotation.Stroke Avalonia property.
public Avalonia.StyledProperty<Avalonia.Media.IBrush> StrokeProperty
StrokeThicknessProperty Field
Identifies the Avalonia.Controls.Charts.ChartAnnotation.StrokeThickness Avalonia property.
public Avalonia.StyledProperty<double> StrokeThicknessProperty
Events
| Name | Description |
|---|---|
| PropertyChanged | Raised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject. |