API Reference
Command
New-ImageVisualWatermark
Creates a deterministic text or image watermark for ChartForgeX visual artifacts.
Remarks
Creates a deterministic text or image watermark for ChartForgeX visual artifacts.
Examples
Create a centered confidential watermark
PS>
$mark = New-ImageVisualWatermark -Text CONFIDENTIAL -Anchor Center -RotationDegrees -28 -Opacity 0.15
The watermark can be passed to Export-ImageVisualArtifact or New-ImageTopology.
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-ImageVisualWatermark [-Anchor <TopLeft>] [-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:
TextParameters
- Anchor VisualCanvasAnchor
- Watermark anchor on the artifact canvas.
- Possible values:
TopLeft,TopCenter,TopRight,MiddleLeft,Center,MiddleRight,BottomLeft,BottomCenter,BottomRight - Color ChartColor
- Text color.
- FontSize Double
- Base text size in pixels.
- OffsetX Double
- Horizontal offset from the selected anchor.
- OffsetY Double
- Vertical offset from the selected anchor.
- Opacity Double
- Watermark opacity from zero to one.
- Padding Double
- Inset from anchored canvas edges.
- Repeat SwitchParameter
- Render repeated watermark tiles across the canvas.
- RepeatSpacingX Double
- Horizontal spacing between repeated watermark anchors.
- RepeatSpacingY Double
- Vertical spacing between repeated watermark anchors.
- RotationDegrees Double
- Clockwise watermark rotation in degrees.
- Scale Double
- Positive watermark scale.
- Text String
- Watermark text.
Outputs
ChartForgeX.VisualArtifacts.VisualWatermark
New-ImageVisualWatermark [-Anchor <TopLeft>] -ImagePath <String> [-OffsetX <Double>] [-OffsetY <Double>] [-Opacity <Double>] [-Padding <Double>] [-Repeat] [-RepeatSpacingX <Double>] [-RepeatSpacingY <Double>] [-RotationDegrees <Double>] [-Scale <Double>] [<CommonParameters>]Parameter set:
ImageParameters
- Anchor VisualCanvasAnchor
- Watermark anchor on the artifact canvas.
- Possible values:
TopLeft,TopCenter,TopRight,MiddleLeft,Center,MiddleRight,BottomLeft,BottomCenter,BottomRight - ImagePath String
- Raster watermark image path.
- OffsetX Double
- Horizontal offset from the selected anchor.
- OffsetY Double
- Vertical offset from the selected anchor.
- Opacity Double
- Watermark opacity from zero to one.
- Padding Double
- Inset from anchored canvas edges.
- Repeat SwitchParameter
- Render repeated watermark tiles across the canvas.
- RepeatSpacingX Double
- Horizontal spacing between repeated watermark anchors.
- RepeatSpacingY Double
- Vertical spacing between repeated watermark anchors.
- RotationDegrees Double
- Clockwise watermark rotation in degrees.
- Scale Double
- Positive watermark scale.
Outputs
ChartForgeX.VisualArtifacts.VisualWatermark