Optional
_collapsed_the nFrames it will be used (-- each step), means "how old" is the event
if you render outside the node, it will be clipped
Optional
bottom_Optional
bottom_Optional
bottom_Optional
middle_Optional
middle_Optional
middle_Optional
top_Optional
top_Optional
top_Optional
options: LGraphRemoveNodeOptionsthe nFrames it will be used (-- each step), means "how old" is the event
Optional
has_if true, the node will show the bgcolor as 'red'
highlight draw in drawNodeHighlight
slots are distributed horizontally
Optional
last_Optional
modeUsed in LGraphCanvas.onMenuNodeMode
computeExecutionOrder sorts by priority first, then order if priorities are the same
progress draw in drawNodeHighlight
if set to false it wont be resizable with the mouse
widgets start at y distance from the top of the node
If set to true widgets do not start after the slots
Optional
widgets_Static
MAX_Static
default_Static
optionalStatic
propertyStatic
slotStatic
titleStatic
title_Static
typeStatic
widgets_Triggers an action, wrapped by logics to control execution flow
name
actionDo
add an special connection to this node (used for special kinds of graphs)
string defining the input type ("vec3","number",...)
position of the connection inside the node
if is input or output
add a new input slot to use in this node
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)
add a new output slot to use in this node
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)
add a new property to this node
Optional
type: stringstring 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)
Optional
callback: string | WidgetCallback<IToggleWidget>Optional
options: IToggleWidgetOptionscreated widget
Optional
callback: string | WidgetCallback<ISliderWidget>Optional
options: ISliderWidgetOptionsOptional
callback: string | WidgetCallback<INumberWidget>Optional
options: INumberWidgetOptionsOptional
callback: string | WidgetCallback<ITextWidget>Optional
options: WidgetPanelOptionsOptional
callback: string | WidgetCallback<IEnumWidget>Optional
options: IEnumWidgetOptionsOptional
callback: string | WidgetCallback<IButtonWidget>Optional
options: WidgetPanelOptionsclears the trigger slot animation
the index of the output slot
Optional
link_id: LinkIDin case you want to trigger and specific output link in a slot
Creates a clone of this node
configure a node from an object containing the serialized info
connect this node output to the input of another node
(could be the number of the slot or the string with the name of the slot)
the target node
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)
the linkInfo is created, otherwise null
connect this node output to the input of another node BY TYPE
(could be the number of the slot or the string with the name of the slot)
Optional
createOptional
firstOptional
generalthe link_info is created, otherwise null
connectByType
connect this node input to the output of another node BY TYPE
(could be the number of the slot or the string with the name of the slot)
Optional
createOptional
firstOptional
generalthe link_info is created, otherwise null
connectByType
disconnect one input
(could be the number of the slot or the string with the name of the slot)
Optional
doif it was disconnected successfully
disconnect one output to an specific node
(could be the number of the slot or the string with the name of the slot)
Optional
targetNode: LGraphNodethe target node to which this slot is connected [Optional, if not targetNode is specified all nodes will be disconnected]
Optional
options: objectif it was disconnected successfully
Optional
param: anyOptional
name: stringOptional
typesNotAccepted: SlotType[]findSlotByType for INPUTS
returns the input slot with a given name (used for dynamic slots), -1 if not found
Optional
name: stringthe name of the slot
Optional
typesNotAccepted: SlotType[]the slot (-1 if not found)
findSlotByType for INPUTS
Optional
name: stringOptional
typesNotAccepted: SlotType[]findSlotByType for OUTPUTS
returns the output slot with a given name (used for dynamic slots), -1 if not found
Optional
name: stringthe name of the slot
Optional
typesNotAccepted: SlotType[]the slot (-1 if not found)
findSlotByType for OUTPUTS
returns the center of a connection point in canvas coords
true if if a input slot, false if it is an output
a place to store the output, to free garbage
the position
Optional
getRetrieves the input data (data traveling through the connection) from one slot
Optional
force_update: booleanif set to true it will force the connected node of this slot to output data into this link
data or if it is not connected returns undefined
Retrieves the input data from one slot using its name instead of slot number
Optional
force_update: booleanif set to true it will force the connected node of this slot to output data into this link
data or if it is not connected returns null
tells you info about an input connection (which node, type, etc)
returns the node connected in the input slot
Returns the input slots in other nodes that an output in this node is connected to.
object or null
Optional
getCalled by LGraphCanvas.processContextMenu
tells you info about an output connection (which node, type, etc)
retrieves all the nodes connected to this output slot
Returns the output slot in another node that an input in this node is connected to.
object or null
returns all the info available about a property of this node.
name of the property
the object with all the available info
getPropertyInfo
checks if a point is inside a node slot, and returns info about which slot
Optional
getOptional
onOptional
onwhen added to graph (warning: this is called BEFORE the node is configured when loading)
Called by LGraph.add
Optional
onCalled 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
selected input slot index, can differ from parameter value
Optional
onOptional
onif returns false the incoming connection will be canceled
Called by LGraph.connect
target input slot number
type of output slot
output slot object
node containing the output
index of output slot
Optional
onif returns false the incoming connection will be canceled
Called by LGraph.connect
target output slot number
type of input slot
input slot object
node containing the input
index of input slot
Optional
ona connection changed (new one or removed) (LiteGraph.INPUT or LiteGraph.OUTPUT, slot, true if connected, linkInfo, input_info or output_info )
Optional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onJSPropertyOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onOptional
onwhen removed from graph
Called by LGraph.remove
LGraph.clear
Optional
options: LGraphRemoveNodeOptionsOptional
onOptional
onOptional
onOptional
onOptional
prev_value: anyPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onPrivate
onOptional
onOptional
oldValue: anyserialize the content
sets the input data type
sets the output data
changes node size and triggers callback
setSize
Triggers an event in this node, this will trigger any output with the same name
Optional
options: LActionOptionsTriggers an slot event in this node
the index of the output slot
Optional
param: anyOptional
link_id: LinkIDin case you want to trigger and specific output link in a slot
Optional
update
https://github.com/lenML/litegraph.ts/blob/master/GUIDE.md#lgraphnode