Class LGraphNode

https://github.com/lenML/litegraph.ts/blob/master/GUIDE.md#lgraphnode

Hierarchy (view full)

LGraphNode

Index

Constructors

constructor

new LGraphNode(title?): LGraphNode
Parameters
- Optional title: string
Returns LGraphNode
- Defined in packages/core/src/LGraphNode.ts:211

Properties

`Optional` _collapsed_width

_collapsed_width?: number

_level

_level: number

_relative_id

_relative_id: NodeID = null

action_call

action_call: string = null

action_triggered

action_triggered: number = 0

the nFrames it will be used (-- each step), means "how old" is the event

bgcolor

bgcolor: string

block_delete

block_delete: boolean = false

boxcolor

boxcolor: string

class

class: (new () => LGraphNode)

Type declaration

- new (): LGraphNode
- Returns LGraphNode

clip_area

clip_area: boolean

if you render outside the node, it will be clipped

clonable

clonable: boolean = true

collapsable

collapsable: boolean = true

color

color: string

connections

connections: INodeConnection[]

`Private` console

console: string[] = []

desc

desc: string = ""

disposed

disposed: Disposable = ...

dom_anchors

dom_anchors: {
    bottom_center?: HTMLElement;
    bottom_left?: HTMLElement;
    bottom_right?: HTMLElement;
    middle_center?: HTMLElement;
    middle_left?: HTMLElement;
    middle_right?: HTMLElement;
    top_center?: HTMLElement;
    top_left?: HTMLElement;
    top_right?: HTMLElement;
} = {}

Type declaration

Optional bottom_center?: HTMLElement
Optional bottom_left?: HTMLElement
Optional bottom_right?: HTMLElement
Optional middle_center?: HTMLElement
Optional middle_left?: HTMLElement
Optional middle_right?: HTMLElement
Optional top_center?: HTMLElement
Optional top_left?: HTMLElement
Optional top_right?: HTMLElement

events

events: EventEmitter<{
    added: (() => void);
    changeMode: ((mode, before) => void);
    deselected: (() => void);
    drop: ((e) => void);
    dropFile: ((file) => void);
    execute: (() => void);
    keyDown: ((e) => void);
    keyUp: ((e) => void);
    mouseEnter: ((e) => void);
    mouseLeave: ((e) => void);
    mouseMove: ((e) => void);
    mouseUp: ((e) => void);
    nodeOptionalInputAdd: ((slot) => void);
    nodeOptionalOutputAdd: ((slot) => void);
    propertyChanged: ((k, v, prev_v) => void);
    removed: ((options?) => void);
    resize: ((size) => void);
    selected: (() => void);
    widgetChanged: ((widget, value, old) => void);
}> = ...

Type declaration

added: (() => void)
- - (): void
  - Returns void
changeMode: ((mode, before) => void)
- - (mode, before): void
  - Parameters
    - mode: NodeMode
    - before: NodeMode
    Returns void
deselected: (() => void)
- - (): void
  - Returns void
drop: ((e) => void)
- - (e): void
  - Parameters
    - e: DragEvent
    Returns void
dropFile: ((file) => void)
- - (file): void
  - Parameters
    - file: File
    Returns void
execute: (() => void)
- - (): void
  - Returns void
keyDown: ((e) => void)
- - (e): void
  - Parameters
    - e: KeyboardEvent
    Returns void
keyUp: ((e) => void)
- - (e): void
  - Parameters
    - e: KeyboardEvent
    Returns void
mouseEnter: ((e) => void)
- - (e): void
  - Parameters
    - e: MouseEventExt
    Returns void
mouseLeave: ((e) => void)
- - (e): void
  - Parameters
    - e: MouseEventExt
    Returns void
mouseMove: ((e) => void)
- - (e): void
  - Parameters
    - e: MouseEventExt
    Returns void
mouseUp: ((e) => void)
- - (e): void
  - Parameters
    - e: MouseEventExt
    Returns void
nodeOptionalInputAdd: ((slot) => void)
- - (slot): void
  - Parameters
    - slot: INodeInputSlot
    Returns void
nodeOptionalOutputAdd: ((slot) => void)
- - (slot): void
  - Parameters
    - slot: INodeOutputSlot
    Returns void
propertyChanged: ((k, v, prev_v) => void)
- - (k, v, prev_v): void
  - Parameters
    - k: string
    - v: any
    - prev_v: any
    Returns void
removed: ((options?) => void)
- - (options?): void
  - Parameters
    - Optional options: LGraphRemoveNodeOptions
    Returns void
resize: ((size) => void)
- - (size): void
  - Parameters
    - size: Vector2
    Returns void
selected: (() => void)
- - (): void
  - Returns void
widgetChanged: ((widget, value, old) => void)
- - (widget, value, old): void
  - Parameters
    - widget: IWidget<any, any>
    - value: any
    - old: any
    Returns void

exec_version

exec_version: number = 0

execute_triggered

execute_triggered: number = 0

the nFrames it will be used (-- each step), means "how old" is the event

flags

flags: Partial<{
    collapsed: boolean;
    pinned: boolean;
    skip_repeated_outputs: boolean;
}> = {}

Type declaration

collapsed: boolean
pinned: boolean
skip_repeated_outputs: boolean

graph

graph: LGraph

graph_version

graph_version: number

`Optional` has_errors

has_errors?: boolean

if true, the node will show the bgcolor as 'red'

hide_in_node_lists

hide_in_node_lists: boolean = false

highlight

highlight: {
    color: string;
    enabled: boolean;
    width: number;
} = ...

highlight draw in drawNodeHighlight

Type declaration

color: string
enabled: boolean
width: number

horizontal

horizontal: boolean

slots are distributed horizontally

id

id: NodeID

ignore_remove

ignore_remove: boolean = false

inputs

inputs: INodeInputSlot[]

is_selected

is_selected: boolean

last_errors

last_errors: any[] = null

last_execution_error

last_execution_error: any = null

`Optional` last_serialization

last_serialization?: SerializedLGraphNode<LGraphNode> = null

`Optional` mode

mode?: NodeMode

Used in LGraphCanvas.onMenuNodeMode

mouseOver

mouseOver: boolean

order

order: number

outputs

