New-BGInfoVisualCanvasTile

Namespace PowerBGInfo

Inputs

None

Outputs

PowerBGInfo.BgInfoVisualCanvasTile

Creates a BGInfo visual canvas tile definition.

Remarks

Tiles are the readable lane-based information boxes used by New-BGInfoVisualCanvas.

Examples

Authored help example

EXAMPLE 1


New-BGInfoVisualCanvasTile -Side Left -IconKind Computer -SurfaceStyle Raised -Label HOSTNAME -Value '{{HostName}}' -Detail 'production desktop' -Accent '#0F766EFF'

EXAMPLE 2


New-BGInfoVisualCanvasTile -Side Right -IconKind Cpu -SurfaceStyle Raised -Label 'CPU LOAD' -Value '31% active' -MiniChartKind Area -MiniChartValues 22,28,25,36,31 -MiniChartMaximum 100

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-BGInfoVisualCanvasTile [-Accent <Object>] [-Detail <String>] [-Height <Int32>] [-Icon <String>] [-IconKind <Text>] -Label <String> [-MiniChartKind <Sparkline|Area|Bars>] [-MiniChartMaximum <Double>] [-MiniChartValues <Double[]>] [-Progress <Double>] [-Side <Left|Right|Center>] [-SurfaceStyle <Glass|Outline|Raised>] [-TextFitPolicy <Auto|SingleLineEllipsis|Wrap|ShrinkToFit|WrapThenShrink>] -Value <String> [-Width <Int32>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Accent Object optionalposition: namedpipeline: False: Optional accent color.
Detail String optionalposition: namedpipeline: False: Optional detail text. Templates are resolved at render time.
Height Int32 optionalposition: namedpipeline: False: Optional tile height in pixels. Zero uses the visual canvas default or template default.
Icon String optionalposition: namedpipeline: False: Compact tile icon or symbol.
IconKind BgInfoVisualCanvasTileIconKind optionalposition: namedpipeline: Falsevalues: 11: Built-in icon to render instead of the Icon text.; Possible values: Text, Computer, Network, OperatingSystem, Cpu, Memory, User, Domain, Terminal, Storage, Shield
Label String requiredposition: namedpipeline: False: Tile label. Templates such as {{HostName}} are resolved at render time.
MiniChartKind BgInfoVisualCanvasTileMiniChartKind optionalposition: namedpipeline: Falsevalues: 3: Compact chart kind rendered inside the tile.; Possible values: Sparkline, Area, Bars
MiniChartMaximum Double optionalposition: namedpipeline: False: Optional compact chart maximum.
MiniChartValues Double[] optionalposition: namedpipeline: False: Compact chart values rendered inside the tile.
Progress Double optionalposition: namedpipeline: False: Optional progress value from zero to one.
Side BgInfoVisualCanvasSide optionalposition: namedpipeline: Falsealiases: Lanevalues: 3: Tile lane placement.; Possible values: Left, Right, Center
SurfaceStyle BgInfoVisualCanvasTileSurfaceStyle optionalposition: namedpipeline: Falsevalues: 3: Tile surface style.; Possible values: Glass, Outline, Raised
TextFitPolicy BgInfoVisualCanvasTileTextFitPolicy optionalposition: namedpipeline: Falsevalues: 5: Tile-specific text fitting policy. Auto inherits the visual canvas setting.; Possible values: Auto, SingleLineEllipsis, Wrap, ShrinkToFit, WrapThenShrink
Value String requiredposition: namedpipeline: False: Primary tile value. Templates such as {{HostName}} are resolved at render time.
Width Int32 optionalposition: namedpipeline: False: Optional tile width in pixels. Zero uses the visual canvas default or template default.

Outputs

PowerBGInfo.BgInfoVisualCanvasTile