Skip to content

New-ImageTopologyScenario.md

Latest commit

 

History

History
203 lines (160 loc) · 4.19 KB

New-ImageTopologyScenario.md

File metadata and controls

203 lines (160 loc) · 4.19 KB
Raw
external help file ImagePlayground-help.xml
Module Name ImagePlayground
online version https://github.com/EvotecIT/ImagePlayground
schema 2.0.0

New-ImageTopologyScenario

SYNOPSIS

Creates an ordered topology scenario.

SYNTAX

__AllParameterSets

New-ImageTopologyScenario [-Id] <string> [-Label] <string> [-Step <TopologyScenarioStep[]>] [-StepDefinition <scriptblock>] [-Description <string>] [-Color <string>] [-StepDurationMilliseconds <int>] [-Loop] [-AutoPlay] [-Spotlight] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

EXAMPLE 1

PS> 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

Allow interactive HTML output to begin playback automatically.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Color

Optional CSS color used to accent the scenario.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Optional scenario description.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Stable scenario identifier.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Label

Scenario label shown by HTML controls.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Loop

Loop scenario playback.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Spotlight

Dim topology elements that do not participate in the scenario.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Step

Scenario steps supplied directly.

Type: TopologyScenarioStep[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StepDefinition

Script block that emits steps from New-ImageTopologyScenarioStep.

Type: ScriptBlock
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StepDurationMilliseconds

Default duration of each step in milliseconds.

Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • None

OUTPUTS

  • ChartForgeX.Topology.TopologyScenario

RELATED LINKS

  • None