# New-ImageTopology

Creates a topology diagram image. Review available syntax, parameters, pipeline guidance, and reference details in ImagePlayground API Reference.

Project

ImagePlayground

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

[View on GitHub](https://github.com/EvotecIT/ImagePlayground) [Visit Website](#) [Releases](https://github.com/EvotecIT/ImagePlayground/releases) [Changelog](#) [Get package](https://www.powershellgallery.com/packages/ImagePlayground)

Stars **102**

Forks **7**

Open issues 

Total downloads **708,853**

Release **ImagePlayground-PowerShellModule.v3.2.7**

Language: C# Updated: 2026-11-18

Command 

**Module**

`ImagePlayground`

**Inputs**

`System.Object[]`

**Outputs**

`ChartForgeX.Topology.TopologyChart`

Creates a topology diagram image.

## Syntax

```
New-ImageTopology
[-ActiveScenarioId <String>]
[-CanvasSurfaceStyle <Plain|Panel|PanelGrid>]
[-Direction <TopToBottom|LeftToRight|BottomToTop|RightToLeft>]
[-Dpi <Double>]
-FilePath <String>
[-FitContentToViewport]
[-Height <Int32>]
[-IncludeLayoutDiagnostics]
[-InteractiveHtml]
[-Layout <TopologyLayoutMode>]
[-LayoutPreset <Automatic|Dense|Compact|Balanced|Presentation>]
[-Motion <TopologyMotionOptions>]
[-NodeDisplayMode <TopologyNodeDisplayMode>]
[-NoEdgeLabels]
[-NoGroups]
[-NoLegend]
[-NoScenarioControls]
[-NoScenarioPanel]
[-NoStatusBadges]
[-NoTitle]
[-Padding <Int32>]
[-PassThru]
[-ScenarioControlMode <Buttons|Checkboxes>]
[-ScenarioDefinition <ScriptBlock>]
[-ScenarioUrlState]
[-Show]
[-Subtitle <String>]
[-Theme <Light|Dark>]
[-Title <String>]
[-TopologyDefinition] <ScriptBlock>
[-Transparent]
[-VisualStyle <Default|MonitoringDashboard>]
[-Watermark <VisualWatermark[]>]
[-Width <Int32>]
[<CommonParameters>]
```

[#](#member-4226e290941ccc4bace289ba)

Parameter set: `ScriptBlock`

```
New-ImageTopology
[-ActiveScenarioId <String>]
[-CanvasSurfaceStyle <Plain|Panel|PanelGrid>]
[-Chart <TopologyChart>]
[-Definition <Object[]>]
[-Direction <TopToBottom|LeftToRight|BottomToTop|RightToLeft>]
[-Dpi <Double>]
[-Edge <TopologyEdge[]>]
-FilePath <String>
[-FitContentToViewport]
[-Group <TopologyGroup[]>]
[-Height <Int32>]
[-IncludeLayoutDiagnostics]
[-InteractiveHtml]
[-Layout <TopologyLayoutMode>]
[-LayoutPreset <Automatic|Dense|Compact|Balanced|Presentation>]
[-Motion <TopologyMotionOptions>]
[-Node <TopologyNode[]>]
[-NodeDisplayMode <TopologyNodeDisplayMode>]
[-NoEdgeLabels]
[-NoGroups]
[-NoLegend]
[-NoScenarioControls]
[-NoScenarioPanel]
[-NoStatusBadges]
[-NoTitle]
[-Padding <Int32>]
[-PassThru]
[-Scenario <TopologyScenario[]>]
[-ScenarioControlMode <Buttons|Checkboxes>]
[-ScenarioDefinition <ScriptBlock>]
[-ScenarioUrlState]
[-Show]
[-Subtitle <String>]
[-Theme <Light|Dark>]
[-Title <String>]
[-Transparent]
[-VisualStyle <Default|MonitoringDashboard>]
[-Watermark <VisualWatermark[]>]
[-Width <Int32>]
[<CommonParameters>]
```

[#](#member-1a28d660d624a4407e7312b7)

Parameter set: `Definition`

## Description

Renders ChartForgeX topology definitions to PNG, SVG, HTML, GIF, or APNG output. GIF and APNG sample the route configured by Motion.

## Examples

### Create a service topology diagram

```powershell
New-ImageTopology -TopologyDefinition {
    New-ImageTopologyNode -Id api -Label API -Kind Service -Status Healthy -Symbol API
    New-ImageTopologyNode -Id db -Label Database -Kind Database -Status Warning -Symbol SQL
    New-ImageTopologyEdge -SourceNodeId api -TargetNodeId db -Label '32 ms' -Kind Dependency -Status Warning -Direction Forward
} -Title 'Service map' -Layout Layered -Direction LeftToRight -FilePath service-map.png
```

Creates a transparent-ready PNG topology diagram from a PowerShell DSL.

## Parameters

**-ActiveScenarioId String optional**

Scenario activated for static highlighting or when interactive HTML first loads.

**-CanvasSurfaceStyle TopologyCanvasSurfaceStyle optional**

Canvas surface style.

Possible values: `Plain`, `Panel`, `PanelGrid`

**-Direction TopologyLayoutDirection optional**

Topology layout direction.

Possible values: `TopToBottom`, `LeftToRight`, `BottomToTop`, `RightToLeft`

**-Dpi Double optional**

PNG physical resolution metadata in dots per inch.

**-FilePath String required**

Output file path. The extension selects PNG, SVG, HTML, GIF, or APNG output.

**-FitContentToViewport SwitchParameter optional**

Scale topology content down to remain inside the requested viewport.

**-Height Int32 optional**

Viewport height in pixels.

**-IncludeLayoutDiagnostics SwitchParameter optional**

Draw a developer-oriented layout diagnostic overlay in SVG, HTML, or PNG output.

**-InteractiveHtml SwitchParameter optional**

Enable lightweight interactions for HTML output.

**-Layout TopologyLayoutMode optional**

Topology layout mode.

Possible values: `Manual`, `GroupGrid`, `HubAndSpoke`, `Layered`, `Matrix`, `DenseGrouped`, `Geographic`, `ForceDirected`, `RelationshipRadial`, `MindMap`

**-LayoutPreset TopologyLayoutPreset optional**

Reusable topology spacing and presentation profile.

Possible values: `Automatic`, `Dense`, `Compact`, `Balanced`, `Presentation`

**-Motion TopologyMotionOptions optional**

Script-free route motion used by SVG, GIF, APNG, and sampled PNG output.

**-NodeDisplayMode TopologyNodeDisplayMode optional**

Node presentation mode.

Possible values: `Card`, `CompactCard`, `Tile`, `Pill`, `Icon`, `Artwork`, `Dot`, `Hidden`

**-NoEdgeLabels SwitchParameter optional**

Hide edge labels.

**-NoGroups SwitchParameter optional**

Hide topology groups.

**-NoLegend SwitchParameter optional**

Hide the topology legend.

**-NoScenarioControls SwitchParameter optional**

Hide scenario controls in interactive HTML output.

**-NoScenarioPanel SwitchParameter optional**

Hide the compact scenario detail panel in interactive HTML output.

**-NoStatusBadges SwitchParameter optional**

Hide status badges.

**-NoTitle SwitchParameter optional**

Hide the topology title.

**-Padding Int32 optional**

Viewport padding in pixels.

**-PassThru SwitchParameter optional**

Write the generated topology chart to the pipeline after rendering.

**-ScenarioControlMode TopologyHtmlScenarioControlMode optional**

Scenario control presentation used by interactive HTML output.

Possible values: `Buttons`, `Checkboxes`

**-ScenarioDefinition ScriptBlock optional**

Script block that emits topology scenarios.

**-ScenarioUrlState SwitchParameter optional**

Synchronize the active scenario with the HTML page query string.

**-Show SwitchParameter optional**

Open the generated file after creation.

**-Subtitle String optional**

Topology subtitle.

**-Theme String optional**

Topology theme name.

Possible values: `Light`, `Dark`

**-Title String optional**

Topology title.

**-TopologyDefinition ScriptBlock requiredposition: 0sets: ScriptBlock**

Script block that emits topology groups, nodes, edges, or a topology chart.

**-Transparent SwitchParameter optional**

Use a transparent diagram canvas.

**-VisualStyle TopologyVisualStyle optional**

Reusable visual style.

Possible values: `Default`, `MonitoringDashboard`

**-Watermark VisualWatermark[] optional**

Watermarks applied to static SVG, HTML, or PNG output.

**-Width Int32 optional**

Viewport width in pixels.

**-Chart TopologyChart optionalsets: Definition**

Topology chart provided directly.

**-Definition Object[] optionalpipeline: True (ByValue)sets: Definition**

Topology objects provided directly or from the pipeline.

**-Edge TopologyEdge[] optionalsets: Definition**

Topology edges provided directly.

**-Group TopologyGroup[] optionalsets: Definition**

Topology groups provided directly.

**-Node TopologyNode[] optionalsets: Definition**

Topology nodes provided directly.

**-Scenario TopologyScenario[] optionalsets: Definition**

Topology scenarios provided directly.

## 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](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters).

Evotec API Reference Copyright 2026 Evotec Services

<!-- PowerForge markdown artifact sha256:7E21FBB9577CACE88F8F8C59667933355B5581333FF511718693671E80D8DAD5 -->
