Class LGraphCanvas_UI

Implemented by

LGraphCanvas

Constructors

constructor

new LGraphCanvas_UI(): LGraphCanvas_UI
Returns LGraphCanvas_UI

Properties

`Static` alignNodes

alignNodes: ((nodes, direction, align_to?) => void) = ...

Type declaration

- (nodes, direction, align_to?): void
- Parameters
  - nodes: LGraphNode[]
    a list of nodes
  - direction: "top" | "bottom" | "left" | "right"
    Direction to align the nodes
  - Optional align_to: LGraphNode
    Node to align to (if null, align to the furthest node in the given direction)
  Returns void

`Static` boundaryNodesForSelection

boundaryNodesForSelection: (() => {
    bottom: LGraphNode;
    left: LGraphNode;
    right: LGraphNode;
    top: LGraphNode;
}) = ...

Determines the furthest nodes in each direction for the currently selected nodes

Type declaration

- (): {
      bottom: LGraphNode;
      left: LGraphNode;
      right: LGraphNode;
      top: LGraphNode;
  }
- Returns {
      bottom: LGraphNode;
      left: LGraphNode;
      right: LGraphNode;
      top: LGraphNode;
  }
  - bottom: LGraphNode
  - left: LGraphNode
  - right: LGraphNode
  - top: LGraphNode

Returns

`Static` getBoundaryNodes

getBoundaryNodes: ((nodes) => {
    bottom: LGraphNode;
    left: LGraphNode;
    right: LGraphNode;
    top: LGraphNode;
}) = ...

Determines the furthest nodes in each direction

Type declaration

- (nodes): {
      bottom: LGraphNode;
      left: LGraphNode;
      right: LGraphNode;
      top: LGraphNode;
  }
- Parameters
  - nodes: LGraphNode[]
    {LGraphNode[]} the nodes to from which boundary nodes will be extracted
  Returns {
      bottom: LGraphNode;
      left: LGraphNode;
      right: LGraphNode;
      top: LGraphNode;
  }
  - bottom: LGraphNode
  - left: LGraphNode
  - right: LGraphNode
  - top: LGraphNode

Returns

`Static` onGroupAdd

onGroupAdd: ContextMenuEventListener = ...

Create menu for Add Group

`Static` onGroupAlign

onGroupAlign: ((value, options, event, prev_menu) => void) = ...

Type declaration

- (value, options, event, prev_menu): void
- Parameters
  - value: any
  - options: any
  - event: MouseEventExt
  - prev_menu: ContextMenu
  Returns void

`Static` onMenuAdd

onMenuAdd: ((_value, _options, mouseEvent, prevMenu, callback?) => boolean) = ...

Create menu for Add Node

Type declaration

- (_value, _options, mouseEvent, prevMenu, callback?): boolean
- Parameters
  - _value: IContextMenuItem
  - _options: any
  - mouseEvent: any
  - prevMenu: any
  - Optional callback: ((node) => void)
    - (node): void
      Parameters
      node: LGraphNode
      Returns void
  Returns boolean

`Static` onMenuNodeClone

onMenuNodeClone: ContextMenuEventListener = ...

`Static` onMenuNodeCollapse

onMenuNodeCollapse: ContextMenuEventListener = ...

`Static` onMenuNodeToParentGraph

onMenuNodeToParentGraph: ContextMenuEventListener = ...

`Static` onMenuNodeToSubgraph

onMenuNodeToSubgraph: ContextMenuEventListener = ...

`Static` onMenuNodeToSubgraphInputs

onMenuNodeToSubgraphInputs: ContextMenuEventListener = ...

`Static` onMenuNodeToSubgraphOutputs

onMenuNodeToSubgraphOutputs: ContextMenuEventListener = ...

`Static` onMenuResizeNode

onMenuResizeNode: ContextMenuEventListener = ...

`Static` onNodeAlign

onNodeAlign: ((value, options, event, prev_menu, node) => void) = ...

Type declaration

- (value, options, event, prev_menu, node): void
- Parameters
  - value: any
  - options: any
  - event: MouseEventExt
  - prev_menu: ContextMenu
  - node: LGraphNode
  Returns void

`Static` onResizeNode

onResizeNode: ContextMenuEventListener = ...

`Static` onShowMenuNodeProperties

onShowMenuNodeProperties: ContextMenuEventListener = ...

`Static` onShowPropertyEditor

onShowPropertyEditor: ContextMenuEventListener = ...

`Static` showMenuNodeOptionalInputs

showMenuNodeOptionalInputs: ContextMenuEventListener = ...

`Static` showMenuNodeOptionalOutputs

showMenuNodeOptionalOutputs: ContextMenuEventListener = ...

Methods

checkPanels

checkPanels(this): void
Parameters
- this: LGraphCanvas
Returns void
- Defined in packages/core/src/LGraphCanvas_UI.ts:3896

closePanels

closePanels(): void
Returns void
- Defined in packages/core/src/LGraphCanvas_UI.ts:3920

createDialog

