Class ActivityProgressBarElement

Namespace

ItTiger.TigerCli.Tui.Activity

Assembly

ItTiger.TigerCli.dll

A progress-bar element bound to row-local values. The current value is read from ValueIndex; the maximum is either the fixed FixedMax (default 100) or, when MaxValueIndex is set, read from that value. Rendered as a post-layout overlay so CliGrid resolves the bar's width (place it in a star column to fill the remaining space).

public sealed class ActivityProgressBarElement : ActivityElement

Inheritance

object

ActivityElement

ActivityProgressBarElement

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Caps

The optional end-cap decoration for this bar. Defaults to None. Composes with any Style; set via the ProgressBar(..., caps) builder overloads.

public ProgressBarCaps Caps { get; }

Property Value

ProgressBarCaps

ColorMode

How the bar is coloured. Defaults to Single (uniform). In the two-/three-colour modes the activity control resolves the done / remaining / complete colours from semantic theme styles. Set via the ProgressBar(..., colorMode) builder overloads.

public ProgressBarColorMode ColorMode { get; }

Property Value

ProgressBarColorMode

FixedMax

Fixed maximum used when MaxValueIndex is null. Defaults to 100.

public double FixedMax { get; }

Property Value

double

MaxValueIndex

Optional row value index holding a dynamic maximum.

public int? MaxValueIndex { get; }

Property Value

int?

Style

The predefined glyph appearance for this bar. Defaults to Default (█/░); the colour stays uniform regardless of style. Set via the ProgressBar(..., style) builder overloads.

public ProgressBarStyle Style { get; }

Property Value

ProgressBarStyle

ValueIndex

Row value index holding the current progress value.

public int ValueIndex { get; }

Property Value

int

Methods

Fraction(IReadOnlyList<object?>)

The clamped [0, 1] fill fraction for the given row values. A non-positive maximum yields 0 (no divide-by-zero); values clamp into range.

public double Fraction(IReadOnlyList<object?> values)

Parameters

values IReadOnlyList<object>

Returns

double