Project

ImagePlayground

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

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

API Reference

Command

New-ImageCanvasText

Namespace ImagePlayground
Inputs
None
Outputs
ChartForgeX.Composition.VisualCanvasTextLayer

Creates a positioned text layer for a visual canvas.

Remarks

Creates a positioned text layer for a visual canvas.

Examples

Authored help example

Create a social-preview heading

PS>


New-ImageCanvasText -X 72 -Y 70 -Width 900 -Text 'Release 3.3' -FontSize 56 -Color White -Emphasized
        

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-ImageCanvasText [-Alignment <Left|Center|Right>] [-Color <ChartColor>] [-Emphasized] [-FontSize <Double>] -Text <String> -Width <Double> -X <Double> -Y <Double> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Alignment TextAlignment optionalposition: namedpipeline: Falsevalues: 3
Text alignment within the layer width.
Possible values: Left, Center, Right
Color ChartColor optionalposition: namedpipeline: False
Text color.
Emphasized SwitchParameter optionalposition: namedpipeline: False
Use the emphasized text treatment.
FontSize Double optionalposition: namedpipeline: False
Font size in canvas design pixels.
Text String requiredposition: 3pipeline: False
Text to render.
Width Double requiredposition: 2pipeline: False
Text layout width.
X Double requiredposition: 0pipeline: False
Horizontal position in canvas design pixels.
Y Double requiredposition: 1pipeline: False
Vertical position in canvas design pixels.

Outputs

ChartForgeX.Composition.VisualCanvasTextLayer