Skip to content
ConsoleMonster

API Reference

Class

ChangeView

Edit on GitHub
Namespace ConsoleMonster.Changes
Assembly ConsoleMonster
Source ChangeView.cs:70
Implements
IWidget
Modifiers sealed

Shows a ChangeSet in the design-system tones: added in the pass colour (+), removed in the fail colour (-), changed in the warning colour (~).

Inheritance

  • Object
  • ChangeView

Usage

Explore 20 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 10

Accepted by parameters 10

Constructors

public ChangeView(ChangeSet changes, ChangeViewMode mode = Full) #
ChangeView.cs:70

Creates a change view.

Parameters

changes ConsoleMonster.Changes.ChangeSet requiredposition: 0
The changes.
mode ConsoleMonster.Changes.ChangeViewMode = Full optionalposition: 1
The view.

Methods

public Size Measure(Constraints constraints, RenderContext context) #
ChangeView.cs:82
Returns: Size

Returns the size the widget wants within the constraints.

Parameters

constraints ConsoleMonster.Layout.Constraints requiredposition: 0
The space offered.
context ConsoleMonster.Canvas.RenderContext requiredposition: 1
Profile, theme and glyphs.

Returns

The desired size, never larger than the constraints.

public Void Render(Region region, RenderContext context) #
ChangeView.cs:85
Returns: Void

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

Parameters

region ConsoleMonster.Canvas.Region requiredposition: 0
The target region.
context ConsoleMonster.Canvas.RenderContext requiredposition: 1
Profile, theme and glyphs.
public static IReadOnlyList<DiffLine> TextDiff(String? before, String? after) #
ChangeView.cs:92
Returns: IReadOnlyList<DiffLine>

A line diff of two texts (longest common subsequence over lines).

Parameters

before System.String? requiredposition: 0
The old text.
after System.String? requiredposition: 1
The new text.

Returns

The lines in order.

Properties

public ChangeSet Changes { get; } #
ChangeView.cs:61

The changes.

public ChangeViewMode Mode { get; set; } #
ChangeView.cs:64

The view.

public String? Title { get; set; } #
ChangeView.cs:67

A title above the view (markup), or null.

public Int32 LongValue { get; set; } #
ChangeView.cs:70

Values longer than this many cells (or with line breaks) show as a line diff instead of in the table (default 60).

public Int32 MaxProperties { get; set; } #
ChangeView.cs:76

The most lines an added or removed object takes in the table, one per compared property (default 6, 0 for no limit); beyond it the last line says "+N more" with ChangeView.MoreHint. The side-by-side view lists all.

public String? MoreHint { get; set; } #
ChangeView.cs:79

Plain text after "+N more" saying where to see every value (Show-ConsoleChanges: "-PassThru or -View SideBySide"), or null.

Extension Methods

public static ChangeView WithLongValue(ChangeView changeView, Int32 value) #
Returns: ChangeView

Sets ChangeView.LongValue: Values longer than this many cells (or with line breaks) show as a line diff instead of in the table (default 60).

Parameters

changeView ConsoleMonster.Changes.ChangeView requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static ChangeView WithMaxProperties(ChangeView changeView, Int32 value) #
Returns: ChangeView

Sets ChangeView.MaxProperties: The most lines an added or removed object takes in the table, one per compared property (default 6, 0 for no limit); beyond it the last line says "+N more" with ChangeView.MoreHint. The side-by-side view lists all.

Parameters

changeView ConsoleMonster.Changes.ChangeView requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static ChangeView WithMode(ChangeView changeView, ChangeViewMode value) #
Returns: ChangeView

Sets ChangeView.Mode: The view.

Parameters

changeView ConsoleMonster.Changes.ChangeView requiredposition: 0
The instance.
value ConsoleMonster.Changes.ChangeViewMode requiredposition: 1
The value.

Returns

The same instance.

public static ChangeView WithMoreHint(ChangeView changeView, String? value) #
Returns: ChangeView

Sets ChangeView.MoreHint: Plain text after "+N more" saying where to see every value (Show-ConsoleChanges: "-PassThru or -View SideBySide"), or null.

Parameters

changeView ConsoleMonster.Changes.ChangeView requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static ChangeView WithTitle(ChangeView changeView, String? value) #
Returns: ChangeView

Sets ChangeView.Title: A title above the view (markup), or null.

Parameters

changeView ConsoleMonster.Changes.ChangeView requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.