Skip to content
ConsoleMonster
Class

OverviewWidget

ConsoleMonster.Overview

Namespace
ConsoleMonster.Overview
Assembly
ConsoleMonster
Implements
IWidget
Modifiers
sealed

A compact host overview composed from the existing panel, row, column and progress widgets.

Inheritance

  • object
  • OverviewWidget

Constructors

public OverviewWidget(OverviewSnapshot snapshot) #

Creates a print-once view of an immutable host snapshot.

Parameters

snapshot ConsoleMonster.Overview.OverviewSnapshot required
The data to render; text is displayed literally.

Methods

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 OverviewSnapshot Snapshot { get; } #

The snapshot rendered by this widget.