Skip to content
ChartForgeX

API Reference

Class

RadialMetricCard

Edit on GitHub
Namespace ChartForgeX.VisualBlocks
Assembly ChartForgeX.Visuals
Source VisualFactModels.cs:369
Base FactualVisualBlock<RadialMetricCard>
Implements
IVisualBlock IStaticVisualSource IFactualVisualPixels
Modifiers sealed

A KPI card with one or more radial progress layers around a central metric.

Inheritance

  • FactualVisualBlock<RadialMetricCard>
  • RadialMetricCard

Usage

Explore 16 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 16

Constructors

public RadialMetricCard() #
VisualFactModels.cs:369

Methods

AddLayer 2 overloads
public RadialMetricCard AddLayer(ChartRadialLayer layer) #
VisualFactModels.cs:425
Returns: RadialMetricCard

Adds one radial layer.

Parameters

layer ChartForgeX.Core.ChartRadialLayer requiredposition: 0
public RadialMetricCard AddLayer(String name, Double value, Double minimum = 0, Double maximum = 100, ChartColor? color = null, Func<ChartRadialLayer, ChartRadialLayer>? configure = null) #
VisualFactModels.cs:431
Returns: RadialMetricCard

Adds one radial layer and optionally configures its geometry and styling.

Parameters

name System.String requiredposition: 0
value System.Double requiredposition: 1
minimum System.Double = 0 optionalposition: 2
maximum System.Double = 100 optionalposition: 3
color ChartForgeX.Primitives.ChartColor? = null optionalposition: 4
configure System.Func<ChartForgeX.Core.ChartRadialLayer, ChartForgeX.Core.ChartRadialLayer>? = null optionalposition: 5
public static RadialMetricCard Create() #
VisualFactModels.cs:396
Returns: RadialMetricCard

Creates a new radial metric card.

public RadialMetricCard WithIcon(VisualIcon icon) #
VisualFactModels.cs:406
Returns: RadialMetricCard

Sets an optional built-in icon rendered above the center metric.

Parameters

icon ChartForgeX.VisualBlocks.VisualIcon requiredposition: 0
WithLayers 2 overloads
public RadialMetricCard WithLayers(IEnumerable<ChartRadialLayer> layers) #
VisualFactModels.cs:410
Returns: RadialMetricCard

Replaces all radial layers.

Parameters

layers System.Collections.Generic.IEnumerable<ChartForgeX.Core.ChartRadialLayer> requiredposition: 0
public RadialMetricCard WithLayers(Func<ChartRadialLayers, ChartRadialLayers> configure) #
VisualFactModels.cs:418
Returns: RadialMetricCard

Replaces all radial layers using a fluent layer collection builder.

Parameters

configure System.Func<ChartForgeX.Core.ChartRadialLayers, ChartForgeX.Core.ChartRadialLayers> requiredposition: 0
public RadialMetricCard WithMetric(String label, Object? value, String? format = null) #
VisualFactModels.cs:400
Returns: RadialMetricCard

Sets the primary center metric label and value.

Parameters

label System.String requiredposition: 0
value System.Object? requiredposition: 1
format System.String? = null optionalposition: 2

Properties

public IReadOnlyList<ChartRadialLayer> Layers { get; } #
VisualFactModels.cs:375

Gets radial progress layers.

public String Label { get; set; } #
VisualFactModels.cs:378

Gets or sets the center label.

public String Value { get; set; } #
VisualFactModels.cs:381

Gets or sets the center value.

public VisualIcon Icon { get; set; } #
VisualFactModels.cs:385

Gets or sets an optional built-in icon rendered above the center metric.

public override String AccessibleName { get; } #
VisualFactModels.cs:393

Gets a concise accessibility label.