Class

LiveRunOptionsFluent

ConsoleMonster.Live

Namespace: ConsoleMonster.Live
Assembly: ConsoleMonster
Modifiers: static
Attributes: GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of LiveRunOptions, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

object
LiveRunOptionsFluent

Methods

public static LiveRunOptions Configure(LiveRunOptions liveRunOptions, Action<LiveRunOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
configure System.Action<ConsoleMonster.Live.LiveRunOptions> required: Assignments applied in order.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { Clock = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().Configure(configured => configured.Clock = value);

public static LiveRunOptions HeightPercent(LiveRunOptions liveRunOptions, double value) #

Sets LiveRunOptions.HeightPercent: Maximum percentage of terminal height used by the dashboard, default 40. Header and problems share the available rows on very short terminals.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value double required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { HeightPercent = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().HeightPercent(value);

InteractiveKeys 2 overloads

public static LiveRunOptions InteractiveKeys(LiveRunOptions liveRunOptions, bool value) #

Sets LiveRunOptions.InteractiveKeys: Enable p/f/g/? keyboard controls when input is available. Default false.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value bool required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { InteractiveKeys = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().InteractiveKeys(value);

public static LiveRunOptions InteractiveKeys(LiveRunOptions liveRunOptions) #

Sets LiveRunOptions.InteractiveKeys to true.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance to configure.

Returns

LiveRunOptions The same instance.

Live 2 overloads

public static LiveRunOptions Live(LiveRunOptions liveRunOptions, bool value) #

Sets LiveRunOptions.Live: Allow live rendering when supported by the terminal; false selects append-only output.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value bool required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { Live = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().Live(value);

public static LiveRunOptions Live(LiveRunOptions liveRunOptions) #

Sets LiveRunOptions.Live to true.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance to configure.

Returns

LiveRunOptions The same instance.

public static LiveRunOptions ProgressEvery(LiveRunOptions liveRunOptions, int value) #

Sets LiveRunOptions.ProgressEvery: In append-only mode, emit progress after this many completions. Zero disables the count trigger.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value int required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ProgressEvery = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().ProgressEvery(value);

public static LiveRunOptions ProgressInterval(LiveRunOptions liveRunOptions, TimeSpan value) #

Sets LiveRunOptions.ProgressInterval: In append-only mode, emit progress at this interval even while items are slow. Zero disables the time trigger.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value System.TimeSpan required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ProgressInterval = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().ProgressInterval(value);

public static LiveRunOptions ReportPath(LiveRunOptions liveRunOptions, string? value) #

Sets LiveRunOptions.ReportPath: Optional report location included in the final summary.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value string? required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ReportPath = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().ReportPath(value);

Session 2 overloads

public static LiveRunOptions Session(LiveRunOptions liveRunOptions, LiveSessionOptions? value) #

Sets LiveRunOptions.Session: Exclusive configuration for this run's target, output, theme and capture. Do not share it with another session. The run sets inline mode, cooperative cancellation, ten frames per second, height limit and final summary.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value ConsoleMonster.Live.LiveSessionOptions? required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { Session = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().Session(value);

public static LiveRunOptions Session(LiveRunOptions liveRunOptions, Action<LiveSessionOptions> configure) #

Configures LiveRunOptions.Session in place (creating it when not set): Exclusive configuration for this run's target, output, theme and capture. Do not share it with another session. The run sets inline mode, cooperative cancellation, ten frames per second, height limit and final summary.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
configure System.Action<ConsoleMonster.Live.LiveSessionOptions> required: Configures the value.

Returns

LiveRunOptions The same instance.

ShowGroups 2 overloads

public static LiveRunOptions ShowGroups(LiveRunOptions liveRunOptions, bool value) #

Sets LiveRunOptions.ShowGroups: Show category progress when spare height is available.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value bool required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ShowGroups = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().ShowGroups(value);

public static LiveRunOptions ShowGroups(LiveRunOptions liveRunOptions) #

Sets LiveRunOptions.ShowGroups to true.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance to configure.

Returns

LiveRunOptions The same instance.

ShowTrend 2 overloads

public static LiveRunOptions ShowTrend(LiveRunOptions liveRunOptions, bool value) #

Sets LiveRunOptions.ShowTrend: Show a short throughput trend next to the rate.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value bool required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { ShowTrend = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().ShowTrend(value);

public static LiveRunOptions ShowTrend(LiveRunOptions liveRunOptions) #

Sets LiveRunOptions.ShowTrend to true.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance to configure.

Returns

LiveRunOptions The same instance.

public static LiveRunOptions Title(LiveRunOptions liveRunOptions, string value) #

Sets LiveRunOptions.Title: The literal run name.

Parameters

liveRunOptions ConsoleMonster.Live.LiveRunOptions required: The instance.
value string required: The value.

Returns

LiveRunOptions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Live.LiveRunOptions { Title = value };    Ui.Options<global::ConsoleMonster.Live.LiveRunOptions>().Title(value);

Inheritance

Methods

Inherited Methods