Command

New-ImageVisualStory

Module: ImagePlayground
Inputs: ChartForgeX.VisualBlocks.VisualGrid
Outputs: ChartForgeX.VisualBlocks.VisualGrid

Creates a script-free animated visual story from a ChartForgeX visual grid.

Syntax

New-ImageVisualStory
-FilePath <String>
[-Motion <VisualMotionTimeline>]
[-MotionDefinition <ScriptBlock>]
[-PassThru]
[-Show]
[-StoryScript] <ScriptBlock>
[<CommonParameters>]

Parameter set: StoryScript

New-ImageVisualStory
-FilePath <String>
-Grid <VisualGrid>
[-Motion <VisualMotionTimeline>]
[-MotionDefinition <ScriptBlock>]
[-PassThru]
[-Show]
[<CommonParameters>]

Parameter set: Grid

Description

Use a native ChartForgeX VisualGrid or configure one in StoryScript. SVG and HTML preserve motion, while PNG renders the completed static state.

Examples

Create an animated engineering profile card

New-ImageVisualStory -StoryScript {
  param($Story)
  [void] $Story.WithTitle('Engineering signal').WithColumns(1)
  $metric = [ChartForgeX.VisualBlocks.MetricCard]::Create().WithMetric('Projects', '126')
  [void] $Story.Add('projects', $metric)
} -MotionDefinition {
  New-ImageVisualMotionCue -TargetId title -Effect Reveal -DurationSeconds 0.9
  New-ImageVisualMotionCue -TargetId projects -Effect Rise -DelaySeconds 0.3
} -FilePath profile.svg

Builds a dependency-free SVG whose one-shot motion honors reduced-motion preferences.

Parameters

-FilePath String required: Output file path. Supported extensions are SVG, HTML, HTM, and PNG.
-Motion VisualMotionTimeline optional: Ready-to-use ChartForgeX motion timeline.
-MotionDefinition ScriptBlock optional: Script block that emits New-ImageVisualMotionCue results or one VisualMotionTimeline.
-PassThru SwitchParameter optional: Write the configured ChartForgeX VisualGrid to the pipeline.
-Show SwitchParameter optional: Open the generated visual after creation.
-StoryScript ScriptBlock requiredposition: 0sets: StoryScript: Script block that receives and configures a new ChartForgeX VisualGrid.
-Grid VisualGrid requiredpipeline: True (ByValue)sets: Grid: Native ChartForgeX visual grid to render.

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.