API Reference
Command
New-BGInfoVisualCanvas
Creates a BGInfo visual canvas definition backed by ChartForgeX.
Remarks
Visual canvases render a reusable HUD-style overlay with a central title, side information boxes, and an optional feature strip.
Examples
EXAMPLE 1
$tiles = @(
New-BGInfoVisualCanvasTile -Side Left -IconKind Computer -SurfaceStyle Raised -Label HOSTNAME -Value '{{HostName}}'
New-BGInfoVisualCanvasTile -Side Right -IconKind Cpu -SurfaceStyle Raised -Label 'CPU LOAD' -Value '31% active' -MiniChartKind Area -MiniChartValues 22,28,25,36,31 -MiniChartMaximum 100
)
New-BGInfo -Target File {
New-BGInfoVisualCanvas -Title 'PowerBGInfo' -Subtitle 'High-contrast information boxes' -Tile $tiles -TileGlassTop '#FFF7EDD9' -TileGlassBottom '#DBEAFECC' -TileValueColor '#0F172AFF'
} -FilePath .\Examples\Samples\TapC-Evotec-2560x1080.jpg -ConfigurationDirectory .\Examples\Output -OutputFileName 'PowerBGInfo.VisualCanvas.ContrastBox.jpg' -WallpaperFit Fill
EXAMPLE 2
New-BGInfoVisualCanvas -Title 'PowerBGInfo' -Feature $features -FeatureAnchor BottomRight -FeatureWidth 610 -FeatureOffsetX 165 -FeatureOffsetY 120
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-BGInfoVisualCanvas [-Accent <Object>] [-BackgroundBottom <Object>] [-BackgroundTop <Object>] [-CenterTileOffsetX <Int32>] [-CenterTileOffsetY <Int32>] [-CenterTileWidth <Int32>] [-Feature <BgInfoVisualCanvasFeature[]>] [-FeatureAnchor <TopLeft>] [-FeatureHeight <Int32>] [-FeatureOffsetX <Int32>] [-FeatureOffsetY <Int32>] [-FeatureWidth <Int32>] [-Height <Int32>] [-HeroBadgeBottom <Object>] [-HeroBadgeImageFit <Stretch|Contain|Cover|Center|Tile>] [-HeroBadgeImageOpacity <Double>] [-HeroBadgeImagePadding <Int32>] [-HeroBadgeImagePath <String>] [-HeroBadgeText <String>] [-HeroBadgeTextColor <Object>] [-HeroBadgeTop <Object>] [-LayoutPreset <Default|Compact|Comfortable|WideRails|Dense>] [-LeftTileOffsetX <Int32>] [-LeftTileOffsetY <Int32>] [-LeftTileWidth <Int32>] [-NoHeroBadge] [-NoHeroContent] [-NoTechBackdrop] [-Opaque] [-PositionX <Int32>] [-PositionY <Int32>] [-RightTileOffsetX <Int32>] [-RightTileOffsetY <Int32>] [-RightTileWidth <Int32>] [-SecondaryAccent <Object>] [-Subtitle <String>] [-SubtitleColor <Object>] [-Template <PowerBgInfoHero>] [-Tile <BgInfoVisualCanvasTile[]>] [-TileDetailColor <Object>] [-TileGap <Int32>] [-TileGlassBottom <Object>] [-TileGlassTop <Object>] [-TileHeight <Int32>] [-TileLabelColor <Object>] [-TileProgressTrackColor <Object>] [-TileTextFitPolicy <Auto|SingleLineEllipsis|Wrap|ShrinkToFit|WrapThenShrink>] [-TileValueColor <Object>] [-TileWidth <Int32>] [-Title <String>] [-TitleAccentColor <Object>] [-TitleColor <Object>] [-Width <Int32>] [<CommonParameters>]Parameter set:
All Parameter SetsParameters
- Accent Object
- Primary accent color.
- BackgroundBottom Object
- Bottom background color.
- BackgroundTop Object
- Top background color.
- CenterTileOffsetX Int32
- Horizontal centered-lane offset in pixels. Positive values move the lane to the right.
- CenterTileOffsetY Int32
- Vertical centered-lane offset in pixels.
- CenterTileWidth Int32
- Default centered-lane tile width in pixels. Zero uses TileWidth or the template default.
- Feature BgInfoVisualCanvasFeature[]
- Feature strip item definitions.
- FeatureAnchor BgInfoTextPosition
- Optional feature-strip anchor. When omitted, the template keeps its default centered strip placement.
- Possible values:
TopLeft,TopCenter,TopRight,MiddleLeft,MiddleCenter,MiddleRight,BottomLeft,BottomCenter,BottomRight - FeatureHeight Int32
- Optional feature-strip height in pixels. Zero uses the template default height.
- FeatureOffsetX Int32
- Horizontal feature-strip offset. For right anchors, positive values inset from the right edge.
- FeatureOffsetY Int32
- Vertical feature-strip offset. For bottom anchors, positive values inset from the bottom edge.
- FeatureWidth Int32
- Optional feature-strip width in pixels. Zero uses the template default width.
- Height Int32
- Canvas height in pixels. Zero uses the target wallpaper height.
- HeroBadgeBottom Object
- Hero badge bottom fill color.
- HeroBadgeImageFit BgInfoImageFit
- How the hero badge image is fitted inside the badge.
- Possible values:
Stretch,Contain,Cover,Center,Tile - HeroBadgeImageOpacity Double
- Hero badge image opacity from zero to one.
- HeroBadgeImagePadding Int32
- Padding inside the hero badge image area.
- HeroBadgeImagePath String
- Optional image path rendered inside the central hero badge.
- HeroBadgeText String
- Text rendered in the central hero badge when no image is configured.
- HeroBadgeTextColor Object
- Hero badge symbol color.
- HeroBadgeTop Object
- Hero badge top fill color.
- LayoutPreset BgInfoVisualCanvasLayoutPreset
- Responsive side-rail sizing preset.
- Possible values:
Default,Compact,Comfortable,WideRails,Dense - LeftTileOffsetX Int32
- Horizontal left side-rail offset in pixels.
- LeftTileOffsetY Int32
- Vertical left side-rail offset in pixels.
- LeftTileWidth Int32
- Default left side-rail tile width in pixels. Zero uses TileWidth or the template default.
- NoHeroBadge SwitchParameter
- Hide the central hero badge while keeping the title, subtitle, tiles, and feature strip.
- NoHeroContent SwitchParameter
- Hide the central hero badge, title, and subtitle while keeping tiles and the feature strip.
- NoTechBackdrop SwitchParameter
- Disable the built-in technology backdrop.
- Opaque SwitchParameter
- Render a full ChartForgeX background instead of floating over the wallpaper.
- PositionX Int32
- Explicit X position on the generated wallpaper.
- PositionY Int32
- Explicit Y position on the generated wallpaper.
- RightTileOffsetX Int32
- Horizontal right side-rail inset in pixels.
- RightTileOffsetY Int32
- Vertical right side-rail offset in pixels.
- RightTileWidth Int32
- Default right side-rail tile width in pixels. Zero uses TileWidth or the template default.
- SecondaryAccent Object
- Secondary accent color for badge and backdrop highlights.
- Subtitle String
- Canvas subtitle text.
- SubtitleColor Object
- Subtitle text color.
- Template BgInfoVisualCanvasTemplate
- Visual canvas template.
- Possible values:
PowerBgInfoHero - Tile BgInfoVisualCanvasTile[]
- Tile lane definitions.
- TileDetailColor Object
- Tile detail text color.
- TileGap Int32
- Default vertical gap between tiles in pixels. Zero uses the template default gap.
- TileGlassBottom Object
- Glass tile bottom color.
- TileGlassTop Object
- Glass tile top color.
- TileHeight Int32
- Default tile height in pixels. Zero uses the template default height.
- TileLabelColor Object
- Tile label text color.
- TileProgressTrackColor Object
- Tile progress track color.
- TileTextFitPolicy BgInfoVisualCanvasTileTextFitPolicy
- Default tile text fitting policy.
- Possible values:
Auto,SingleLineEllipsis,Wrap,ShrinkToFit,WrapThenShrink - TileValueColor Object
- Tile value text color.
- TileWidth Int32
- Default tile width in pixels. Zero uses the template default width.
- Title String
- Canvas title or brand text.
- TitleAccentColor Object
- Accent hero title color.
- TitleColor Object
- Primary hero title color.
- Width Int32
- Canvas width in pixels. Zero uses the target wallpaper width.
Outputs
PowerBGInfo.BgInfoVisualCanvas