Viv JavaScript Runtime - v0.10.2
    Preparing search index...

    Interface ConstructSiftingMatchDiagramArgs

    Arguments parameterizing a request to construct a sifting-match diagram.

    These are the effective arguments to constructSiftingMatchDiagram.

    interface ConstructSiftingMatchDiagramArgs {
        siftingMatch: SiftingMatch;
        ansi?: boolean;
        elide?: boolean;
        formatLabel?: (actionID: string) => string;
        maxChildren?: number;
    }
    Index

    Properties

    siftingMatch: SiftingMatch

    The sifting match to visualize, as returned by runSiftingPattern.

    ansi?: boolean

    Whether to include ANSI escape codes for terminal highlighting.

    When enabled, matched actions are styled in role-specific colors and glue actions are dimmed.

    false
    
    elide?: boolean

    Whether to elide unmatched actions from the diagram.

    When enabled (by default), only the actions matched by the sifting pattern are rendered as named nodes in the tree diagram -- all other actions will be marked by elision indicators, as described in constructSiftingMatchDiagram.

    When disabled, the full causal spanning tree connecting all matched actions is rendered, with every intermediate (glue) action visible.

    Warning: In large simulations, a spanning tree may contain many thousands of actions, so take care before setting this to false.

    true
    
    formatLabel?: (actionID: string) => string

    An optional callback that renders the label for each node in the diagram.

    The callback receives the action's entity ID, and should return a string to use as the node label. If omitted, the action name is used as the label.

    The callback must be synchronous.

    maxChildren?: number

    Maximum number of children to render per node.

    If omitted, all children are rendered.

    Infinity