Skip to content
ChartForgeX
Command

New-ImageCanvasText

Module imageplayground
Inputs
None
Outputs
ChartForgeX.Composition.VisualCanvasTextLayer

Creates a positioned text layer for a visual canvas.

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

Examples

Authored help example

Create a social-preview heading

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

Parameters

-Alignment TextAlignment optional
Text alignment within the layer width.
Possible values: Left, Center, Right
-Color ChartColor optional
Explicit text color. Omit this parameter to follow the canvas foreground; explicitly supplied white, transparent, or custom colors are retained.
-Emphasized SwitchParameter optional
Use the emphasized text treatment.
-FontSize Double optional
Font size in canvas design pixels.
-Text String requiredposition: 3
Text to render.
-Width Double requiredposition: 2
Text layout width.
-X Double requiredposition: 0
Horizontal position in canvas design pixels.
-Y Double requiredposition: 1
Vertical position in canvas design pixels.

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.