outputs: INodeOutputSlot[]

pos

pos: Vector2 = ...

priority

priority: number = 0

computeExecutionOrder sorts by priority first, then order if priorities are the same

progress

progress: {
    current: number;
    message: string;
    running: boolean;
    total: number;
} = ...

progress draw in drawNodeHighlight

Type declaration

current: number
message: string
running: boolean
total: number

properties

properties: Record<string, any>

properties_info

properties_info: IProperty[]

redraw_on_mouse

redraw_on_mouse: boolean

removable

removable: boolean = true

resizable

resizable: boolean

if set to false it wont be resizable with the mouse

serialize_widgets

serialize_widgets: boolean = false

shape

shape: number = BuiltInSlotShape.ROUND_SHAPE

size

size: Vector2

skip_subgraph_button

skip_subgraph_button: boolean = false

subgraph

subgraph: LGraph = null

title

title: string

titleMode

titleMode: TitleMode = TitleMode.NORMAL_TITLE

type

type: string

widgets

widgets: IWidget<any, any>[]

widgets_start_y

widgets_start_y: number

widgets start at y distance from the top of the node

widgets_up

widgets_up: boolean

If set to true widgets do not start after the slots

`Optional` widgets_values

widgets_values?: any[]

`Static` MAX_CONSOLE

MAX_CONSOLE: number = 100

`Static` title

title: string

`Static` title_color

title_color: string

`Static` type

type: string

`Static` widgets_up

widgets_up: boolean

Accessors

propertyLayout

get propertyLayout(): PropertyLayout
Returns PropertyLayout
- Defined in packages/core/src/LGraphNode.ts:193

slotLayout

get slotLayout(): SlotLayout
Returns SlotLayout
- Defined in packages/core/src/LGraphNode.ts:187

widgetLayout

get widgetLayout(): WidgetLayout
Returns WidgetLayout
- Defined in packages/core/src/LGraphNode.ts:199

Methods

actionDo

actionDo(action, param, options?): void
Triggers an action, wrapped by logics to control execution flow
Parameters
- action: any
  name
- param: any
- options: LActionOptions = {}
Returns void
Method
actionDo
- Defined in packages/core/src/LGraphNode.ts:1373

addConnection

addConnection(name, type, pos, direction): INodeConnection
add an special connection to this node (used for special kinds of graphs)
Parameters
- name: string
- type: string
  string defining the input type ("vec3","number",...)
- pos: Vector2
  position of the connection inside the node
- direction: string
  if is input or output
Returns INodeConnection
- Defined in packages/core/src/LGraphNode.ts:1814

addCustomWidget

addCustomWidget<T>(customWidget): T
Type Parameters
- T extends IWidget<any, any, T>
Parameters
- customWidget: T
Returns T
- Defined in packages/core/src/LGraphNode.ts:2072

addInput

addInput(name, type?, extra_info?): INodeInputSlot
add a new input slot to use in this node
Parameters
- name: string
- type: SlotType = BuiltInSlotType.DEFAULT
  string defining the input type ("vec3","number",...), it its a generic one use 0
- Optional extra_info: Partial<INodeInputSlot>
  this can be used to have special properties of an input (label, color, position, etc)
Returns INodeInputSlot
- Defined in packages/core/src/LGraphNode.ts:1719

addOnExecutedOutput

addOnExecutedOutput(): number
Returns number
- Defined in packages/core/src/LGraphNode.ts:1278

addOnTriggerInput

addOnTriggerInput(): number
Returns number
- Defined in packages/core/src/LGraphNode.ts:1256

addOutput

addOutput(name, type?, extra_info?): INodeOutputSlot
add a new output slot to use in this node
Parameters
- name: string
- type: SlotType = BuiltInSlotType.DEFAULT
  string defining the output type ("vec3","number",...)
- Optional extra_info: Partial<INodeOutputSlot>
  this can be used to have special properties of an output (label, special color, position, etc)
Returns INodeOutputSlot
- Defined in packages/core/src/LGraphNode.ts:1612

addProperty

addProperty(name, default_value, type?, extra_info?): IProperty
add a new property to this node
Parameters
- name: string
- default_value: any
- Optional type: string
  string defining the output type ("vec3","number",...)
- Optional extra_info: Partial<IPropertyInfo>
  this can be used to have special properties of the property (like values, etc)
Returns IProperty
- Defined in packages/core/src/LGraphNode.ts:1579

addWidget

addWidget(type, name, value, callback?, options?): IToggleWidget
https://github.com/lenML/litegraph.ts/blob/master/GUIDE.md#node-widgets
Parameters
- type: "toggle"
- name: string
- value: boolean
- Optional callback: string | WidgetCallback<IToggleWidget>
- Optional options: IToggleWidgetOptions
Returns IToggleWidget
created widget
- Defined in packages/core/src/LGraphNode.ts:1973
addWidget(type, name, value, callback?, options?): ISliderWidget
Parameters
- type: "slider"
- name: string
- value: number
- Optional callback: string | WidgetCallback<ISliderWidget>
- Optional options: ISliderWidgetOptions
Returns ISliderWidget
- Defined in packages/core/src/LGraphNode.ts:1980
addWidget(type, name, value, callback?, options?): INumberWidget
Parameters
- type: "number"
- name: string
- value: number
- Optional callback: string | WidgetCallback<INumberWidget>
- Optional options: INumberWidgetOptions
Returns INumberWidget
- Defined in packages/core/src/LGraphNode.ts:1987
addWidget(type, name, value, callback?, options?): ITextWidget
Parameters
- type: "text"
- name: string
- value: string
- Optional callback: string | WidgetCallback<ITextWidget>
- Optional options: WidgetPanelOptions
Returns ITextWidget
- Defined in packages/core/src/LGraphNode.ts:1994
addWidget(type, name, value, callback?, options?): IEnumWidget
Parameters
- type: "enum"
- name: string
- value: string[]
- Optional callback: string | WidgetCallback<IEnumWidget>
- Optional options: IEnumWidgetOptions
Returns IEnumWidget
- Defined in packages/core/src/LGraphNode.ts:2001
addWidget(type, name, value, callback?, options?): IButtonWidget
Parameters
- type: "button"
- name: string
- value: null
- Optional callback: string | WidgetCallback<IButtonWidget>
- Optional options: WidgetPanelOptions
Returns IButtonWidget
- Defined in packages/core/src/LGraphNode.ts:2008

