Project

ImagePlayground

Automate image processing, codes, metadata, charts, topology, and visual stories from PowerShell.

View on GitHub Releases Get package
Stars 100
Forks 7
Total downloads 712,347
Release ImagePlayground-PowerShellModule.v3.2.7
Language: C# Updated: 2026-08-25

API Reference

Command

New-ImageMetricCard

Namespace ImagePlayground
Inputs
None
Outputs
ChartForgeX.VisualBlocks.MetricCard

Creates a dashboard metric card.

Remarks

The returned ChartForgeX block can be composed by New-ImageVisualGrid or New-ImageVisualStory.

Examples

Authored help example

Create a metric card with a sparkline

PS>


New-ImageMetricCard -Label 'Requests' -Value 12840 -Trend '+12%' -Status Positive -MiniValues 8200,9400,10100,12840

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-ImageMetricCard [-Caption <String>] [-Format <String>] [-Height <Int32>] [-Icon <ForkKnife>] -Label <String> [-MiniChart <Sparkline|Bars>] [-MiniColor <ChartColor>] [-MiniValues <Double[]>] [-NoCard] [-Status <Neutral|Positive|Warning|Negative|Info>] [-Theme <Default>] [-Transparent] [-Trend <String>] [-Unit <String>] -Value <Object> [-Width <Int32>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Caption String optionalposition: namedpipeline: False
Optional supporting caption.
Format String optionalposition: namedpipeline: False
Optional numeric or date format string.
Height Int32 optionalposition: namedpipeline: False
Card height in pixels.
Icon VisualIcon optionalposition: namedpipeline: Falsevalues: 7
Built-in metric icon.
Possible values: ForkKnife, Flame, Lightning, Droplet, Runner, Bicycle, Person
Label String requiredposition: 0pipeline: False
Metric label.
MiniChart String optionalposition: namedpipeline: Falsevalues: 2
Mini chart kind.
Possible values: Sparkline, Bars
MiniColor ChartColor optionalposition: namedpipeline: False
Optional mini chart color.
MiniValues Double[] optionalposition: namedpipeline: False
Values used by the optional mini chart.
NoCard SwitchParameter optionalposition: namedpipeline: False
Hide the card surface.
Status VisualStatus optionalposition: namedpipeline: Falsevalues: 5
Semantic metric status.
Possible values: Neutral, Positive, Warning, Negative, Info
Theme ChartTheme optionalposition: namedpipeline: Falsevalues: 14
ChartForgeX theme.
Possible values: Default, Dark, Light, Colorblind, Aurora, Editorial, Candy, PeopleInfographic, Terminal, TransparentOverlayDark, Minimal, DashboardLight, SaasDashboardLight, RestaurantDashboardLight
Transparent SwitchParameter optionalposition: namedpipeline: False
Use a transparent card background.
Trend String optionalposition: namedpipeline: False
Optional trend text.
Unit String optionalposition: namedpipeline: False
Optional unit displayed beside the value.
Value Object requiredposition: 1pipeline: False
Metric value.
Width Int32 optionalposition: namedpipeline: False
Card width in pixels.

Outputs

ChartForgeX.VisualBlocks.MetricCard