Skip to content
ChartForgeX
Command

New-ImageCanvas

Module imageplayground
Inputs
ChartForgeX.Composition.VisualCanvas ChartForgeX.Composition.VisualCanvasLayer[]
Outputs
ChartForgeX.Composition.VisualCanvas

Creates a fixed-size visual canvas for social images, wallpapers, report covers, and announcement cards.

Syntax

New-ImageCanvas [-Backdrop <Transparent|Plain|TechHorizon>] [-BackgroundBottom <ChartColor>] [-BackgroundTop <ChartColor>] -FilePath <String> [-Height <Int32>] [-LayerDefinition] <ScriptBlock> [-PassThru] [-PngOutputScale <Int32>] [-Preset <Custom|SocialPreview|DesktopWallpaper>] [-Show] [-Theme <Light|Dark>] [-Title <String>] [-Width <Int32>] [<CommonParameters>]
#
Parameter set: Definition
New-ImageCanvas [-Backdrop <Transparent|Plain|TechHorizon>] [-BackgroundBottom <ChartColor>] [-BackgroundTop <ChartColor>] -FilePath <String> [-Height <Int32>] -Layer <VisualCanvasLayer[]> [-PassThru] [-PngOutputScale <Int32>] [-Preset <Custom|SocialPreview|DesktopWallpaper>] [-Show] [-Theme <Light|Dark>] [-Title <String>] [-Width <Int32>] [<CommonParameters>]
#
Parameter set: Layer
New-ImageCanvas [-Backdrop <Transparent|Plain|TechHorizon>] [-BackgroundBottom <ChartColor>] [-BackgroundTop <ChartColor>] -Canvas <VisualCanvas> -FilePath <String> [-PassThru] [-PngOutputScale <Int32>] [-Show] [-Theme <Light|Dark>] [-Title <String>] [<CommonParameters>]
#
Parameter set: Canvas

Description

Layer commands emit native ChartForgeX layers; ImagePlayground only binds PowerShell inputs and selects the output format.

Examples

Authored help example

Create a social preview

New-ImageCanvas -Preset SocialPreview -Theme Dark -Title 'Service health' -LayerDefinition { New-ImageCanvasText -X 72 -Y 72 -Width 1000 -Text 'Service health' -FontSize 58 -Color White -Emphasized; New-ImageCanvasInfoTile -X 72 -Y 220 -Width 360 -Height 176 -Icon API -Label 'Requests' -Value '12,840' -Detail '+12% this week' } -FilePath preview.png

Parameters

-Backdrop VisualCanvasBackdropStyle optional
Built-in canvas backdrop.
Possible values: Transparent, Plain, TechHorizon
-BackgroundBottom ChartColor optional
Bottom background color for a vertical gradient.
-BackgroundTop ChartColor optional
Top or solid background color.
-FilePath String required
Output image path.
-Height Int32 optionalsets: Definition, Layer
Custom canvas height.
-LayerDefinition ScriptBlock requiredposition: 0sets: Definition
Script block that emits visual canvas layers.
-PassThru SwitchParameter optional
Write the configured ChartForgeX canvas to the pipeline.
-PngOutputScale Int32 optional
PNG output pixel multiplier.
-Preset ImageCanvasPreset optionalsets: Definition, Layer
Built-in canvas size preset.
Possible values: Custom, SocialPreview, DesktopWallpaper
-Show SwitchParameter optional
Open the generated canvas.
-Theme String optional
Canonical light or dark canvas theme. An existing canvas keeps its theme unless this parameter is supplied.
Possible values: Light, Dark
-Title String optional
Accessibility title for SVG output.
-Width Int32 optionalsets: Definition, Layer
Custom canvas width.
-Layer VisualCanvasLayer[] requiredpipeline: True (ByValue)sets: Layer
Canvas layers supplied directly or through the pipeline.
-Canvas VisualCanvas requiredpipeline: True (ByValue)sets: Canvas
Existing ChartForgeX visual canvas to render.

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.