Project

ChartForgeX

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

View on GitHub Visit Website Releases Get package
Stars 45
Forks 2
NuGet downloads 48,107
Release ChartForgeX-v1.7.0
Language: HTML Updated: 2026-09-02

API Reference

Class

MetricCard

Namespace ChartForgeX.VisualBlocks

A compact KPI or metric card visual block.

Inheritance

  • Object
  • MetricCard

Usage

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

Accepted by parameters

Methods

AddDetail(System.String arg1, System.Object arg2, ChartForgeX.VisualBlocks.VisualStatus arg3, System.String arg4) #

Adds a compact detail row to the card.

Parameters

arg1 System.String required
arg2 System.Object required
arg3 ChartForgeX.VisualBlocks.VisualStatus required
arg4 System.String required
Create() #

Creates a new metric card.

WithAction(System.String arg1, System.String arg2, System.String arg3) #

Sets optional footer action text rendered in the metric card.

Parameters

arg1 System.String required
arg2 System.String required
arg3 System.String required
WithBadgePlacement(ChartForgeX.VisualBlocks.MetricCardBadgePlacement arg1) #

Sets the badge placement when an icon or symbol is configured.

Parameters

arg1 ChartForgeX.VisualBlocks.MetricCardBadgePlacement required
WithCaption(System.String arg1) #

Sets optional supporting text.

Parameters

arg1 System.String required
WithIcon(ChartForgeX.VisualBlocks.VisualIcon arg1) #

Sets an optional built-in icon rendered as a badge.

Parameters

arg1 ChartForgeX.VisualBlocks.VisualIcon required
WithMetric(System.String arg1, System.Object arg2, System.String arg3, System.String arg4) #

Sets the primary metric label and value.

Parameters

arg1 System.String required
arg2 System.Object required
arg3 System.String required
arg4 System.String required
WithMicroVisualPlacement(ChartForgeX.VisualBlocks.MetricCardMicroVisualPlacement arg1) #

Sets where compact mini charts are rendered inside the metric card.

Parameters

arg1 ChartForgeX.VisualBlocks.MetricCardMicroVisualPlacement required
WithMicroVisualSurface(ChartForgeX.VisualBlocks.MetricCardMicroVisualSurface arg1) #

Sets the optional surface treatment for compact mini visuals.

Parameters

arg1 ChartForgeX.VisualBlocks.MetricCardMicroVisualSurface required
WithMiniBars(System.Collections.Generic.IEnumerable{System.Double} arg1, System.Nullable{System.Double} arg2, System.Nullable{System.Double} arg3, System.Nullable{ChartForgeX.Primitives.ChartColor} arg4, System.Nullable{ChartForgeX.Primitives.ChartColor} arg5, System.Nullable{System.Int32} arg6) #

Replaces compact bar values rendered inside the metric card.

Parameters

arg1 System.Collections.Generic.IEnumerable{System.Double} required
arg2 System.Nullable{System.Double} required
arg3 System.Nullable{System.Double} required
arg4 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg5 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg6 System.Nullable{System.Int32} required
WithMiniSparkline(System.Collections.Generic.IEnumerable{System.Double} arg1, System.Nullable{System.Double} arg2, System.Nullable{System.Double} arg3, System.Nullable{ChartForgeX.Primitives.ChartColor} arg4, System.Nullable{ChartForgeX.Primitives.ChartColor} arg5) #

Replaces compact sparkline values rendered inside the metric card.

Parameters

arg1 System.Collections.Generic.IEnumerable{System.Double} required
arg2 System.Nullable{System.Double} required
arg3 System.Nullable{System.Double} required
arg4 System.Nullable{ChartForgeX.Primitives.ChartColor} required
arg5 System.Nullable{ChartForgeX.Primitives.ChartColor} required
WithMiniSparklineStyle(ChartForgeX.VisualBlocks.MetricCardSparklineStyle arg1) #

Sets the mini sparkline presentation style.

Parameters

arg1 ChartForgeX.VisualBlocks.MetricCardSparklineStyle required
WithoutAction() #

Clears optional footer action text from the metric card.

WithoutMiniBars() #

Clears compact bar values from the metric card.

WithoutMiniSparkline() #

Clears compact sparkline values from the metric card.

WithSecondaryMiniSparkline(System.Collections.Generic.IEnumerable{System.Double} arg1, System.Nullable{ChartForgeX.Primitives.ChartColor} arg2) #

Replaces optional secondary sparkline values rendered with the primary sparkline.

Parameters

arg1 System.Collections.Generic.IEnumerable{System.Double} required
arg2 System.Nullable{ChartForgeX.Primitives.ChartColor} required
WithStatus(ChartForgeX.VisualBlocks.VisualStatus arg1) #

Sets the metric status.

Parameters

arg1 ChartForgeX.VisualBlocks.VisualStatus required
WithSymbol(System.String arg1) #

Sets an optional compact symbol rendered as a badge.

Parameters

arg1 System.String required
WithTrend(System.String arg1) #

Sets optional trend text.

Parameters

arg1 System.String required
WithUnit(System.String arg1) #

Sets an optional metric unit rendered beside the value.

Parameters

arg1 System.String required

Properties

MiniBars #

Gets compact bar values rendered inside the metric card.

MiniSparkline #

Gets compact sparkline values rendered inside the metric card.

SecondaryMiniSparkline #

Gets optional secondary sparkline values rendered beside the primary sparkline.

Details #

Gets compact supporting detail rows rendered inside the card.

Label #

Gets or sets the metric label.

Value #

Gets or sets the metric value.

Unit #

Gets or sets an optional metric unit rendered beside the value.

Caption #

Gets or sets optional supporting text.

Trend #

Gets or sets optional trend text.

Symbol #

Gets or sets an optional compact symbol rendered as a badge.

ActionLabel #

Gets or sets optional footer action text.

ActionSymbol #

Gets or sets optional footer action symbol.

ActionUrl #

Gets or sets an optional URL for the footer action in SVG/HTML outputs.

MiniBarHighlightIndex #

Gets or sets the zero-based mini bar to emphasize. When unset, the last mini bar is emphasized.

MiniBarMinimum #

Gets or sets the optional lower bound used for mini bar scaling.

MiniBarMaximum #

Gets or sets the optional upper bound used for mini bar scaling.

MiniSparklineMinimum #

Gets or sets the optional lower bound used for mini sparkline scaling.

MiniSparklineMaximum #

Gets or sets the optional upper bound used for mini sparkline scaling.

MiniBarColor #

Gets or sets the optional color for the emphasized mini bar.

MiniBarMutedColor #

Gets or sets the optional color for non-emphasized mini bars.

MiniSparklineColor #

Gets or sets the optional stroke color for the mini sparkline.

MiniSparklineFillColor #

Gets or sets the optional fill color under the mini sparkline.

SecondaryMiniSparklineColor #

Gets or sets the optional stroke color for the secondary mini sparkline.

MiniSparklineStyle #

Gets or sets the mini sparkline presentation style.

Icon #

Gets or sets an optional built-in icon rendered as a badge.

Status #

Gets or sets the metric status.

BadgePlacement #

Gets or sets the badge placement when an icon or symbol is configured.

MicroVisualPlacement #

Gets or sets where compact mini charts are rendered inside the metric card.

MicroVisualSurface #

Gets or sets the optional surface treatment for the mini visual.

AccessibleName #

Gets a concise accessibility label.