Command

New-ImageStoryPanel

Module imageplayground

Inputs

ChartForgeX.Stories.StoryReplay ChartForgeX.Stories.StorySourceText ChartForgeX.Stories.StorySourceTimeline ChartForgeX.Terminal.TerminalStory

Outputs

ImagePlayground.PowerShell.Stories.ImageStoryPanelSpec

Creates one resolved source, terminal, media, or text panel for a generic visual story.

Syntax

New-ImageStoryPanel -Id <String> -Source <StorySourceText> [-SourceOptions <VisualStorySourceOptions>] [-Title <String>] [-Weight <Double>] [<CommonParameters>]

Parameter set: Source

New-ImageStoryPanel -Id <String> [-SourceOptions <VisualStorySourceOptions>] -SourceTimeline <StorySourceTimeline> [-Title <String>] [-Weight <Double>] [<CommonParameters>]

Parameter set: SourceTimeline

New-ImageStoryPanel -Id <String> [-Language <String>] [-SourceOptions <VisualStorySourceOptions>] -SourceText <String> [-Title <String>] [-Tokenizer <IStorySourceTokenizer>] [-Weight <Double>] [<CommonParameters>]

Parameter set: SourceText

New-ImageStoryPanel [-AccessibleText <String>] -Id <String> -Replay <StoryReplay> [-ReplayTheme <TerminalTheme>] [-TerminalOptions <VisualStoryTerminalOptions>] [-Title <String>] [-Weight <Double>] [<CommonParameters>]

Parameter set: Replay

New-ImageStoryPanel -AccessibleText <String> -Id <String> -Terminal <TerminalStory> [-TerminalOptions <VisualStoryTerminalOptions>] [-Title <String>] [-Weight <Double>] [<CommonParameters>]

Parameter set: Terminal

New-ImageStoryPanel -AccessibleText <String> -Id <String> -MediaPath <String> [-Title <String>] [-Weight <Double>] [<CommonParameters>]

Parameter set: MediaPath

New-ImageStoryPanel -AccessibleText <String> -Id <String> -MediaBytes <Byte[]> [-MediaSvg <String>] [-Title <String>] [-Weight <Double>] [<CommonParameters>]

Parameter set: MediaBytes

New-ImageStoryPanel -AccessibleText <String> -Id <String> -MediaImage <RgbaImage> [-MediaSvg <String>] [-Title <String>] [-Weight <Double>] [<CommonParameters>]

Parameter set: MediaImage

New-ImageStoryPanel [-Emphasized] -Id <String> -Text <String> [-Title <String>] [-Weight <Double>] [<CommonParameters>]

Parameter set: Text

Examples

Authored help example

Create an emphasized result panel

New-ImageStoryPanel -Id 'summary' -Title 'Result' -Text 'Deployment completed.' -Emphasized

Parameters

-Id String required: Stable panel identifier referenced by completed outcomes.
-Source StorySourceText requiredpipeline: True (ByValue)sets: Source: Exact source text with optional renderer-neutral syntax spans.
-SourceOptions VisualStorySourceOptions optionalsets: Source, SourceTimeline, SourceText: Fixed source viewport settings, including filename and line numbers.
-Title String optional: Optional visible panel title.
-Weight Double optional: Relative size in split or stacked scenes.
-SourceTimeline StorySourceTimeline requiredpipeline: True (ByValue)sets: SourceTimeline: Resolved source editing events on the scene clock.
-Language String optionalsets: SourceText: Language identifier used for SourceText.
-SourceText String requiredsets: SourceText: Exact source text to tokenize or preserve.
-Tokenizer IStorySourceTokenizer optionalsets: SourceText: Optional language tokenizer for SourceText.
-AccessibleText String required in Terminal, MediaPath, MediaBytes, MediaImagesets: Replay, Terminal, MediaPath, MediaBytes, MediaImage: Accessible alternative for terminal or media content.
-Replay StoryReplay requiredpipeline: True (ByValue)sets: Replay: Resolved recorded observations. Rendering never executes their commands.
-ReplayTheme TerminalTheme optionalsets: Replay: Optional recorded-replay palette.
-TerminalOptions VisualStoryTerminalOptions optionalsets: Replay, Terminal: Fixed-font wrapping and history settings for terminal or replay panels.
-Terminal TerminalStory requiredpipeline: True (ByValue)sets: Terminal: Resolved deterministic terminal presentation.
-MediaPath String requiredsets: MediaPath: Raster image file to reveal.
-MediaBytes Byte[] requiredsets: MediaBytes: Resolved raster image bytes to reveal.
-MediaSvg String optionalsets: MediaBytes, MediaImage: Optional resolved SVG representation paired with MediaBytes or MediaImage.
-MediaImage RgbaImage requiredsets: MediaImage: Resolved RGBA image to reveal.
-Emphasized SwitchParameter optionalsets: Text: Give text content stronger visual emphasis.
-Text String requiredsets: Text: Explanatory prose or a short status.

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.ImageStoryPanelSpec: PowerShell-friendly resolved panel specification for New-ImageStoryScene.