ContextMenuEntry

Interface 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.

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

Properties

command? condition description? highlight? iconID? id? label? subEntries?

Properties

Optionalcommand

command?: (nodeID: number, pointerInfo: PointerInfo) => void

condition

condition: (nodeID: number, pointerInfo: PointerInfo) => boolean

Optionaldescription

description?: string

Optionalhighlight

highlight?: (nodeID: number, pointerInfo: PointerInfo) => void

OptionaliconID

iconID?: string

Optionalid

id?: string

Optionallabel

label?: string

OptionalsubEntries

subEntries?: ContextMenuEntry[]