Skip to content
ConsoleMonster

API Reference

Interface

IGlyphSet

Edit on GitHub
Namespace ConsoleMonster.Glyphs
Assembly ConsoleMonster
Source IGlyphSet.cs:9
Modifiers abstract

Resolves semantic glyphs for one tier. Implement it for a custom set, or wrap a built-in one.

Usage

Explore 11 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 1

Accepted by parameters 10

Methods

public abstract String Get(Glyph glyph) #
Returns: String

Returns a semantic glyph.

Parameters

glyph ConsoleMonster.Glyphs.Glyph requiredposition: 0
The glyph name.

Returns

The text (may be wider than one cell, for example tree prefixes or ASCII ellipsis).

public abstract BoxGlyphs GetBox(BoxStyle style) #
Returns: BoxGlyphs

Returns border glyphs, falling back to a style the tier can show.

Parameters

style ConsoleMonster.Glyphs.BoxStyle requiredposition: 0
The requested style.

Returns

The border glyphs actually used.

public abstract String HorizontalFill(Int32 eighths) #
Returns: String

A partial horizontal block for eighths of a cell (1-8), or empty when the tier cannot show it.

Parameters

eighths System.Int32 requiredposition: 0
Filled eighths, 1-8.

Returns

The glyph, or an empty string.

public abstract String StatusMarker(StatusKind status) #
Returns: String

The marker shown for a status. Full and Basic return one symbol; Ascii returns a bracketed word such as [PASS] so status stays readable without colour.

Parameters

status ConsoleMonster.Styling.StatusKind requiredposition: 0
The status.

Returns

The marker text.

public abstract String VerticalFill(Int32 eighths) #
Returns: String

A partial vertical block for eighths of a cell (1-8), or empty when the tier cannot show it.

Parameters

eighths System.Int32 requiredposition: 0
Filled eighths, 1-8.

Returns

The glyph, or an empty string.

Properties

public abstract GlyphTier Tier { get; } #

The tier this set targets.

public abstract Boolean SupportsBraille { get; } #

Whether braille patterns (U+2800-U+28FF) render reliably.

public abstract Boolean SupportsHalfBlocks { get; } #

Whether half blocks (▀▄) render reliably.

public abstract IReadOnlyList<String> SpinnerFrames { get; } #

Spinner animation frames.

public abstract IReadOnlyList<String> VerticalRamp { get; } #

Vertical levels from empty (index 0) to full (last index), used by sparklines.

Extension 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 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.