Skip to content
ChartForgeX
Command

New-ImageStoryScene

Module imageplayground
Inputs
ImagePlayground.PowerShell.Stories.ImageStoryPanelSpec[]
Outputs
ImagePlayground.PowerShell.Stories.ImageStorySceneSpec

Groups resolved panels into one timed visual-story scene.

Syntax

New-ImageStoryScene [-DurationSeconds <Double>] -Id <String> [-Layout <Focus|Split|Stacked>] -Panels <ImageStoryPanelSpec[]> -Title <String> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Authored help example

Create a scene from a resolved text panel

$panel = New-ImageStoryPanel -Id 'summary' -Text 'Deployment completed.' -Emphasized
New-ImageStoryScene -Id 'result' -Title 'Deployment result' -Panels $panel -DurationSeconds 3

Parameters

-DurationSeconds Double optional
Scene display duration.
-Id String required
Stable scene identifier.
-Layout VisualStorySceneLayout optional
Panel arrangement.
Possible values: Focus, Split, Stacked
-Panels ImageStoryPanelSpec[] requiredpipeline: True (ByValue)
Resolved panels in display order.
-Title String required
Visible scene heading.

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.

Outputs

ImagePlayground.PowerShell.Stories.ImageStorySceneSpec: PowerShell-friendly resolved scene specification for New-ImageStory.