alignToGrid

alignToGrid(): void
Force align to grid

Returns void
- Defined in packages/core/src/LGraphNode.ts:3345

captureInput

captureInput(v): void
Allows to get onMouseMove and onMouseUp events even if the mouse is out of focus
Parameters
- v: any
Returns void
- Defined in packages/core/src/LGraphNode.ts:3392

changeMode

changeMode(modeTo): boolean
Parameters
- modeTo: NodeMode
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:1310

clearTriggeredSlot

clearTriggeredSlot(slot, link_id?): void
clears the trigger slot animation
Parameters
- slot: number
  the index of the output slot
- Optional link_id: LinkID
  in case you want to trigger and specific output link in a slot
Returns void
- Defined in packages/core/src/LGraphNode.ts:1512

clone

clone(cloneData?): LGraphNode
Creates a clone of this node
Parameters
- cloneData: LGraphNodeCloneData = ...
Returns LGraphNode
- Defined in packages/core/src/LGraphNode.ts:589

collapse

collapse(force?): void
Collapse the node to make it smaller on the canvas
Parameters
- force: boolean = false
Returns void
- Defined in packages/core/src/LGraphNode.ts:3424

computeSize

computeSize(out?): Vector2
computes the size of a node according to its inputs and output slots
Parameters
- out: Vector2 = ...
Returns Vector2
- Defined in packages/core/src/LGraphNode.ts:1832

configure

configure(info): void
configure a node from an object containing the serialized info
Parameters
- info: SerializedLGraphNode<LGraphNode>
Returns void
- Defined in packages/core/src/LGraphNode.ts:397

connect

connect<T>(slot, targetNode, targetSlot): T
connect this node output to the input of another node
Type Parameters
- T = any
Parameters
- slot: string | number
  (could be the number of the slot or the string with the name of the slot)
- targetNode: LGraphNode
  the target node
- targetSlot: string | number
  the input slot of the target node (could be the number of the slot or the string with the name of the slot, or -1 to connect a trigger)
Returns T
the linkInfo is created, otherwise null
- Defined in packages/core/src/LGraphNode.ts:2722

connectByTypeInput

connectByTypeInput(slot, targetNode, targetSlotType, optsIn?): any
connect this node output to the input of another node BY TYPE
Parameters
- slot: SlotNameOrIndex
  (could be the number of the slot or the string with the name of the slot)
- targetNode: LGraphNode
- targetSlotType: SlotType
- optsIn: {
      createEventInCase?: boolean;
      firstFreeIfOutputGeneralInCase?: boolean;
      generalTypeInCase?: boolean;
  } = {}
  - Optional createEventInCase?: boolean
  - Optional firstFreeIfOutputGeneralInCase?: boolean
  - Optional generalTypeInCase?: boolean
Returns any
the link_info is created, otherwise null

Method
connectByType
- Defined in packages/core/src/LGraphNode.ts:2500

connectByTypeOutput

connectByTypeOutput(slot, sourceNode, sourceSlotType, optsIn?): any
connect this node input to the output of another node BY TYPE
Parameters
- slot: SlotNameOrIndex
  (could be the number of the slot or the string with the name of the slot)
- sourceNode: LGraphNode
- sourceSlotType: SlotType
- optsIn: {
      createEventInCase?: boolean;
      firstFreeIfOutputGeneralInCase?: boolean;
      generalTypeInCase?: boolean;
  } = {}
  - Optional createEventInCase?: boolean
  - Optional firstFreeIfOutputGeneralInCase?: boolean
  - Optional generalTypeInCase?: boolean
Returns any
the link_info is created, otherwise null

Method
connectByType
- Defined in packages/core/src/LGraphNode.ts:2622

disconnectInput

disconnectInput(slot, options?): boolean
disconnect one input
Parameters
- slot: SlotNameOrIndex
  (could be the number of the slot or the string with the name of the slot)
- options: {
  doProcessChange?: boolean;
  } = {}
  - Optional doProcessChange?: boolean
Returns boolean
if it was disconnected successfully
- Defined in packages/core/src/LGraphNode.ts:3162

disconnectOutput

disconnectOutput(slot, targetNode?, options?): boolean
disconnect one output to an specific node
Parameters
- slot: SlotNameOrIndex
  (could be the number of the slot or the string with the name of the slot)
- Optional targetNode: LGraphNode
  the target node to which this slot is connected [Optional, if not targetNode is specified all nodes will be disconnected]
- Optional options: object
Returns boolean
if it was disconnected successfully
- Defined in packages/core/src/LGraphNode.ts:3003

doExecute

doExecute(param?, options?): void
Parameters
- Optional param: any
- options: LActionOptions = {}
Returns void
- Defined in packages/core/src/LGraphNode.ts:1343

findInputSlotByName

findInputSlotByName(name?, onlyFree?, typesNotAccepted?): INodeInputSlot
Parameters
- Optional name: string
- onlyFree: boolean = false
- Optional typesNotAccepted: SlotType[]
Returns INodeInputSlot
- Defined in packages/core/src/LGraphNode.ts:2251

findInputSlotByType

findInputSlotByType(type, preferFreeSlot?, doNotUseOccupied?): INodeInputSlot
findSlotByType for INPUTS
Parameters
- type: SlotType
- preferFreeSlot: boolean = false
- doNotUseOccupied: boolean = false
Returns INodeInputSlot
- Defined in packages/core/src/LGraphNode.ts:2380

findInputSlotIndexByName

findInputSlotIndexByName(name?, onlyFree?, typesNotAccepted?): number
returns the input slot with a given name (used for dynamic slots), -1 if not found
Parameters
- Optional name: string
  the name of the slot
- onlyFree: boolean = false
- Optional typesNotAccepted: SlotType[]
Returns number
the slot (-1 if not found)
- Defined in packages/core/src/LGraphNode.ts:2222

findInputSlotIndexByType

