Project

ImagePlayground

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

View on GitHub Releases Get package
Stars 100
Forks 7
Total downloads 712,347
Release ImagePlayground-PowerShellModule.v3.2.7
Language: C# Updated: 2026-08-25

API Reference

Command

New-ImageTopologyScenario

Namespace ImagePlayground
Inputs
None
Outputs
ChartForgeX.Topology.TopologyScenario

Creates an ordered topology scenario.

Remarks

Scenarios drive HTML route controls, highlighted static views, and script-free SVG, GIF, and APNG route motion.

Examples

Authored help example

Create a request-flow scenario

PS>


New-ImageTopologyScenario -Id request -Label 'Request flow' -StepDefinition { New-ImageTopologyScenarioStep -Id client-api -Kind Edge; New-ImageTopologyScenarioStep -Id api-db -Kind Edge } -AutoPlay

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

New-ImageTopologyScenario [-AutoPlay] [-Color <String>] [-Description <String>] -Id <String> -Label <String> [-Loop] [-Spotlight] [-Step <TopologyScenarioStep[]>] [-StepDefinition <ScriptBlock>] [-StepDurationMilliseconds <Int32>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

AutoPlay SwitchParameter optionalposition: namedpipeline: False
Allow interactive HTML output to begin playback automatically.
Color String optionalposition: namedpipeline: False
Optional CSS color used to accent the scenario.
Description String optionalposition: namedpipeline: False
Optional scenario description.
Id String requiredposition: 0pipeline: False
Stable scenario identifier.
Label String requiredposition: 1pipeline: False
Scenario label shown by HTML controls.
Loop SwitchParameter optionalposition: namedpipeline: False
Loop scenario playback.
Spotlight SwitchParameter optionalposition: namedpipeline: False
Dim topology elements that do not participate in the scenario.
Step TopologyScenarioStep[] optionalposition: namedpipeline: False
Scenario steps supplied directly.
StepDefinition ScriptBlock optionalposition: namedpipeline: False
Script block that emits steps from New-ImageTopologyScenarioStep.
StepDurationMilliseconds Int32 optionalposition: namedpipeline: False
Default duration of each step in milliseconds.

Outputs

ChartForgeX.Topology.TopologyScenario