Skip to content
ConsoleMonster

API Reference

Class

GlyphSet

Namespace ConsoleMonster.Glyphs
Assembly ConsoleMonster
Implements
Modifiers sealed

The built-in glyph sets. GlyphSet.Full needs a modern font (Cascadia, JetBrains Mono, DejaVu); GlyphSet.Basic stays inside the WGL4 repertoire that Consolas and Lucida Console cover; GlyphSet.Ascii is printable ASCII only.

Inheritance

  • Object
  • GlyphSet

Usage

Explore 4 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 4

Methods

public static GlyphSet For(GlyphTier tier) #
Returns: GlyphSet

Returns the built-in set for a tier.

Parameters

tier ConsoleMonster.Capabilities.GlyphTier requiredposition: 0
The tier.

Returns

The glyph set.

public 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 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 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 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 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 static GlyphSet Full { get; } #

Braille, eighth blocks and rounded corners. Needs Cascadia, JetBrains Mono, DejaVu, Menlo or similar.

public static GlyphSet Basic { get; } #

Box drawing, shades and half blocks from the WGL4 repertoire (Consolas, Lucida Console).

public static GlyphSet Ascii { get; } #

Printable ASCII only; statuses become bracketed words.

public GlyphTier Tier { get; } #

The tier this set targets.

public Boolean SupportsBraille { get; } #

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

public Boolean SupportsHalfBlocks { get; } #

Whether half blocks (▀▄) render reliably.

public IReadOnlyList<String> SpinnerFrames { get; } #

Spinner animation frames.

public IReadOnlyList<String> VerticalRamp { get; } #

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