findInputSlotIndexByType(type, preferFreeSlot?, doNotUseOccupied?): number
findSlotByType for INPUTS
Parameters
- type: SlotType
- preferFreeSlot: boolean = false
- doNotUseOccupied: boolean = false
Returns number
- Defined in packages/core/src/LGraphNode.ts:2346

findOutputSlotByName

findOutputSlotByName(name?, onlyFree?, typesNotAccepted?): INodeOutputSlot
Parameters
- Optional name: string
- onlyFree: boolean = false
- Optional typesNotAccepted: SlotType[]
Returns INodeOutputSlot
- Defined in packages/core/src/LGraphNode.ts:2314

findOutputSlotByType

findOutputSlotByType(type, preferFreeSlot?, doNotUseOccupied?): INodeOutputSlot
findSlotByType for OUTPUTS
Parameters
- type: SlotType
- preferFreeSlot: boolean = false
- doNotUseOccupied: boolean = false
Returns INodeOutputSlot
- Defined in packages/core/src/LGraphNode.ts:2397

findOutputSlotIndexByName

findOutputSlotIndexByName(name?, onlyFree?, typesNotAccepted?): number
returns the output slot with a given name (used for dynamic slots), -1 if not found
Parameters
- Optional name: string
  the name of the slot
- onlyFree: boolean = false
- Optional typesNotAccepted: SlotType[]
Returns number
the slot (-1 if not found)
- Defined in packages/core/src/LGraphNode.ts:2285

findOutputSlotIndexByType

findOutputSlotIndexByType(type, preferFreeSlot?, doNotUseOccupied?): number
findSlotByType for OUTPUTS
Parameters
- type: SlotType
- preferFreeSlot: boolean = false
- doNotUseOccupied: boolean = false
Returns number
- Defined in packages/core/src/LGraphNode.ts:2363

`Private` findSlotByType

findSlotByType<T>(input, type, returnObj, preferFreeSlot?, doNotUseOccupied?): number | T
returns the output (or input) slot with a given type, -1 if not found
Type Parameters
- T extends INodeSlot
Parameters
- input: boolean
  uise inputs instead of outputs
- type: SlotType
  the type of the slot
- returnObj: boolean
- preferFreeSlot: boolean = false
  if we want a free slot (if not found, will return the first of the type anyway)
- doNotUseOccupied: boolean = false
Returns number | T
the slot (-1 if not found)

Method
findSlotByType
- Defined in packages/core/src/LGraphNode.ts:2419

fitSize

fitSize(): void
fit the size of a node according to its inputs and output slots

Returns void
- Defined in packages/core/src/LGraphNode.ts:1556

getBounding

getBounding(out?): Float32Array
returns the bounding of the object, used for rendering purposes
Parameters
- Optional out: Float32Array
Returns Float32Array
[x, y, width, height]
- Defined in packages/core/src/LGraphNode.ts:2114

getConnectionPos

getConnectionPos(is_input, slotNumber, out?, ignore_collapsed?): Vector2
returns the center of a connection point in canvas coords
Parameters
- is_input: boolean
  true if if a input slot, false if it is an output
- slotNumber: number
- out: Vector2 = ...
  a place to store the output, to free garbage
- ignore_collapsed: boolean = false
Returns Vector2
the position
- Defined in packages/core/src/LGraphNode.ts:3261

`Optional` getExtraLinkOptions

getExtraLinkOptions(graphCanvas, link, linkType, options): ContextMenuItem[]
Parameters
- graphCanvas: LGraphCanvas
- link: LLink
- linkType: LConnectionKind
- options: ContextMenuItem[]
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphNode.ts:3781

`Optional` getExtraMenuOptions

getExtraMenuOptions(graphCanvas, options): ContextMenuItem[]
Parameters
- graphCanvas: LGraphCanvas
- options: ContextMenuItem[]
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphNode.ts:3777

getInputData

getInputData<T>(slot, force_update?): T
Retrieves the input data (data traveling through the connection) from one slot
Type Parameters
- T = any
Parameters
- slot: number
- Optional force_update: boolean
  if set to true it will force the connected node of this slot to output data into this link
Returns T
data or if it is not connected returns undefined
- Defined in packages/core/src/LGraphNode.ts:887

getInputDataByName

getInputDataByName<T>(slot_name, force_update?): T
Retrieves the input data from one slot using its name instead of slot number
Type Parameters
- T = any
Parameters
- slot_name: string
- Optional force_update: boolean
  if set to true it will force the connected node of this slot to output data into this link
Returns T
data or if it is not connected returns null
- Defined in packages/core/src/LGraphNode.ts:972

getInputDataType

getInputDataType(slot): SlotType
Retrieves the input data type (in case this supports multiple input types)
Parameters
- slot: number
Returns SlotType
datatype in string format
- Defined in packages/core/src/LGraphNode.ts:934

getInputInfo

getInputInfo(slot): INodeInputSlot
tells you info about an input connection (which node, type, etc)
Parameters
- slot: number
Returns INodeInputSlot
- Defined in packages/core/src/LGraphNode.ts:989

getInputLink

getInputLink(slot): LLink
Returns the link info in the connection of an input slot
Parameters
- slot: number
Returns LLink
object or null
- Defined in packages/core/src/LGraphNode.ts:1004

getInputNode

getInputNode(slot): LGraphNode
returns the node connected in the input slot
Parameters
- slot: number
Returns LGraphNode
- Defined in packages/core/src/LGraphNode.ts:1016

getInputOrProperty

getInputOrProperty<T>(name): T
returns the value of an input with this name, otherwise checks if there is a property with that name
Type Parameters
- T = any
Parameters
- name: string
Returns T
- Defined in packages/core/src/LGraphNode.ts:1043

getInputSlotProperty

getInputSlotProperty(slot, name): any
Parameters
- slot: number
- name: string
Returns any
- Defined in packages/core/src/LGraphNode.ts:687

getInputSlotsConnectedTo

getInputSlotsConnectedTo(slot): INodeInputSlot[]
Returns the input slots in other nodes that an output in this node is connected to.
Parameters
- slot: number
Returns INodeInputSlot[]
object or null
- Defined in packages/core/src/LGraphNode.ts:1153

`Optional` getMenuOptions

