Skip to content
ConsoleMonster

API Reference

Class

GlyphSetExtensions

Edit on GitHub
Namespace ConsoleMonster.Glyphs
Assembly ConsoleMonster
Source GlyphSetExtensions.cs:17
Modifiers static

Status symbols and the running spinner, shared by every widget (see Docs/Design-System.md).

Inheritance

  • Object
  • GlyphSetExtensions

Methods

public static String Icon(IGlyphSet glyphs, GlyphIcon icon) #
GlyphSetExtensions.cs:41
Returns: String

The text of a semantic icon in the glyph set's tier (see GlyphIcon). Custom glyph sets resolve by their IGlyphSet.Tier; the status icons (Warning, Done) use the set's own symbols.

Parameters

glyphs ConsoleMonster.Glyphs.IGlyphSet requiredposition: 0
The glyph set.
icon ConsoleMonster.Glyphs.GlyphIcon requiredposition: 1
The icon.

Returns

One cell of text.

public static String Spinner(RenderContext context, Int64 offset = 0) #
GlyphSetExtensions.cs:81
Returns: String

The running symbol for this frame: the tier's spinner, advanced by the session's tick (offset so neighbouring rows do not spin in step), or the static running glyph when the tier has no spinner. Every widget that shows running work (lanes, phases, status lists, activities, spinners) uses this one.

Parameters

context ConsoleMonster.Canvas.RenderContext requiredposition: 0
The render context.
offset System.Int64 = 0 optionalposition: 1
A per-row offset.

Returns

The symbol.

public static String StatusSymbol(IGlyphSet glyphs, StatusKind status) #
GlyphSetExtensions.cs:17
Returns: String

The one-cell symbol of a status in the glyph set's tier: ✓ ✗ ▴ – ● ○ ◆ (Full), the same in Basic, + x ! - * . i (ASCII). IGlyphSet.StatusMarker is the wider marker for status columns (bracketed words in ASCII).

Parameters

glyphs ConsoleMonster.Glyphs.IGlyphSet requiredposition: 0
The glyph set.
status ConsoleMonster.Styling.StatusKind requiredposition: 1
The status.

Returns

The symbol.