Skip to content
ConsoleMonster

API Reference

Class

ProgressRow

Namespace ConsoleMonster.Widgets
Assembly ConsoleMonster
Modifiers sealed

One row of a progress display as columns see it: a lane of Lanes or a ProgressBar, with its timing, smoothed rate and remaining time at the moment of rendering.

Inheritance

  • Object
  • ProgressRow

Usage

Explore 6 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 6

Properties

public String Key { get; } #

The row key (the lane key, or the progress widget's name).

public String Label { get; } #

The label as plain text.

public RichText? LabelText { get; } #

The label as rich text, when it was given as rich text.

public String? Detail { get; } #

The detail text, or null.

public RichText? DetailText { get; } #

The detail as rich text, when it was given as rich text.

public StatusKind Status { get; } #

The status.

public Double Done { get; } #

The amount done.

public Double Total { get; } #

The total, or 0 when unknown.

public Int32 Passed { get; } #

Steps that passed.

public Int32 Failed { get; } #

Steps that failed.

public Int32 Warned { get; } #

Steps with warnings.

public Int32 Skipped { get; } #

Steps skipped.

public TimeSpan? Started { get; } #

When the row started (session clock), or null.

public TimeSpan? Finished { get; } #

When the row finished (session clock), or null.

public TimeSpan Now { get; } #

The session clock at render time.

public Double Rate { get; } #

The smoothed rate in items per second over the rate window, or 0 when unknown.

public Int32 Order { get; } #

The display order.

public Boolean IsFinished { get; } #

Whether the row has finished (pass, fail, warn or skip).

public Double Fraction { get; } #

The fraction done, 0 to 1 (1 once finished).

public TimeSpan? Elapsed { get; } #

The time spent so far (or in total, once finished), or null before the start.

public TimeSpan? Remaining { get; } #

The estimated time left from the smoothed rate, or null when it cannot be estimated.