Project

ImagePlayground

Automate image processing, codes, metadata, charts, topology, and visual stories from PowerShell.

View on GitHub Releases Get package
Stars 100
Forks 7
Total downloads 712,347
Release ImagePlayground-PowerShellModule.v3.2.7
Language: C# Updated: 2026-08-25

API Reference

Command

New-ImageVisualStory

Namespace ImagePlayground
Inputs
ChartForgeX.VisualBlocks.VisualGrid
Outputs
ChartForgeX.VisualBlocks.VisualGrid

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

Remarks

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

Examples

Authored help example

Create an animated engineering profile card

PS>


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.

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.

Syntax

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

Parameters

FilePath String requiredposition: namedpipeline: False
Output file path. Supported extensions are SVG, HTML, HTM, and PNG.
Motion VisualMotionTimeline optionalposition: namedpipeline: False
Ready-to-use ChartForgeX motion timeline.
MotionDefinition ScriptBlock optionalposition: namedpipeline: False
Script block that emits New-ImageVisualMotionCue results or one VisualMotionTimeline.
PassThru SwitchParameter optionalposition: namedpipeline: False
Write the configured ChartForgeX VisualGrid to the pipeline.
Show SwitchParameter optionalposition: namedpipeline: False
Open the generated visual after creation.
StoryScript ScriptBlock requiredposition: 0pipeline: False
Script block that receives and configures a new ChartForgeX VisualGrid.

Outputs

ChartForgeX.VisualBlocks.VisualGrid

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

Parameters

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

Outputs

ChartForgeX.VisualBlocks.VisualGrid