Cmdlet

New-ConsoleProgress

Module ConsoleMonster

Inputs

None

Outputs

ConsoleMonster.Widgets.ProgressBar

Creates a labelled progress bar.

Syntax

New-ConsoleProgress [-Column <String[]>] [[-Label] <Object>] [-Name <String>] [-Shape <Block|Line>] [-Total <Double>] [-Value <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Creates a labelled progress bar.

Shows a bar with sub-cell precision for the glyph tier, the percentage and value/total. Update it live with Update-ConsoleProgress.

Examples

Authored help example

EXAMPLE 1

New-ConsoleProgress -Name 'Name'

Parameters

-Column String[] optional: The columns of the row, in order: Standard, or any of Spinner, Description, Bar, Percent, Count, Elapsed, Remaining, Rate, ByteRate, Results and Status. Rate and Remaining are smoothed over the last 10 seconds. Without it the classic label, bar, percentage and count show.; Possible values: Standard, Spinner, Description, Bar, Percent, Count, Elapsed, Remaining, Rate, ByteRate, Results, Status
-Label Object optionalposition: 0: The label (markup allowed).
-Name String optional: The live name (default progress).
-Shape BarShape optional: Bar shape: Line (thin stroke) or Block (solid blocks). Default Line.; Possible values: Block, Line
-Total Double optional: The total (default 100).
-Value Double optional: The current value.

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.