Cmdlet

Update-ConsoleSummaryBar

Module ConsoleMonster

Inputs

None

Updates a summary bar (New-ConsoleSummaryBar) in the running dashboard: progress and counters.

Syntax

Update-ConsoleSummaryBar [-Counter <IDictionary>] [[-Done] <Double>] [-Name <String>] [-Session <LiveSession>] [[-Total] <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Updates a summary bar (New-ConsoleSummaryBar) in the running dashboard: progress and counters.

-Done sets the items done (-Total changes the total; without it the bar keeps its total) and -Counter sets counts by label, in one call; a label that is a status word (passed, failed, warnings, skipped, running) takes that status's symbol and colour, and new labels are added after the existing ones. The elapsed time and the time left follow the session clock, so a simulated clock (New-ConsoleClock) drives them too. Safe to call from any runspace or thread.

Examples

Authored help example

EXAMPLE 1

Update-ConsoleSummaryBar -Done $done -Counter ([ordered] @{ passed = $passed; warnings = $warned; failed = $failed })

Count a finished check

EXAMPLE 2

Update-ConsoleSummaryBar -Name summary -Done 12 -Total 80

A run whose total grows as work is discovered

Parameters

-Counter IDictionary optional: Labels mapped to counts (use [ordered] to keep the order of new labels); status words take their status symbol and colour.
-Done Double optionalposition: 0: Items done.
-Name String optional: The summary bar name (default summary).
-Session LiveSession optional: The live session to update. Defaults to $ConsoleSession or the running dashboard.
-Total Double optionalposition: 1: Items in total; without it the bar keeps the total it has (0 = unknown).

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.