Skip to content
ChartForgeX
Command

New-ImageConsoleStoryTable

Module imageplayground
Inputs
System.Management.Automation.PSObject[]
Outputs
ImagePlayground.PowerShell.ImageConsoleStoryStep

Creates a typed table step from ordinary PowerShell objects.

Syntax

New-ImageConsoleStoryTable [-Align <IDictionary>] [-Header <String[]>] [-InputObject] <PSObject[]> -Property <String[]> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Description

Property selects source properties, Header optionally replaces their displayed names, and Align maps a property or displayed header to Left or Right alignment.

Examples

Authored help example

Build a table from pipeline objects

$projects | New-ImageConsoleStoryTable -Property Name, Language, Stars -Header PROJECT, STACK, STARS -Align @{ Stars = 'Right' }

Creates one table step without exposing the ChartForgeX table builder.

Parameters

-Align IDictionary optionalaliases: Alignment
Column alignment keyed by source property or displayed header. Values are Left or Right.
-Header String[] optionalaliases: Columns
Displayed column names. Defaults to Property.
-InputObject PSObject[] requiredposition: 0pipeline: True (ByValue)
Objects used as table rows.
-Property String[] requiredaliases: Properties
Source properties included in the table, in display order.

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.ImageConsoleStoryStep: Use the console story command, output, table, blank-line, pause, tab, and tab-selection cmdlets to create steps.