g3-toolkit API Reference
    Preparing search index...

    Interface StructuralEdge

    An edge between structural nodes, optionally attaching to ports.

    interface StructuralEdge {
        id: string;
        kind?:
            | "association"
            | "composition"
            | "aggregation"
            | "generalization"
            | "dependency";
        label?: string;
        source: string;
        sourcePort?: string;
        target: string;
        targetPort?: string;
    }
    Index

    Properties

    id kind? label? source sourcePort? target targetPort?

    Properties

    id: string
    kind?:
        | "association"
        | "composition"
        | "aggregation"
        | "generalization"
        | "dependency"

    Optional UML relationship kind, driving the edge's arrow symbols (A3). Absent or "association" renders a plain arrow:

    • "composition": filled diamond at the SOURCE (whole) end.
    • "aggregation": hollow diamond at the source.
    • "generalization": hollow triangle at the TARGET (parent) end.
    • "dependency": open arrow, dashed line, at the target.
    • "association": plain arrow at the target (the default). The converter maps these to Cytoscape arrow shapes; structural scenes are not bound to the encoding grammar's node-shape channel (arrow shapes are an edge concern), so this is a direct mapping.
    label?: string

    Optional edge label (e.g. a SHACL sh:node property path, or a UML association role). Rendered as a mid-edge label.

    source: string
    sourcePort?: string

    When set, the edge attaches to this port id instead of the node body.

    target: string
    targetPort?: string

    Settings

    Member Visibility

    On This Page

    Properties