Command
New-ImageMetricCard
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 SetsDescription
The returned ChartForgeX block can be composed by New-ImageVisualGrid or New-ImageVisualStory.
Examples
Create a metric card with a sparkline
New-ImageMetricCard -Label 'Requests' -Value 12840 -Trend '+12%' -Status Positive -MiniValues 8200,9400,10100,12840Parameters
- -Caption String
- Optional supporting caption.
- -Format String
- Optional numeric or date format string.
- -Height Int32
- Card height in pixels.
- -Icon VisualIcon
- Built-in metric icon.
- Possible values:
ForkKnife,Flame,Lightning,Droplet,Runner,Bicycle,Person - -Label String
- Metric label.
- -MiniChart String
- Mini chart kind.
- Possible values:
Sparkline,Bars - -MiniColor ChartColor
- Optional mini chart color.
- -MiniValues Double[]
- Values used by the optional mini chart.
- -NoCard SwitchParameter
- Hide the card surface.
- -Status VisualStatus
- Semantic metric status.
- Possible values:
Neutral,Positive,Warning,Negative,Info - -Theme ChartTheme
- ChartForgeX theme.
- Possible values:
Default,Dark,Light,Colorblind,Aurora,Editorial,Candy,PeopleInfographic,Terminal,TransparentOverlayDark,Minimal,DashboardLight,SaasDashboardLight,RestaurantDashboardLight - -Transparent SwitchParameter
- Use a transparent card background.
- -Trend String
- Optional trend text.
- -Unit String
- Optional unit displayed beside the value.
- -Value Object
- Metric value.
- -Width Int32
- 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.