pivotick - v1.5.0
    Preparing search index...

    Interface PropertiesPanel

    Represents the configuration for the properties panel in the graph UI's sidebar

    Defines how to compute and display properties for nodes and edges.

    All key/value pairs from node.getData() or edge.getData()
    interface PropertiesPanel {
        edgePropertiesMap: (edge: Edge) => PropertyEntry[];
        nodePropertiesMap: (node: Node) => PropertyEntry[];
        render?:
            | string
            | HTMLElement
            | (
                (
                    element: Node | Edge | Node[] | Edge[] | null,
                ) => string | HTMLElement
            );
    }
    Index

    Properties

    edgePropertiesMap nodePropertiesMap render?

    Properties

    edgePropertiesMap: (edge: Edge) => PropertyEntry[]

    A function that computes the list of edge properties to display

    All key/value pairs from edge.getData()
    nodePropertiesMap: (node: Node) => PropertyEntry[]

    A function that computes the list of node properties to display

    All key/value pairs from node.getData()
    render?:
        | string
        | HTMLElement
        | ((element: Node | Edge | Node[] | Edge[] | null) => string | HTMLElement)

    Custom renderer for the property panel. This content will override the default sidebar property panel.

    undefined

    (element) => `element id: ${element.id}`

    A returned string renders as plain text; return an HTMLElement to render HTML.

    Settings

    Member Visibility

    On This Page

    Properties