Project

ImagePlayground

Automate image processing, codes, metadata, charts, topology, and visual stories from PowerShell.

View on GitHub Releases Get package
Stars 101
Forks 7
Total downloads 712,707
Release ImagePlayground-PowerShellModule.v3.2.7
Language: C# Updated: 2026-10-09

API Reference

Command

ConvertTo-ImageVisualArtifact

Namespace ImagePlayground
Inputs
System.Object
Outputs
ChartForgeX.VisualArtifacts.VisualArtifact

Converts a ChartForgeX chart, grid, canvas, story, diagram, table, sequence, flow, or visual block into a reusable visual artifact.

Remarks

The artifact is the portable handoff contract for static export, OfficeIMO document placement, and native editable Visio projection.

Examples

Authored help example

Create an artifact from a topology

PS>


$artifact = $topology | ConvertTo-ImageVisualArtifact -Id service-map -AccessibleDescription 'Gateway to database service path.'

Creates a reusable artifact that can be exported by ImagePlayground or placed by PSWriteOffice.

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

ConvertTo-ImageVisualArtifact [-AccessibleDescription <String>] [-AccessibleName <String>] [-Decorative] [-Id <String>] -InputObject <Object> [-Language <String>] [-Subtitle <String>] [-Title <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

AccessibleDescription String optionalposition: namedpipeline: False
Longer accessible description for the visual.
AccessibleName String optionalposition: namedpipeline: False
Concise accessible name for the visual.
Decorative SwitchParameter optionalposition: namedpipeline: False
Marks the visual as decorative.
Id String optionalposition: namedpipeline: False
Stable artifact identifier. Existing artifact ids are preserved when omitted.
InputObject Object requiredposition: 0pipeline: True (ByValue)
ChartForgeX model or existing visual artifact.
Language String optionalposition: namedpipeline: False
Optional BCP 47 language tag for accessible text.
Subtitle String optionalposition: namedpipeline: False
Optional artifact subtitle override.
Title String optionalposition: namedpipeline: False
Optional artifact title override.

Outputs

ChartForgeX.VisualArtifacts.VisualArtifact