getMenuOptions(graphCanvas): ContextMenuItem[]
Called by LGraphCanvas.processContextMenu
Parameters
- graphCanvas: LGraphCanvas
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphNode.ts:3776

getOptionalSlots

getOptionalSlots(): OptionalSlots
Returns OptionalSlots
- Defined in packages/core/src/LGraphNode.ts:3757

getOutputData

getOutputData<T>(slot): T
tells you the last output data that went in that slot
Type Parameters
- T = any
Parameters
- slot: number
Returns T
- Defined in packages/core/src/LGraphNode.ts:1115

getOutputInfo

getOutputInfo(slot): INodeOutputSlot
tells you info about an output connection (which node, type, etc)
Parameters
- slot: number
Returns INodeOutputSlot
- Defined in packages/core/src/LGraphNode.ts:1173

getOutputLinks

getOutputLinks(slot): LLink[]
Returns the link info in the connection of an output slot
Parameters
- slot: number
Returns LLink[]
object or null
- Defined in packages/core/src/LGraphNode.ts:1132

getOutputNodes

getOutputNodes(slot): LGraphNode[]
retrieves all the nodes connected to this output slot
Parameters
- slot: number
Returns LGraphNode[]
- Defined in packages/core/src/LGraphNode.ts:1209

getOutputSlotConnectedTo

getOutputSlotConnectedTo(slot): INodeOutputSlot
Returns the output slot in another node that an input in this node is connected to.
Parameters
- slot: number
Returns INodeOutputSlot
object or null
- Defined in packages/core/src/LGraphNode.ts:1094

getOutputSlotProperty

getOutputSlotProperty(slot, name): any
Parameters
- slot: number
- name: string
Returns any
- Defined in packages/core/src/LGraphNode.ts:705

getPropertyInfo

getPropertyInfo(property): IPropertyInfo
returns all the info available about a property of this node.
Parameters
- property: string
  name of the property
Returns IPropertyInfo
the object with all the available info

Method
getPropertyInfo
- Defined in packages/core/src/LGraphNode.ts:1934

getRootGraph

getRootGraph(): LGraph
Returns LGraph
- Defined in packages/core/src/LGraphNode.ts:637

getSlotInPosition

getSlotInPosition(x, y): SlotInPosition
checks if a point is inside a node slot, and returns info about which slot
Parameters
- x: number
- y: number
Returns SlotInPosition
- Defined in packages/core/src/LGraphNode.ts:2168

`Optional` getSlotMenuOptions

getSlotMenuOptions(slot): ContextMenuItem[]
Parameters
- slot: SlotInPosition
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphNode.ts:3787

getTitle

getTitle(): string
get the title string

Returns string
- Defined in packages/core/src/LGraphNode.ts:633

is

is<T>(ctor): this is T
Type Parameters
- T extends LGraphNode<T>
Parameters
- ctor: (new () => T)
  - - new (): T
    - Returns T
Returns this is T
- Defined in packages/core/src/LGraphNode.ts:2212

isAnyOutputConnected

isAnyOutputConnected(): boolean
tells you if there is any connection in the output slots

Returns boolean
- Defined in packages/core/src/LGraphNode.ts:1196

isInputConnected

isInputConnected(slot): boolean
tells you if there is a connection in one input slot
Parameters
- slot: number
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:981

isOutputConnected

isOutputConnected(slot): boolean
tells you if there is a connection in one output slot
Parameters
- slot: number
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:1184

isPointInside

isPointInside(x, y, margin?, skipTitle?): boolean
checks if a point is inside the shape of a node
Parameters
- x: number
- y: number
- margin: number = 0
- skipTitle: boolean = false
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:2130

isShowingTitle

isShowingTitle(mouseOver): boolean
Parameters
- mouseOver: boolean
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3411

iterateAllLinks

iterateAllLinks(): Iterable<LLink>
Returns Iterable<LLink>
- Defined in packages/core/src/LGraphNode.ts:1237

iterateInputInfo

iterateInputInfo(): Iterable<INodeInputSlot>
Returns Iterable<INodeInputSlot>
- Defined in packages/core/src/LGraphNode.ts:876

iterateOutputInfo

iterateOutputInfo(): Iterable<INodeOutputSlot>
Returns Iterable<INodeOutputSlot>
- Defined in packages/core/src/LGraphNode.ts:1109

iterateParentSubgraphNodes

iterateParentSubgraphNodes(): Iterable<Subgraph>
Returns Iterable<Subgraph>
- Defined in packages/core/src/LGraphNode.ts:647

loadImage

loadImage(url): HTMLImageElement
Parameters
- url: string
Returns HTMLImageElement
- Defined in packages/core/src/LGraphNode.ts:3380

localToScreen

localToScreen(x, y, graphCanvas): Vector2
Parameters
- x: number
- y: number
- graphCanvas: LGraphCanvas
Returns Vector2
- Defined in packages/core/src/LGraphNode.ts:3452

moveInput

moveInput(slot, newSlot): void
Parameters
- slot: number
- newSlot: number
Returns void
- Defined in packages/core/src/LGraphNode.ts:1785

moveOutput

moveOutput(slot, newSlot): void
Parameters
- slot: number
- newSlot: number
Returns void
- Defined in packages/core/src/LGraphNode.ts:1687

`Optional` onAction

onAction(action, param, options): void
Parameters
- action: any
- param: any
- options: LActionOptions
Returns void
- Defined in packages/core/src/LGraphNode.ts:3630

`Optional` onAddPropertyToPanel

onAddPropertyToPanel(name, panel): boolean
Parameters
- name: string
- panel: INodePanel
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3726

`Optional` onAdded

onAdded(graph): void
when added to graph (warning: this is called BEFORE the node is configured when loading) Called by LGraph.add
Parameters
- graph: LGraph
Returns void
- Defined in packages/core/src/LGraphNode.ts:3642

onAfterExecuteNode

onAfterExecuteNode(param, options?): void
Parameters
- param: any
- Optional options: object
Returns void
- Defined in packages/core/src/LGraphNode.ts:1300

`Optional` onBeforeConnectInput

onBeforeConnectInput(inputIndex): number
Called just before connection (or disconnect - if input is linked). A convenient place to switch to another input, or create new one. This allow for ability to automatically add slots if needed
Parameters
- inputIndex: number
Returns number
selected input slot index, can differ from parameter value
- Defined in packages/core/src/LGraphNode.ts:3691

