Cmdlet

New-ConsoleDashboard

Module ConsoleMonster

Inputs

None

Outputs

ConsoleMonster.Widgets.Dashboard

Defines a live console dashboard: a header with title and clock, the body and a footer.

Syntax

New-ConsoleDashboard [-Content] <ScriptBlock> [-Footer <Object>] [-Gap <Int32>] [-Name <String>] [-Subtitle <Object>] -Title <Object> [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Defines a live console dashboard: a header with title and clock, the body and a footer.

The scriptblock emits the body widgets top to bottom. Pass the result to Start-ConsoleDashboard to run it live, or to Write-ConsoleWidget to print it once.

Examples

Authored help example

EXAMPLE 1

New-ConsoleDashboard -Content { } -Title 'Value'

Parameters

-Content ScriptBlock requiredposition: 0: Scriptblock that emits the body widgets.
-Footer Object optional: Footer text; defaults to a Ctrl+C hint.
-Gap Int32 optional: Blank rows between the body widgets.
-Name String optional: Live name of the dashboard (for Send-ConsoleEvent title/status updates).
-Subtitle Object optional: A subtitle shown after the title.
-Title Object required: The title shown in the header bar (markup allowed).

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.