Project

ChartForgeX

Render deterministic charts, dashboards, topology, hierarchy, and report visuals directly from .NET.

Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

ChartAnnotation

Namespace ChartForgeX.Core
Assembly ChartForgeX
Modifiers sealed

Represents a static line or band annotation on a chart.

Inheritance

  • Object
  • ChartAnnotation

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

public ChartAnnotation(ChartAnnotationKind kind, Double value, Double? endValue, String label, ChartColor color, Double opacity, Boolean showLabel = true) #

Initializes a new instance of the ChartAnnotation class.

Parameters

kind ChartForgeX.Core.ChartAnnotationKind requiredposition: 0
The annotation kind.
value System.Double requiredposition: 1
The first annotation value.
endValue System.Double? requiredposition: 2
The second annotation value for bands.
label System.String requiredposition: 3
The annotation label.
color ChartForgeX.Primitives.ChartColor requiredposition: 4
The annotation color.
opacity System.Double requiredposition: 5
The annotation opacity used for band fills.
showLabel System.Boolean = true optionalposition: 6
Whether to paint the label. False retains its accessible and semantic content.

Properties

public ChartAnnotationKind Kind { get; } #

Gets the annotation kind.

public Double Value { get; } #

Gets the first annotation value.

public Double? EndValue { get; } #

Gets the second annotation value for band annotations.

public String Label { get; } #

Gets the annotation label.

public Boolean ShowLabel { get; } #

Gets whether the label is painted beside the annotation. A hidden label remains available in accessible descriptions and exported semantic metadata.

public ChartColor Color { get; } #

Gets the annotation color.

public Double Opacity { get; } #

Gets the annotation opacity used for band fills.