`Optional` onBounding

onBounding(area): boolean
Parameters
- area: Float32Array
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3570

`Optional` onConfigure

onConfigure(o): void
Called by LGraph.configure
Parameters
- o: SerializedLGraphNode<LGraphNode>
Returns void
- Defined in packages/core/src/LGraphNode.ts:3636

`Optional` onConnectInput

onConnectInput(inputIndex, outputType, outputSlot, outputNode, outputIndex): boolean
if returns false the incoming connection will be canceled Called by LGraph.connect
Parameters
- inputIndex: number
  target input slot number
- outputType: SlotType
  type of output slot
- outputSlot: INodeOutputSlot
  output slot object
- outputNode: LGraphNode
  node containing the output
- outputIndex: number
  index of output slot
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3659

`Optional` onConnectOutput

onConnectOutput(outputIndex, inputType, inputSlot, inputNode, inputIndex): boolean
if returns false the incoming connection will be canceled Called by LGraph.connect
Parameters
- outputIndex: number
  target output slot number
- inputType: SlotType
  type of input slot
- inputSlot: INodeInputSlot
  input slot object
- inputNode: LGraphNode
  node containing the input
- inputIndex: number
  index of input slot
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3676

`Optional` onConnectionsChange

onConnectionsChange(type, slotIndex, isConnected, link, ioSlot): void
a connection changed (new one or removed) (LiteGraph.INPUT or LiteGraph.OUTPUT, slot, true if connected, linkInfo, input_info or output_info )
Parameters
- type: LConnectionKind
- slotIndex: number
- isConnected: boolean
- link: LLink
- ioSlot: INodeInputSlot | INodeOutputSlot
Returns void
- Defined in packages/core/src/LGraphNode.ts:3694

`Optional` onDblClick

onDblClick(event, pos, graphCanvas): void
Parameters
- event: MouseEventExt
- pos: Vector2
- graphCanvas: LGraphCanvas
Returns void
- Defined in packages/core/src/LGraphNode.ts:3605

`Optional` onDeselected

onDeselected(): void
Called by LGraphCanvas.deselectNode

Returns void
- Defined in packages/core/src/LGraphNode.ts:3625

`Optional` onDrawBackground

onDrawBackground(ctx, graphCanvas, canvas, pos): void
https://github.com/lenML/litegraph.ts/blob/master/GUIDE.md#custom-node-appearance
Parameters
- ctx: CanvasRenderingContext2D
- graphCanvas: LGraphCanvas
- canvas: HTMLCanvasElement
- pos: Vector2
Returns void
- Defined in packages/core/src/LGraphNode.ts:3520

`Optional` onDrawCollapsed

onDrawCollapsed(ctx, graphCanvas): boolean
Parameters
- ctx: CanvasRenderingContext2D
- graphCanvas: LGraphCanvas
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3533

`Optional` onDrawForeground

onDrawForeground(ctx, graphCanvas, canvas): void
Parameters
- ctx: CanvasRenderingContext2D
- graphCanvas: LGraphCanvas
- canvas: HTMLCanvasElement
Returns void
- Defined in packages/core/src/LGraphNode.ts:3527

`Optional` onDrawTitle

onDrawTitle(ctx, graphCanvas): boolean
Parameters
- ctx: CanvasRenderingContext2D
- graphCanvas: LGraphCanvas
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3565

`Optional` onDrawTitleBar

onDrawTitleBar(ctx, graphCanvas, title_height, size, scale, fgColor): boolean
Parameters
- ctx: CanvasRenderingContext2D
- graphCanvas: LGraphCanvas
- title_height: number
- size: Vector2
- scale: number
- fgColor: string
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3538

`Optional` onDrawTitleBox

onDrawTitleBox(ctx, graphCanvas, title_height, size, scale): boolean
Parameters
- ctx: CanvasRenderingContext2D
- graphCanvas: LGraphCanvas
- title_height: number
- size: Vector2
- scale: number
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3547

`Optional` onDrawTitleText

onDrawTitleText(ctx, graphCanvas, title_height, size, scale, font, selected): boolean
Parameters
- ctx: CanvasRenderingContext2D
- graphCanvas: LGraphCanvas
- title_height: number
- size: Vector2
- scale: number
- font: string
- selected: boolean
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3555

`Optional` onDropData

onDropData(data, filename, file): void
Parameters
- data: string | ArrayBuffer
- filename: string
- file: File
Returns void
- Defined in packages/core/src/LGraphNode.ts:393

`Optional` onDropFile

onDropFile(file): void
Parameters
- file: File
Returns void
- Defined in packages/core/src/LGraphNode.ts:392

`Optional` onDropItem

onDropItem(e): boolean | void
Parameters
- e: DragEvent
Returns boolean | void
- Defined in packages/core/src/LGraphNode.ts:394

`Optional` onExecute

onExecute(param, options): void
Called by LGraph.runStep LGraphNode.getInputData
Parameters
- param: any
- options: object
Returns void
- Defined in packages/core/src/LGraphNode.ts:3628

`Optional` onGetPropertyInfo

onGetPropertyInfo(property): IPropertyInfo
Parameters
- property: string
Returns IPropertyInfo
- Defined in packages/core/src/LGraphNode.ts:3724

`Optional` onInputAdded

onInputAdded(input): void
Parameters
- input: INodeInputSlot
Returns void
- Defined in packages/core/src/LGraphNode.ts:3735

`Optional` onInputClick

onInputClick(slot, event): void
Parameters
- slot: number
- event: MouseEventExt
Returns void
- Defined in packages/core/src/LGraphNode.ts:3739

`Optional` onInputDblClick

onInputDblClick(slot, event): void
Parameters
- slot: number
- event: MouseEventExt
Returns void
- Defined in packages/core/src/LGraphNode.ts:3741

`Optional` onInputRemoved

onInputRemoved(slot, input): void
Parameters
- slot: number
- input: INodeInputSlot
Returns void
- Defined in packages/core/src/LGraphNode.ts:3737

`Optional` onJSPropertyChanged

