Cmdlet

New-ConsoleLanes

Module ConsoleMonster

Inputs

None

Outputs

ConsoleMonster.Widgets.Lanes

Creates a lanes widget: one row per worker, server or item of a parallel workload.

Syntax

New-ConsoleLanes [-CollapseWhenFinished] [-Column <String[]>] [-HideCompleted] [-Lane <Object[]>] [[-Name] <String>] [-Shape <Block|Line>] [-Total <Double>] [-Transient] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Creates a lanes widget: one row per worker, server or item of a parallel workload.

Each lane shows a status marker (a spinner while running), a progress bar, pass/fail/warning counts and what it is doing now. Lanes can be declared up front with -Lane or appear on their first Update-ConsoleLane.

Examples

Authored help example

EXAMPLE 1

New-ConsoleLanes -Name 'Name'

Parameters

-CollapseWhenFinished SwitchParameter optional: Collapses the display to one summary line once every lane has finished.
-Column String[] optional: The columns of each row, in order: Standard (spinner, description, bar, percent, count, elapsed, remaining time, status), or any of Spinner, Description, Bar, Percent, Count, Elapsed, Remaining, Rate, ByteRate, Results and Status. Without it the classic layout shows the label, bar, percentage, pass/fail/warning counts and detail.; Possible values: Standard, Spinner, Description, Bar, Percent, Count, Elapsed, Remaining, Rate, ByteRate, Results, Status
-HideCompleted SwitchParameter optional: Finished lanes leave the display and are counted in the summary line.
-Lane Object[] optional: Lanes to declare up front (key and label).
-Name String optionalposition: 0: The live name (default lanes).
-Shape BarShape optional: Bar shape: Line (thin stroke) or Block (solid blocks). Default Line.; Possible values: Block, Line
-Total Double optional: Planned steps per declared lane.
-Transient SwitchParameter optional: The display disappears once every lane has finished (with Start-ConsoleDashboard -Transient nothing is left).

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.