ContextMenuEntry

• webVis API Reference
• ContextMenuEntry

Type alias ContextMenuEntry

ContextMenuEntry: {
    command?: ((nodeID, pointerInfo) => void);
    condition: ((nodeID, pointerInfo) => boolean);
    description?: string;
    highlight?: ((nodeID, pointerInfo) => void);
    iconID?: string;
    id?: string;
    label?: string;
    subEntries?: ContextMenuEntry[];
}

Defines the properties of an entry of a requested context menu.

This type is only used internally by the RequestContextMenuEvent event to request a context menu from the UI. To modify the context menu, use the related functions provided by the webvisUI API.

Type declaration

• Optional command?: ((nodeID, pointerInfo) => void)

  • • (nodeID, pointerInfo): void

    • Parameters

      • nodeID: number

      • pointerInfo: PointerInfo

      Returns void

• condition: ((nodeID, pointerInfo) => boolean)

  • • (nodeID, pointerInfo): boolean

    • Parameters

      • nodeID: number

      • pointerInfo: PointerInfo

      Returns boolean

• Optional description?: string

• Optional highlight?: ((nodeID, pointerInfo) => void)

  • • (nodeID, pointerInfo): void

    • Parameters

      • nodeID: number

      • pointerInfo: PointerInfo

      Returns void

• Optional iconID?: string

• Optional id?: string

• Optional label?: string

• Optional subEntries?: ContextMenuEntry[]