LiveDisplay Class

Represents a live display.
public sealed class LiveDisplay
Namespace
Spectre.Console

Constructors

LiveDisplay(IAnsiConsole, IRenderable)
Initializes a new instance of the LiveDisplay class.

Properties

bool AutoClear
Gets or sets a value indicating whether or not the live display should be cleared when it's done. Defaults to false.
VerticalOverflowCropping Cropping
Gets or sets the vertical overflow cropping strategy.
VerticalOverflow Overflow
Gets or sets the vertical overflow strategy.

Methods

void Start(Action<LiveDisplayContext>)
Starts the live display.
T Start<T>(Func<LiveDisplayContext, T>)
Starts the live display.
Task StartAsync(Func<LiveDisplayContext, Task>)
Starts the live display.
Task<T> StartAsync<T>(Func<LiveDisplayContext, Task<T>>)
Starts the live display.

Extension Methods

T And<LiveDisplay>(Action<LiveDisplay>)
Performs the specified action on the given object and then returns the object. Useful for fluent testing patterns where additional assertions or operations are chained together in a readable manner.
LiveDisplay AutoClear(bool)
Sets whether or not auto clear is enabled. If enabled, the live display will be cleared when done.
LiveDisplay Cropping(VerticalOverflowCropping)
Sets the vertical overflow cropping strategy.
LiveDisplay Overflow(VerticalOverflow)
Sets the vertical overflow strategy.