effect-tree - v1.0.36
    Preparing search index...

    Interface Theme

    A tree theme:

    • Maps drawing roles to actual glyphs and styles. For example, a theme could map the glyph role top-left-elbow, used when you need an elbow shape pointing top-left, to the glyph ┌, while another could map it to the glyph ╭.
    • Configures indent count. Indents used when moving from parent to child and set the horizontal spacing between adjacent tree levels.
    • Configures vertical spacing. Vertical spacing is added between nodes.
    • Can format nodes before drawing, for example to convert to string.
    interface Theme {
        formatter: (node: string) => string;
        glyphs: GlyphSet;
        indents: number;
        spacing: number;
    }
    Index

    Properties

    formatter glyphs indents spacing

    Properties

    formatter: (node: string) => string

    The formatting function can change the tree label before it is drawn.

    glyphs: GlyphSet

    A map of glyph role to glyphs that will be used to compose the tree.

    indents: number

    The number of times that the theme glyphs for the role indent will be repeated when indenting a part. Higher numbers increase the horizontal space between tree levels.

    spacing: number

    The number of empty lines added between vertical nodes. A higher number increases table vertical spacing between nodes.

    Settings

    Member Visibility

    On This Page

    Properties