Skip to content
ChartForgeX
Command

New-ImageVisualWatermark

Module imageplayground
Inputs
None
Outputs
ChartForgeX.VisualArtifacts.VisualWatermark

Creates a deterministic text or image watermark for ChartForgeX visual artifacts.

Syntax

New-ImageVisualWatermark [-Anchor <VisualCanvasAnchor>] [-Color <ChartColor>] [-FontSize <Double>] [-OffsetX <Double>] [-OffsetY <Double>] [-Opacity <Double>] [-Padding <Double>] [-Repeat] [-RepeatSpacingX <Double>] [-RepeatSpacingY <Double>] [-RotationDegrees <Double>] [-Scale <Double>] [-Text] <String> [<CommonParameters>]
#
Parameter set: Text
New-ImageVisualWatermark [-Anchor <VisualCanvasAnchor>] [-ImagePath] <String> [-OffsetX <Double>] [-OffsetY <Double>] [-Opacity <Double>] [-Padding <Double>] [-Repeat] [-RepeatSpacingX <Double>] [-RepeatSpacingY <Double>] [-RotationDegrees <Double>] [-Scale <Double>] [<CommonParameters>]
#
Parameter set: Image

Examples

Authored help example

Create a centered confidential watermark

$mark = New-ImageVisualWatermark -Text CONFIDENTIAL -Anchor Center -RotationDegrees -28 -Opacity 0.15

The watermark can be passed to Export-ImageVisualArtifact or New-ImageTopology.

Parameters

-Anchor VisualCanvasAnchor optional
Watermark anchor on the artifact canvas.
Possible values: TopLeft, TopCenter, TopRight, MiddleLeft, Center, MiddleRight, BottomLeft, BottomCenter, BottomRight
-Color ChartColor optionalsets: Text
Text color.
-FontSize Double optionalsets: Text
Base text size in pixels.
-OffsetX Double optional
Horizontal offset from the selected anchor.
-OffsetY Double optional
Vertical offset from the selected anchor.
-Opacity Double optional
Watermark opacity from zero to one.
-Padding Double optional
Inset from anchored canvas edges.
-Repeat SwitchParameter optional
Render repeated watermark tiles across the canvas.
-RepeatSpacingX Double optional
Horizontal spacing between repeated watermark anchors.
-RepeatSpacingY Double optional
Vertical spacing between repeated watermark anchors.
-RotationDegrees Double optional
Clockwise watermark rotation in degrees.
-Scale Double optional
Positive watermark scale.
-Text String requiredposition: 0sets: Text
Watermark text.
-ImagePath String requiredposition: 0sets: Image
Raster watermark image path.

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.