Project

ImagePlayground

Automate image processing, codes, metadata, charts, topology, and visual stories from PowerShell.

View on GitHub Releases Get package
Stars 100
Forks 7
Total downloads 712,347
Release ImagePlayground-PowerShellModule.v3.2.7
Language: C# Updated: 2026-08-25

API Reference

Command

New-ImageCanvas

Namespace 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.

Remarks

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

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

Examples

Authored help example

Create a social preview

PS>


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.png

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-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: Definition

Parameters

Backdrop VisualCanvasBackdropStyle optionalposition: namedpipeline: Falsevalues: 3
Built-in canvas backdrop.
Possible values: Transparent, Plain, TechHorizon
BackgroundBottom ChartColor optionalposition: namedpipeline: False
Bottom background color for a vertical gradient.
BackgroundTop ChartColor optionalposition: namedpipeline: False
Top or solid background color.
FilePath String requiredposition: namedpipeline: False
Output image path.
Height Int32 optionalposition: namedpipeline: False
Custom canvas height.
LayerDefinition ScriptBlock requiredposition: 0pipeline: False
Script block that emits visual canvas layers.
PassThru SwitchParameter optionalposition: namedpipeline: False
Write the configured ChartForgeX canvas to the pipeline.
PngOutputScale Int32 optionalposition: namedpipeline: False
PNG output pixel multiplier.
Preset ImageCanvasPreset optionalposition: namedpipeline: Falsevalues: 3
Built-in canvas size preset.
Possible values: Custom, SocialPreview, DesktopWallpaper
Show SwitchParameter optionalposition: namedpipeline: False
Open the generated canvas.
Title String optionalposition: namedpipeline: False
Accessibility title for SVG output.
Width Int32 optionalposition: namedpipeline: False
Custom canvas width.

Outputs

ChartForgeX.Composition.VisualCanvas

New-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: Layer

Parameters

Backdrop VisualCanvasBackdropStyle optionalposition: namedpipeline: Falsevalues: 3
Built-in canvas backdrop.
Possible values: Transparent, Plain, TechHorizon
BackgroundBottom ChartColor optionalposition: namedpipeline: False
Bottom background color for a vertical gradient.
BackgroundTop ChartColor optionalposition: namedpipeline: False
Top or solid background color.
FilePath String requiredposition: namedpipeline: False
Output image path.
Height Int32 optionalposition: namedpipeline: False
Custom canvas height.
Layer VisualCanvasLayer[] requiredposition: namedpipeline: True (ByValue)
Canvas layers supplied directly or through the pipeline.
PassThru SwitchParameter optionalposition: namedpipeline: False
Write the configured ChartForgeX canvas to the pipeline.
PngOutputScale Int32 optionalposition: namedpipeline: False
PNG output pixel multiplier.
Preset ImageCanvasPreset optionalposition: namedpipeline: Falsevalues: 3
Built-in canvas size preset.
Possible values: Custom, SocialPreview, DesktopWallpaper
Show SwitchParameter optionalposition: namedpipeline: False
Open the generated canvas.
Title String optionalposition: namedpipeline: False
Accessibility title for SVG output.
Width Int32 optionalposition: namedpipeline: False
Custom canvas width.

Outputs

ChartForgeX.Composition.VisualCanvas

New-ImageCanvas [-Backdrop <Transparent|Plain|TechHorizon>] [-BackgroundBottom <ChartColor>] [-BackgroundTop <ChartColor>] -Canvas <VisualCanvas> -FilePath <String> [-PassThru] [-PngOutputScale <Int32>] [-Show] [-Title <String>] [<CommonParameters>]
#
Parameter set: Canvas

Parameters

Backdrop VisualCanvasBackdropStyle optionalposition: namedpipeline: Falsevalues: 3
Built-in canvas backdrop.
Possible values: Transparent, Plain, TechHorizon
BackgroundBottom ChartColor optionalposition: namedpipeline: False
Bottom background color for a vertical gradient.
BackgroundTop ChartColor optionalposition: namedpipeline: False
Top or solid background color.
Canvas VisualCanvas requiredposition: namedpipeline: True (ByValue)
Existing ChartForgeX visual canvas to render.
FilePath String requiredposition: namedpipeline: False
Output image path.
PassThru SwitchParameter optionalposition: namedpipeline: False
Write the configured ChartForgeX canvas to the pipeline.
PngOutputScale Int32 optionalposition: namedpipeline: False
PNG output pixel multiplier.
Show SwitchParameter optionalposition: namedpipeline: False
Open the generated canvas.
Title String optionalposition: namedpipeline: False
Accessibility title for SVG output.

Outputs

ChartForgeX.Composition.VisualCanvas