onJSPropertyChanged(property, value, prevValue?): boolean | void
Called when the node's title or other JS property changes
Parameters
- property: string
- value: any
- Optional prevValue: any
Returns boolean | void
- Defined in packages/core/src/LGraphNode.ts:3718

`Optional` onKey

onKey(event, pos, graphCanvas): void
Parameters
- event: KeyboardEvent
- pos: Vector2
- graphCanvas: LGraphCanvas
Returns void
- Defined in packages/core/src/LGraphNode.ts:3611

`Optional` onKeyDown

onKeyDown(event): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in packages/core/src/LGraphNode.ts:3612

`Optional` onKeyUp

onKeyUp(event): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in packages/core/src/LGraphNode.ts:3613

`Optional` onMenuNodeInputs

onMenuNodeInputs(item): ContextMenuItem[]
Parameters
- item: ContextMenuItem[]
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphNode.ts:3731

`Optional` onMenuNodeOutputs

onMenuNodeOutputs(item): ContextMenuItem[]
Parameters
- item: ContextMenuItem[]
Returns ContextMenuItem[]
- Defined in packages/core/src/LGraphNode.ts:3743

`Optional` onMouseDown

onMouseDown(event, pos, graphCanvas): boolean | void
https://github.com/lenML/litegraph.ts/blob/master/GUIDE.md#custom-node-appearance
Parameters
- event: MouseEventExt
- pos: Vector2
- graphCanvas: LGraphCanvas
Returns boolean | void
- Defined in packages/core/src/LGraphNode.ts:3575

`Optional` onMouseEnter

onMouseEnter(event, pos, graphCanvas): void
Parameters
- event: MouseEventExt
- pos: Vector2
- graphCanvas: LGraphCanvas
Returns void
- Defined in packages/core/src/LGraphNode.ts:3593

`Optional` onMouseLeave

onMouseLeave(event, pos, graphCanvas): void
Parameters
- event: MouseEventExt
- pos: Vector2
- graphCanvas: LGraphCanvas
Returns void
- Defined in packages/core/src/LGraphNode.ts:3599

`Optional` onMouseMove

onMouseMove(event, pos, graphCanvas): void
Parameters
- event: MouseEventExt
- pos: Vector2
- graphCanvas: LGraphCanvas
Returns void
- Defined in packages/core/src/LGraphNode.ts:3581

`Optional` onMouseUp

onMouseUp(event, pos, graphCanvas): void
Parameters
- event: MouseEventExt
- pos: Vector2
- graphCanvas: LGraphCanvas
Returns void
- Defined in packages/core/src/LGraphNode.ts:3587

`Optional` onNodeCreated

onNodeCreated(): void
Returns void
- Defined in packages/core/src/LGraphNode.ts:390

`Optional` onNodeOptionalInputAdd

onNodeOptionalInputAdd(value): void
Parameters
- value: any
Returns void
- Defined in packages/core/src/LGraphNode.ts:3733

`Optional` onNodeOptionalOutputAdd

onNodeOptionalOutputAdd(value): void
Parameters
- value: any
Returns void
- Defined in packages/core/src/LGraphNode.ts:3745

`Optional` onOutputAdded

onOutputAdded(output): void
Parameters
- output: INodeOutputSlot
Returns void
- Defined in packages/core/src/LGraphNode.ts:3749

`Optional` onOutputClick

onOutputClick(slot, event): void
Parameters
- slot: number
- event: MouseEventExt
Returns void
- Defined in packages/core/src/LGraphNode.ts:3753

`Optional` onOutputDblClick

onOutputDblClick(slot, event): void
Parameters
- slot: number
- event: MouseEventExt
Returns void
- Defined in packages/core/src/LGraphNode.ts:3755

`Optional` onOutputRemoved

onOutputRemoved(slot, output): void
Parameters
- slot: number
- output: INodeOutputSlot
Returns void
- Defined in packages/core/src/LGraphNode.ts:3751

`Optional` onPropertyChanged

onPropertyChanged(property, value, prevValue?): boolean | void
if returns false, will abort the LGraphNode.setProperty Called when a property is changed
Parameters
- property: string
- value: any
- Optional prevValue: any
Returns boolean | void
- Defined in packages/core/src/LGraphNode.ts:3709

`Optional` onReassignID

onReassignID(idMap): void
Parameters
- idMap: GraphIDMapping
Returns void
- Defined in packages/core/src/LGraphNode.ts:3773

`Optional` onRemoved

onRemoved(options?): void
when removed from graph Called by LGraph.remove LGraph.clear
Parameters
- Optional options: LGraphRemoveNodeOptions
Returns void
- Defined in packages/core/src/LGraphNode.ts:3648

onResize

onResize(size): void
Parameters
- size: Vector2
Returns void
- Defined in packages/core/src/LGraphNode.ts:3615

`Optional` onSelected

onSelected(): void
Called by LGraphCanvas.selectNodes

Returns void
- Defined in packages/core/src/LGraphNode.ts:3622

`Optional` onSerialize

onSerialize(o): void
Called by LGraph.serialize
Parameters
- o: SerializedLGraphNode<LGraphNode>
Returns void
- Defined in packages/core/src/LGraphNode.ts:3633

`Optional` onShowCustomPanelInfo

onShowCustomPanelInfo(panel): void
Parameters
- panel: INodePanel
Returns void
- Defined in packages/core/src/LGraphNode.ts:3727

`Optional` onSlotPropertyChanged

onSlotPropertyChanged(kind, slot, slotInfo, name, value, prev_value?): boolean
Parameters
- kind: LConnectionKind
- slot: number
- slotInfo: INodeInputSlot | INodeOutputSlot
- name: string
- value: any
- Optional prev_value: any
Returns boolean
- Defined in packages/core/src/LGraphNode.ts:3764

`Optional` onWidgetChanged

onWidgetChanged(widget, oldValue?): void
Parameters
- widget: IWidget<any, any>
- Optional oldValue: any
Returns void
- Defined in packages/core/src/LGraphNode.ts:3729

pin(v?): void
Forces the node to do not move or realign on Z
Parameters
- Optional v: boolean
Returns void
- Defined in packages/core/src/LGraphNode.ts:3443

removeInput

