entviz — @entviz/core & @entviz/react API
    Preparing search index...

    Interface RenderOptions

    Options for render. Every field is optional; omitted fields fall back to the documented default.

    interface RenderOptions {
        fontSizePt?: number;
        note?: string | null;
        targetAr?: number;
    }
    Index
    fontSizePt?: number

    Reference font size in points, which scales the entire glyph (all pixel geometry derives from it). Must be between 6 and 30 inclusive.

    12

    note?: string | null

    Optional short caption rendered in the bottom label strip, e.g. to name the value. Must be printable ASCII and at most 10 characters; pass null (or omit) for no note. An out-of-range note is rejected.

    null (no caption)

    targetAr?: number

    Target aspect ratio (width / height) used to pick the token grid's shape. The renderer chooses the candidate grid whose natural ratio is closest to, and at or above, this value. Must be between 0.01 and 100 inclusive.

    1.0 (a roughly square glyph)