API Reference
Command
New-ImageVisualGrid
Creates a reusable dashboard grid from charts and visual blocks.
Remarks
Render the grid directly, pass it to New-ImageVisualStory, or compose it inside a ChartForgeX visual canvas.
Examples
Create a status dashboard
PS>
New-ImageVisualGrid -Title 'Service health' -Columns 2 -ContentDefinition { New-ImageMetricCard -Label 'Requests' -Value 12840 -Status Positive; New-ImageListBlock -Title 'Checks' -Item API,Database -Status Positive,Warning } -FilePath dashboard.svg
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-ImageVisualGrid [-AdaptiveRowHeights] [-Columns <Int32>] -ContentDefinition <ScriptBlock> [-FilePath <String>] [-Frame] [-Gap <Int32>] [-Motion <VisualMotionTimeline>] [-Padding <Int32>] [-PanelFit <Contain|Stretch>] [-PanelHeight <Int32>] [-PanelWidth <Int32>] [-PassThru] [-Show] [-Subtitle <String>] [-Theme <Default>] [-Title <String>] [<CommonParameters>]Parameter set:
DefinitionParameters
- AdaptiveRowHeights SwitchParameter
- Use each row's natural item height.
- Columns Int32
- Preferred column count.
- ContentDefinition ScriptBlock
- Script block that emits charts, visual blocks, or New-ImageVisualGridItem results.
- FilePath String
- Optional output path. Omit it to return the grid without rendering.
- Frame SwitchParameter
- Render a subtle outer frame.
- Gap Int32
- Gap between panels in pixels.
- Motion VisualMotionTimeline
- Optional script-free SVG and HTML motion timeline.
- Padding Int32
- Outer grid padding in pixels.
- PanelFit VisualPanelFit
- How child content fits fixed panels.
- Possible values:
Contain,Stretch - PanelHeight Int32
- Optional fixed panel height.
- PanelWidth Int32
- Optional fixed panel width.
- PassThru SwitchParameter
- Return the grid when an output file is also written.
- Show SwitchParameter
- Open the rendered dashboard.
- Subtitle String
- Optional dashboard subtitle.
- Theme ChartTheme
- ChartForgeX theme.
- Possible values:
Default,Dark,Light,Colorblind,Aurora,Editorial,Candy,PeopleInfographic,Terminal,TransparentOverlayDark,Minimal,DashboardLight,SaasDashboardLight,RestaurantDashboardLight - Title String
- Optional dashboard title.
Outputs
ChartForgeX.VisualBlocks.VisualGrid
New-ImageVisualGrid [-AdaptiveRowHeights] [-Columns <Int32>] -Content <Object[]> [-FilePath <String>] [-Frame] [-Gap <Int32>] [-Motion <VisualMotionTimeline>] [-Padding <Int32>] [-PanelFit <Contain|Stretch>] [-PanelHeight <Int32>] [-PanelWidth <Int32>] [-PassThru] [-Show] [-Subtitle <String>] [-Theme <Default>] [-Title <String>] [<CommonParameters>]Parameter set:
ContentParameters
- AdaptiveRowHeights SwitchParameter
- Use each row's natural item height.
- Columns Int32
- Preferred column count.
- Content Object[]
- Charts, visual blocks, or grid items supplied directly or through the pipeline.
- FilePath String
- Optional output path. Omit it to return the grid without rendering.
- Frame SwitchParameter
- Render a subtle outer frame.
- Gap Int32
- Gap between panels in pixels.
- Motion VisualMotionTimeline
- Optional script-free SVG and HTML motion timeline.
- Padding Int32
- Outer grid padding in pixels.
- PanelFit VisualPanelFit
- How child content fits fixed panels.
- Possible values:
Contain,Stretch - PanelHeight Int32
- Optional fixed panel height.
- PanelWidth Int32
- Optional fixed panel width.
- PassThru SwitchParameter
- Return the grid when an output file is also written.
- Show SwitchParameter
- Open the rendered dashboard.
- Subtitle String
- Optional dashboard subtitle.
- Theme ChartTheme
- ChartForgeX theme.
- Possible values:
Default,Dark,Light,Colorblind,Aurora,Editorial,Candy,PeopleInfographic,Terminal,TransparentOverlayDark,Minimal,DashboardLight,SaasDashboardLight,RestaurantDashboardLight - Title String
- Optional dashboard title.
Outputs
ChartForgeX.VisualBlocks.VisualGrid