removeInput(slot): void
remove an existing input slot
Parameters
- slot: number
Returns void
- Defined in packages/core/src/LGraphNode.ts:1765

removeOnExecuteOutput

removeOnExecuteOutput(): number
Returns number
- Defined in packages/core/src/LGraphNode.ts:1291

removeOnTriggerInput

removeOnTriggerInput(): number
Returns number
- Defined in packages/core/src/LGraphNode.ts:1269

removeOutput

removeOutput(slot): void
remove an existing output slot
Parameters
- slot: number
Returns void
- Defined in packages/core/src/LGraphNode.ts:1661

removeWidget

removeWidget<T>(widget): void
Type Parameters
- T extends IWidget<any, any, T>
Parameters
- widget: T
Returns void
- Defined in packages/core/src/LGraphNode.ts:2081

removeWidgetByIndex

removeWidgetByIndex(index): void
Parameters
- index: number
Returns void
- Defined in packages/core/src/LGraphNode.ts:2090

removeWidgetByName

removeWidgetByName(name): void
Parameters
- name: string
Returns void
- Defined in packages/core/src/LGraphNode.ts:2095

serialize

serialize(): SerializedLGraphNode<LGraphNode>
serialize the content

Returns SerializedLGraphNode<LGraphNode>
- Defined in packages/core/src/LGraphNode.ts:518

setDirtyCanvas

setDirtyCanvas(fg, bg?): void
Forces to redraw or the main canvas (LGraphNode) or the bg canvas (links)
Parameters
- fg: boolean
- bg: boolean = false
Returns void
- Defined in packages/core/src/LGraphNode.ts:3373

setInputDataType

setInputDataType(slot, type): void
sets the input data type
Parameters
- slot: number
- type: SlotType
Returns void
- Defined in packages/core/src/LGraphNode.ts:1061

setInputSlotProperty

setInputSlotProperty(slot, name, value): void
Parameters
- slot: number
- name: string
- value: any
Returns void
- Defined in packages/core/src/LGraphNode.ts:723

setOutputData

setOutputData(slot, data): void
sets the output data
Parameters
- slot: number
- data: any
Returns void
- Defined in packages/core/src/LGraphNode.ts:802

setOutputDataType

setOutputDataType(slot, type): void
sets the output data
Parameters
- slot: number
- type: SlotType
Returns void
- Defined in packages/core/src/LGraphNode.ts:838

setOutputSlotProperty

setOutputSlotProperty(slot, name, value): void
Parameters
- slot: number
- name: string
- value: any
Returns void
- Defined in packages/core/src/LGraphNode.ts:762

setProperty

setProperty(name, value): void
sets the value of a property
Parameters
- name: string
- value: any
Returns void
- Defined in packages/core/src/LGraphNode.ts:656

setSize

setSize(size): void
changes node size and triggers callback
Parameters
- size: Vector2
Returns void
Method
setSize
- Defined in packages/core/src/LGraphNode.ts:1548

setWidgetHidden

setWidgetHidden(widget, hidden): void
Parameters
- widget: IWidget<any, any>
- hidden: boolean
Returns void
- Defined in packages/core/src/LGraphNode.ts:2105

syncDomAnchors

syncDomAnchors(ctx): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
- Defined in packages/core/src/LGraphNode.ts:3459

toString

toString(): string
serialize and stringify

Returns string
- Defined in packages/core/src/LGraphNode.ts:628

trace

trace(msg): void
Console output
Parameters
- msg: string
Returns void
- Defined in packages/core/src/LGraphNode.ts:3359

trigger

trigger(action, param, options?): void
Triggers an event in this node, this will trigger any output with the same name
Parameters
- action: string
- param: any
- Optional options: LActionOptions
Returns void
- Defined in packages/core/src/LGraphNode.ts:1401

triggerSlot

triggerSlot(slot, param?, link_id?, options?): void
Triggers an slot event in this node
Parameters
- slot: number
  the index of the output slot
- Optional param: any
- Optional link_id: LinkID
  in case you want to trigger and specific output link in a slot
- options: LActionOptions = {}
Returns void
- Defined in packages/core/src/LGraphNode.ts:1426

`Optional` updateOutputData

updateOutputData(slot): void
Parameters
- slot: number
Returns void
- Defined in packages/core/src/LGraphNode.ts:3747

Class LGraphNode

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LGraphNode

Properties

Optional _collapsed_width

_level

_relative_id

action_call

action_triggered

bgcolor

block_delete

boxcolor

category

class

Type declaration

Returns LGraphNode

clip_area

clonable

collapsable

color

connections

Private console

desc

disposed

dom_anchors

Type declaration

Optional bottom_center?: HTMLElement

Optional bottom_left?: HTMLElement

Optional bottom_right?: HTMLElement

Optional middle_center?: HTMLElement

Optional middle_left?: HTMLElement

Optional middle_right?: HTMLElement

Optional top_center?: HTMLElement

Optional top_left?: HTMLElement

Optional top_right?: HTMLElement

events

Type declaration

added: (() => void)

Returns void

changeMode: ((mode, before) => void)

Parameters

Returns void

deselected: (() => void)

Returns void

drop: ((e) => void)

Parameters

Returns void

dropFile: ((file) => void)

Parameters

Returns void

execute: (() => void)

Returns void

keyDown: ((e) => void)

Parameters

Returns void

keyUp: ((e) => void)

Parameters

Returns void

mouseEnter: ((e) => void)

Parameters

Returns void

mouseLeave: ((e) => void)

Parameters

Returns void

mouseMove: ((e) => void)

Parameters

Returns void

mouseUp: ((e) => void)

Parameters

Returns void

nodeOptionalInputAdd: ((slot) => void)

Parameters

`Optional` _collapsed_width

`Private` console

`Optional` bottom_center?: HTMLElement

`Optional` bottom_left?: HTMLElement

`Optional` bottom_right?: HTMLElement

`Optional` middle_center?: HTMLElement

`Optional` middle_left?: HTMLElement

`Optional` middle_right?: HTMLElement

`Optional` top_center?: HTMLElement

`Optional` top_left?: HTMLElement

`Optional` top_right?: HTMLElement

`Optional` has_errors

`Optional` last_serialization

`Optional` mode