createDialog(this, html, options?): IGraphDialog
Parameters
- this: LGraphCanvas
- html: string
- options: GraphDialogOptions = ...
Returns IGraphDialog
- Defined in packages/core/src/LGraphCanvas_UI.ts:3081

createPanel

createPanel(title, options?): IGraphPanel
Parameters
- title: string
- options: {
      closable?: boolean;
      height?: number;
      onClose?: (() => void);
      onOpen?: (() => void);
      width?: number;
      window?: Window;
  } = {}
  - Optional closable?: boolean
  - Optional height?: number
  - Optional onClose?: (() => void)
    - (): void
      Returns void
  - Optional onOpen?: (() => void)
    - (): void
      Returns void
  - Optional width?: number
  - Optional window?: Window
Returns IGraphPanel
- Defined in packages/core/src/LGraphCanvas_UI.ts:3629

getCanvasMenuOptions

getCanvasMenuOptions(this): ContextMenuItem[]
Parameters
- this: LGraphCanvas
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphCanvas_UI.ts:3189

getGroupMenuOptions

getGroupMenuOptions(this, group): ContextMenuItem[]
Parameters
- this: LGraphCanvas
- group: LGraphGroup
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphCanvas_UI.ts:3421

getLinkMenuOptions

getLinkMenuOptions(this, link): ContextMenuItem[]
Parameters
- this: LGraphCanvas
- link: LLink
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphCanvas_UI.ts:2790

getNodeMenuOptions

getNodeMenuOptions(this, node): ContextMenuItem[]
Parameters
- this: LGraphCanvas
- node: LGraphNode
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphCanvas_UI.ts:3226

processContextMenu

processContextMenu(this, target, _event): void
Called when mouse right click
Parameters
- this: LGraphCanvas
- target: IContextMenuTarget<any>
- _event: Event
Returns void
- Defined in packages/core/src/LGraphCanvas_UI.ts:3449

prompt

prompt(this, title?, value, callback, event, multiline?, inputStyle?): IGraphDialog
Parameters
- this: LGraphCanvas
- title: string = ""
- value: any
- callback: Function
- event: any
- multiline: boolean = false
- inputStyle: Partial<CSSStyleDeclaration> = null
Returns IGraphDialog
- Defined in packages/core/src/LGraphCanvas_UI.ts:1292

showConnectionMenu

showConnectionMenu(this, opts?): boolean
Parameters
- this: LGraphCanvas
- opts: {
      e?: MouseEventExt;
      nodeFrom?: LGraphNode;
      nodeTo?: LGraphNode;
      slotFrom?: INodeSlot | SlotNameOrIndex;
      slotTo?: INodeSlot | SlotNameOrIndex;
  } = {}
  - Optional e?: MouseEventExt
  - Optional nodeFrom?: LGraphNode
  - Optional nodeTo?: LGraphNode
  - Optional slotFrom?: INodeSlot | SlotNameOrIndex
  - Optional slotTo?: INodeSlot | SlotNameOrIndex
Returns boolean
- Defined in packages/core/src/LGraphCanvas_UI.ts:2596

showEditPropertyValue

showEditPropertyValue(this, node, property, options?): IGraphDialog
Parameters
- this: LGraphCanvas
- node: LGraphNode
- property: any
- options: GraphDialogOptions = {}
Returns IGraphDialog
- Defined in packages/core/src/LGraphCanvas_UI.ts:2897

showLinkMenu

showLinkMenu(this, link, e): boolean
Parameters
- this: LGraphCanvas
- link: LLink
- e: any
Returns boolean
- Defined in packages/core/src/LGraphCanvas_UI.ts:2882

showSearchBox

showSearchBox(this, _event, options?): IGraphDialog
Parameters
- this: LGraphCanvas
- _event: MouseEvent
- options: {
      do_type_filter?: boolean;
      hide_on_mouse_leave?: boolean;
      node_from?: LGraphNode;
      node_to?: LGraphNode;
      show_all_if_empty?: boolean;
      show_all_on_open?: boolean;
      show_general_after_typefiltered?: boolean;
      show_general_if_none_on_typefilter?: boolean;
      slotFrom?: INodeSlot | SlotNameOrIndex;
      type_filter_in?: SlotType;
      type_filter_out?: SlotType;
  } = {}
  - Optional do_type_filter?: boolean
  - Optional hide_on_mouse_leave?: boolean
  - Optional node_from?: LGraphNode
  - Optional node_to?: LGraphNode
  - Optional show_all_if_empty?: boolean
  - Optional show_all_on_open?: boolean
  - Optional show_general_after_typefiltered?: boolean
  - Optional show_general_if_none_on_typefilter?: boolean
  - Optional slotFrom?: INodeSlot | SlotNameOrIndex
  - Optional type_filter_in?: SlotType
  - Optional type_filter_out?: SlotType
Returns IGraphDialog
- Defined in packages/core/src/LGraphCanvas_UI.ts:1458

showShowNodePanel

showShowNodePanel(this, node): void
Parameters
- this: LGraphCanvas
- node: LGraphNode
Returns void
- Defined in packages/core/src/LGraphCanvas_UI.ts:2147

