Command

New-ImageTopologyScenario

Module imageplayground

Inputs

None

Outputs

ChartForgeX.Topology.TopologyScenario

Creates an ordered topology scenario.

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

Description

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

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

Parameters

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

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.