Command

New-ImageMetricCard

Module imageplayground

Inputs

None

Outputs

ChartForgeX.VisualBlocks.MetricCard

Creates a dashboard metric card.

Syntax

New-ImageMetricCard [-Caption <String>] [-Format <String>] [-Height <Int32>] [-Icon <VisualIcon>] [-Label] <String> [-MiniChart <Sparkline|Bars>] [-MiniColor <ChartColor>] [-MiniValues <Double[]>] [-NoCard] [-Status <Neutral|Positive|Warning|Negative|Info>] [-Theme <ChartTheme>] [-Transparent] [-Trend <String>] [-Unit <String>] [-Value] <Object> [-Width <Int32>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

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

Examples

Authored help example

Create a metric card with a sparkline

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

Parameters

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

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.