Skip to content
ConsoleMonster
Class

ViewFacts

ConsoleMonster.Widgets

Namespace
ConsoleMonster.Widgets
Assembly
ConsoleMonster
Implements
IWidget
Modifiers
sealed

The line under a default view that sums it up: 22 folders · 10 files · 117 KB. Values are presented like table cells (sizes, durations, dates), a sparkline or bar value draws inline, and lines break only between facts.

Inheritance

  • object
  • ViewFacts

Usage

Explore 12 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.

Returned or exposed by 6

Accepted by parameters 6

Constructors

ViewFacts 2 overloads
public ViewFacts() #

Creates an empty facts line.

public ViewFacts(IEnumerable<ViewFact> facts) #

Creates the line from facts.

Parameters

facts System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ViewFact> required

Methods

Add 2 overloads
public ViewFacts Add(ViewFact fact) #

Adds a complete fact descriptor.

Parameters

fact ConsoleMonster.Widgets.ViewFact required
The fact.

Returns

ViewFacts This line.
public ViewFacts Add(object? value, string? label = null, ThemeToken? role = null) #

Adds a value and its literal label, with an optional semantic colour.

Parameters

value object? required
The value, presented like a table cell.
label string? = null optional
The literal word after the value.
role ConsoleMonster.Styling.ThemeToken? = null optional
The semantic colour; null draws a neutral fact.

Returns

ViewFacts This facts line.
public Size Measure(Constraints constraints, RenderContext context) #

Returns the size the widget wants within the constraints.

Parameters

constraints ConsoleMonster.Layout.Constraints required
The space offered.
context ConsoleMonster.Canvas.RenderContext required
Profile, theme and glyphs.

Returns

Size The desired size, never larger than the constraints.
public void Render(Region region, RenderContext context) #

Renders into a region. The region may be smaller or larger than the measured size.

Parameters

region ConsoleMonster.Canvas.Region required
The target region.
context ConsoleMonster.Canvas.RenderContext required
Profile, theme and glyphs.

Properties

public List<ViewFact> Facts { get; } #

The facts in display order.

Extension Methods

public static ViewFacts AddFact(ViewFacts viewFacts, ViewFact item) #

Adds an item to ViewFacts.Facts: The facts in display order.

Parameters

viewFacts ConsoleMonster.Widgets.ViewFacts required
The instance.
item ConsoleMonster.Widgets.ViewFact required
The item.

Returns

ViewFacts The same instance.
AddFacts 2 overloads
public static ViewFacts AddFacts(ViewFacts viewFacts, params ViewFact[] items) #

Adds items to ViewFacts.Facts: The facts in display order.

Parameters

viewFacts ConsoleMonster.Widgets.ViewFacts required
The instance.
items ConsoleMonster.Widgets.ViewFact[] required
The items, in order.

Returns

ViewFacts The same instance.
public static ViewFacts AddFacts(ViewFacts viewFacts, IEnumerable<ViewFact> items) #

Adds items to ViewFacts.Facts: The facts in display order.

Parameters

viewFacts ConsoleMonster.Widgets.ViewFacts required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ViewFact> required
The items, in order.

Returns

ViewFacts The same instance.