Command

ConvertTo-ImageVisualArtifact

Module imageplayground

Inputs

System.Object

Outputs

ChartForgeX.VisualArtifacts.VisualArtifact

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

Syntax

ConvertTo-ImageVisualArtifact [-AccessibleDescription <String>] [-AccessibleName <String>] [-Decorative] [-Id <String>] [-InputObject] <Object> [-Language <String>] [-Subtitle <String>] [-Title <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

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

$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.

Turn a dashboard grid into an artifact

$grid = New-ImageVisualGrid -Title 'Service health' -Columns 2 -ContentDefinition { New-ImageMetricCard -Label Requests -Value 12840 }
$grid | ConvertTo-ImageVisualArtifact -Id service-health | Export-ImageVisualArtifact -FilePath service-health.webp

Visual grids from New-ImageVisualGrid convert directly; the artifact renders the grid natively.

Parameters

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

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.