Command
New-ImageCanvas
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]
[-Title <String>]
[-Width <Int32>]
[<CommonParameters>]#Parameter set:
DefinitionNew-ImageCanvas
[-Backdrop <Transparent| Plain| TechHorizon>]
[-BackgroundBottom <ChartColor>]
[-BackgroundTop <ChartColor>]
-FilePath <String>
[-Height <Int32>]
-Layer <VisualCanvasLayer[]>
[-PassThru]
[-PngOutputScale <Int32>]
[-Preset <Custom| SocialPreview| DesktopWallpaper>]
[-Show]
[-Title <String>]
[-Width <Int32>]
[<CommonParameters>]#Parameter set:
LayerNew-ImageCanvas
[-Backdrop <Transparent| Plain| TechHorizon>]
[-BackgroundBottom <ChartColor>]
[-BackgroundTop <ChartColor>]
-Canvas <VisualCanvas>
-FilePath <String>
[-PassThru]
[-PngOutputScale <Int32>]
[-Show]
[-Title <String>]
[<CommonParameters>]#Parameter set:
CanvasDescription
Layer commands emit native ChartForgeX layers; ImagePlayground only binds PowerShell inputs and selects the output format.
Examples
Create a social preview
New-ImageCanvas -Preset SocialPreview -Title 'ChartForgeX 1.3' -Backdrop TechHorizon -LayerDefinition { New-ImageCanvasText -X 72 -Y 72 -Width 1000 -Text 'ChartForgeX 1.3' -FontSize 58 -Color White -Emphasized; New-ImageCanvasInfoTile -X 72 -Y 190 -Width 360 -Height 150 -Icon SVG -Label 'Renderer' -Value 'Dependency-free' } -FilePath preview.pngParameters
- -Backdrop VisualCanvasBackdropStyle
- Built-in canvas backdrop.
- Possible values:
Transparent,Plain,TechHorizon - -BackgroundBottom ChartColor
- Bottom background color for a vertical gradient.
- -BackgroundTop ChartColor
- Top or solid background color.
- -FilePath String
- Output image path.
- -Height Int32
- Custom canvas height.
- -LayerDefinition ScriptBlock
- Script block that emits visual canvas layers.
- -PassThru SwitchParameter
- Write the configured ChartForgeX canvas to the pipeline.
- -PngOutputScale Int32
- PNG output pixel multiplier.
- -Preset ImageCanvasPreset
- Built-in canvas size preset.
- Possible values:
Custom,SocialPreview,DesktopWallpaper - -Show SwitchParameter
- Open the generated canvas.
- -Title String
- Accessibility title for SVG output.
- -Width Int32
- Custom canvas width.
- -Layer VisualCanvasLayer[]
- Canvas layers supplied directly or through the pipeline.
- -Canvas VisualCanvas
- 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.