g3-toolkit API Reference
    Preparing search index...

    Interface AlgorithmResultDocument

    interface AlgorithmResultDocument {
        algorithm?: string;
        kind: "nodeProperties" | "edgeProperties" | "overlay";
        overlay?: {
            edgeIds?: string[];
            id: string;
            label?: string;
            nodeIds?: string[];
            tone?: string;
        };
        properties?: Record<string, Record<string, unknown>>;
        version: 1;
    }
    Index

    Properties

    algorithm? kind overlay? properties? version

    Properties

    algorithm?: string

    Provenance label, e.g. "networkx.pagerank", "graphblas.bfs".

    kind: "nodeProperties" | "edgeProperties" | "overlay"
    overlay?: {
        edgeIds?: string[];
        id: string;
        label?: string;
        nodeIds?: string[];
        tone?: string;
    }

    For overlay kind: the structural result.

    Type Declaration

    • OptionaledgeIds?: string[]
    • id: string
    • Optionallabel?: string
    • OptionalnodeIds?: string[]
    • Optionaltone?: string

      Optional rendering hint; see OverlayTone. An unrecognized value is dropped rather than rejected, so a document from a newer producer still loads with neutral emphasis.

    properties?: Record<string, Record<string, unknown>>

    For property kinds: elementId -> properties to merge.

    version: 1

    Settings

    Member Visibility

    On This Page

    Properties