Skip to content
ChartForgeX
Command

Export-ImageVisualArtifact

Module imageplayground
Inputs
ChartForgeX.VisualArtifacts.VisualArtifact
Outputs
ChartForgeX.VisualArtifacts.VisualArtifact

Exports a ChartForgeX visual artifact to static SVG, HTML, PNG, JPEG, WebP, GIF, BMP, TIFF, or TGA output.

Syntax

Export-ImageVisualArtifact [-Artifact] <VisualArtifact> [-Dpi <Double>] [-FilePath] <String> [-IncludeTopologyDiagnostics] [-PassThru] [-Show] [-TopologyLayoutPreset <Automatic|Dense|Compact|Balanced|Presentation>] [-Watermark <VisualWatermark[]>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Description

Applies shared watermarks, PNG DPI metadata, topology layout presets, and optional layout diagnostics without changing the source artifact.

Examples

Authored help example

Export a watermarked 144 DPI PNG

$artifact | Export-ImageVisualArtifact -FilePath report.png -Watermark $mark -Dpi 144

Exports the artifact through the shared ChartForgeX static rendering pipeline.

Parameters

-Artifact VisualArtifact requiredposition: 0pipeline: True (ByValue)
Visual artifact to export.
-Dpi Double optional
PNG physical resolution metadata in dots per inch.
-FilePath String requiredposition: 1
Destination path. The extension picks the format: .svg, .html, .htm, .png, .jpg, .jpeg, .webp, .gif, .bmp, .tif, .tiff, or .tga.
-IncludeTopologyDiagnostics SwitchParameter optional
Draw a developer-oriented topology layout diagnostic overlay.
-PassThru SwitchParameter optional
Write the source artifact to the pipeline after export.
-Show SwitchParameter optional
Open the generated artifact after creation.
-TopologyLayoutPreset TopologyLayoutPreset optional
Reusable topology spacing and presentation profile.
Possible values: Automatic, Dense, Compact, Balanced, Presentation
-Watermark VisualWatermark[] optional
Watermarks applied in declaration order.

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.