ChartLegendItemContext
ChartForgeX.Core
Describes one legend entry to ChartLegendOptions.ItemFormatter.
Inheritance
- object
- ChartLegendItemContext
Usage
Explore 2 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
- Property ChartLegendOptions.ItemFormatter
Accepted by parameters 1
- Method Chart.WithLegendFormatter
Methods
public string FormatValue(double value) #Formats a value with the chart's value format, as data labels and value axes do.
Parameters
- value double
- A finite value.
Returns
stringInherited Methods
Properties
public string Label { get; } #Gets the text the legend would show without a formatter.
public ChartSeries? Series { get; } #Gets the series the entry describes, or null for a custom item or a family key without one series.
public int SeriesIndex { get; } #Gets the zero-based index of ChartLegendItemContext.Series, or -1 when the entry has no series.
public int? PointIndex { get; } #Gets the zero-based point index when the entry describes one observation, such as a point legend or pie slice.
public ChartLegendItem? Item { get; } #Gets the custom item the entry shows, or null for a series entry.
public string? FormattedValue { get; } #Gets the value column text a part-to-whole legend already shows, or null.
public IReadOnlyList<double> Values { get; } #Gets the finite Y values of the entry: the series' values, or the one observation for a point entry. Empty when the series has no numeric points.
public double Total { get; } #Gets the sum of ChartLegendItemContext.Values.