issue_tree
    Preparing search index...

    Interface RenderCommand

    Parsed render invocation.

    interface RenderCommand {
        cachePath: string;
        childOfGates: boolean;
        concentrate?: boolean;
        edgeMinlen?: number;
        edgeStyle: EdgeStyle;
        engine?: GraphvizEngine;
        format: OutputFormat;
        graphMargin?: number;
        graphPad?: number;
        issueShape?:
            | "box"
            | "polygon"
            | "ellipse"
            | "oval"
            | "circle"
            | "egg"
            | "triangle"
            | "diamond"
            | "trapezium"
            | "parallelogram"
            | "house"
            | "pentagon"
            | "hexagon"
            | "septagon"
            | "octagon"
            | "doublecircle"
            | "doubleoctagon"
            | "tripleoctagon"
            | "Mdiamond"
            | "Msquare"
            | "Mcircle"
            | "square"
            | "star"
            | "note"
            | "tab"
            | "folder"
            | "box3d"
            | "component"
            | "cylinder"
            | "rectangle";
        labels: string[];
        milestone: string
        | undefined;
        nodeMargin?: string;
        nodesep?: number;
        out: string | undefined;
        packmode: "off" | "node" | "clust" | "graph" | "array";
        prShape?:
            | "box"
            | "polygon"
            | "ellipse"
            | "oval"
            | "circle"
            | "egg"
            | "triangle"
            | "diamond"
            | "trapezium"
            | "parallelogram"
            | "house"
            | "pentagon"
            | "hexagon"
            | "septagon"
            | "octagon"
            | "doublecircle"
            | "doubleoctagon"
            | "tripleoctagon"
            | "Mdiamond"
            | "Msquare"
            | "Mcircle"
            | "square"
            | "star"
            | "note"
            | "tab"
            | "folder"
            | "box3d"
            | "component"
            | "cylinder"
            | "rectangle";
        rankdir: RankDir;
        ranksep?: number;
        rasterMax: number;
        repos: string[];
        scope: Scope;
        splines?: Splines;
        state: StateFilter;
        subcommand: "render";
    }
    Index

    Properties

    cachePath childOfGates concentrate? edgeMinlen? edgeStyle engine? format graphMargin? graphPad? issueShape? labels milestone nodeMargin? nodesep? out packmode prShape? rankdir ranksep? rasterMax repos scope splines? state subcommand

    Properties

    cachePath: string

    Cache file path to read. Defaults to ./issue-tree-cache.json.

    childOfGates: boolean

    When true, open child-of edges count as gating for the parent's status.

    concentrate?: boolean

    When true, merge parallel edges with shared endpoints.

    edgeMinlen?: number

    Minimum rank distance per edge. Graphviz default 1.

    edgeStyle: EdgeStyle

    How edges are visually distinguished; defaults to 'color'.

    engine?: GraphvizEngine

    Graphviz layout engine; undefined uses the engine's default.

    format: OutputFormat

    Resolved output format (explicit --format, inferred from --out extension, or default svg).

    graphMargin?: number

    Outer page margin, in inches. Graphviz default 0.5.

    graphPad?: number

    Outer pad around the whole graph, in inches. Graphviz default ~0.055.

    issueShape?:
        | "box"
        | "polygon"
        | "ellipse"
        | "oval"
        | "circle"
        | "egg"
        | "triangle"
        | "diamond"
        | "trapezium"
        | "parallelogram"
        | "house"
        | "pentagon"
        | "hexagon"
        | "septagon"
        | "octagon"
        | "doublecircle"
        | "doubleoctagon"
        | "tripleoctagon"
        | "Mdiamond"
        | "Msquare"
        | "Mcircle"
        | "square"
        | "star"
        | "note"
        | "tab"
        | "folder"
        | "box3d"
        | "component"
        | "cylinder"
        | "rectangle"

    Graphviz shape name used for issue nodes.

    labels: string[]

    Restrict to issues carrying one of these labels; empty keeps all.

    milestone: string | undefined

    Restrict to this milestone title; undefined keeps all.

    nodeMargin?: string

    Per-node text padding inside boxes, as "x" or "x,y". Graphviz default "0.11,0.055".

    nodesep?: number

    Gap between nodes in the same rank, in inches. Graphviz default 0.25.

    out: string | undefined

    Output path, or undefined to write text formats to stdout / binary formats to a synthesised filename.

    packmode: "off" | "node" | "clust" | "graph" | "array"

    Disconnected-component 2D packing mode; defaults to 'node' (shelf packing).

    prShape?:
        | "box"
        | "polygon"
        | "ellipse"
        | "oval"
        | "circle"
        | "egg"
        | "triangle"
        | "diamond"
        | "trapezium"
        | "parallelogram"
        | "house"
        | "pentagon"
        | "hexagon"
        | "septagon"
        | "octagon"
        | "doublecircle"
        | "doubleoctagon"
        | "tripleoctagon"
        | "Mdiamond"
        | "Msquare"
        | "Mcircle"
        | "square"
        | "star"
        | "note"
        | "tab"
        | "folder"
        | "box3d"
        | "component"
        | "cylinder"
        | "rectangle"

    Graphviz shape name used for pull-request nodes.

    rankdir: RankDir

    Graph rank direction; defaults to 'lr'.

    ranksep?: number

    Gap between ranks, in inches. Graphviz default 0.5.

    rasterMax: number

    Max pixel dimension on the longer axis for png/jpeg raster output.

    repos: string[]

    Restrict to these repos ("owner/repo"); empty keeps all.

    scope: Scope

    How widely to keep nodes around the metadata-passing set.

    splines?: Splines

    Edge routing; undefined uses the DOT default ('curved').

    state: StateFilter

    Raw GitHub state filter; defaults to 'all'.

    subcommand: "render"

    Discriminator: identifies this as a render command.

    Settings

    Member Visibility

    On This Page

    Properties