API Reference
Command
Export-ImageVisualArtifact
Exports a ChartForgeX visual artifact to static SVG, HTML, or PNG output.
Remarks
Applies shared watermarks, PNG DPI metadata, topology layout presets, and optional layout diagnostics without changing the source artifact.
Examples
Export a watermarked 144 DPI PNG
PS>
$artifact | Export-ImageVisualArtifact -FilePath report.png -Watermark $mark -Dpi 144
Exports the artifact through the shared ChartForgeX static rendering pipeline.
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
Export-ImageVisualArtifact -Artifact <VisualArtifact> [-Dpi <Double>] -FilePath <String> [-IncludeTopologyDiagnostics] [-PassThru] [-Show] [-TopologyLayoutPreset <Automatic|Dense|Compact|Balanced|Presentation>] [-Watermark <VisualWatermark[]>] [<CommonParameters>]#Parameter set:
All Parameter SetsParameters
- Artifact VisualArtifact
- Visual artifact to export.
- Dpi Double
- PNG physical resolution metadata in dots per inch.
- FilePath String
- Destination .svg, .html, .htm, or .png path.
- IncludeTopologyDiagnostics SwitchParameter
- Draw a developer-oriented topology layout diagnostic overlay.
- PassThru SwitchParameter
- Write the source artifact to the pipeline after export.
- Show SwitchParameter
- Open the generated artifact after creation.
- TopologyLayoutPreset TopologyLayoutPreset
- Reusable topology spacing and presentation profile.
- Possible values:
Automatic,Dense,Compact,Balanced,Presentation - Watermark VisualWatermark[]
- Watermarks applied in declaration order.
Outputs
ChartForgeX.VisualArtifacts.VisualArtifact