showSubgraphPropertiesDialog

showSubgraphPropertiesDialog(this, node): ISubgraphPropertiesPanel
Parameters
- this: LGraphCanvas
- node: LGraphNode
Returns ISubgraphPropertiesPanel
- Defined in packages/core/src/LGraphCanvas_UI.ts:2325

showSubgraphPropertiesDialogRight

showSubgraphPropertiesDialogRight(this, node): ISubgraphPropertiesPanel
Parameters
- this: LGraphCanvas
- node: LGraphNode
Returns ISubgraphPropertiesPanel
- Defined in packages/core/src/LGraphCanvas_UI.ts:2461

`Static` onMenuCollapseAll

onMenuCollapseAll(): void
Returns void
- Defined in packages/core/src/LGraphCanvas_UI.ts:711

`Static` onMenuNodeEdit

onMenuNodeEdit(): void
Returns void
- Defined in packages/core/src/LGraphCanvas_UI.ts:712

Class LGraphCanvas_UI

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Returns LGraphCanvas_UI

Properties

Static alignNodes

Type declaration

Parameters

Returns void

Static boundaryNodesForSelection

Type declaration

Returns { bottom: LGraphNode; left: LGraphNode; right: LGraphNode; top: LGraphNode; }

bottom: LGraphNode

left: LGraphNode

right: LGraphNode

top: LGraphNode

Returns

Static getBoundaryNodes

Type declaration

Parameters

Returns { bottom: LGraphNode; left: LGraphNode; right: LGraphNode; top: LGraphNode; }

bottom: LGraphNode

left: LGraphNode

right: LGraphNode

top: LGraphNode

Returns

Static onGroupAdd

Static onGroupAlign

Type declaration

Parameters

Returns void

Static onMenuAdd

Type declaration

Parameters

Parameters

Returns void

Returns boolean

Static onMenuNodeClone

Static onMenuNodeCollapse

Static onMenuNodeColors

Static onMenuNodeMode

Static onMenuNodePin

Static onMenuNodeRemove

Static onMenuNodeShapes

Static onMenuNodeToParentGraph

Static onMenuNodeToSubgraph

Static onMenuNodeToSubgraphInputs

Static onMenuNodeToSubgraphOutputs

Static onMenuResizeNode

Static onNodeAlign

Type declaration

Parameters

Returns void

Static onResizeNode

Static onShowMenuNodeProperties

Static onShowPropertyEditor

Static showMenuNodeOptionalInputs

Static showMenuNodeOptionalOutputs

Methods

checkPanels

Parameters

Returns void

closePanels

Returns void

createDialog

Parameters

Returns IGraphDialog

createPanel

Parameters

Optional closable?: boolean

Optional height?: number

Optional onClose?: (() => void)

Returns void

Optional onOpen?: (() => void)

Returns void

`Static` alignNodes

`Static` boundaryNodesForSelection

Returns {
bottom: LGraphNode;
left: LGraphNode;
right: LGraphNode;
top: LGraphNode;
}

`Static` getBoundaryNodes

Returns {
bottom: LGraphNode;
left: LGraphNode;
right: LGraphNode;
top: LGraphNode;
}

`Static` onGroupAdd

`Static` onGroupAlign

`Static` onMenuAdd

`Static` onMenuNodeClone

`Static` onMenuNodeCollapse

`Static` onMenuNodeColors

`Static` onMenuNodeMode

`Static` onMenuNodePin

`Static` onMenuNodeRemove

`Static` onMenuNodeShapes

`Static` onMenuNodeToParentGraph

`Static` onMenuNodeToSubgraph

`Static` onMenuNodeToSubgraphInputs

`Static` onMenuNodeToSubgraphOutputs

`Static` onMenuResizeNode

`Static` onNodeAlign

`Static` onResizeNode

`Static` onShowMenuNodeProperties

`Static` onShowPropertyEditor

`Static` showMenuNodeOptionalInputs

`Static` showMenuNodeOptionalOutputs

`Optional` closable?: boolean

`Optional` height?: number

`Optional` onClose?: (() => void)

`Optional` onOpen?: (() => void)

`Optional` width?: number

`Optional` window?: Window

`Optional` e?: MouseEventExt

`Optional` nodeFrom?: LGraphNode

`Optional` nodeTo?: LGraphNode

`Optional` slotFrom?: INodeSlot | SlotNameOrIndex

`Optional` slotTo?: INodeSlot | SlotNameOrIndex

`Optional` do_type_filter?: boolean

`Optional` hide_on_mouse_leave?: boolean

`Optional` node_from?: LGraphNode

`Optional` node_to?: LGraphNode

`Optional` show_all_if_empty?: boolean

`Optional` show_all_on_open?: boolean

`Optional` show_general_after_typefiltered?: boolean

`Optional` show_general_if_none_on_typefilter?: boolean

`Optional` slotFrom?: INodeSlot | SlotNameOrIndex

`Optional` type_filter_in?: SlotType

`Optional` type_filter_out?: SlotType

`Static` onMenuCollapseAll

`Static` onMenuNodeEdit