Class DOMWidget

Constructs a DOMWidget instance.

Param: options.name

The name of the widget.

Param: options.element

The HTML element for the widget.

Param: options.value

The value of the widget.

Param: options.options

The options for the widget.

Param: options.node

The LGraphNode associated with the widget.

Implements

IWidget

Index

Constructors

constructor

new DOMWidget(__namedParameters): DOMWidget
Parameters
- __namedParameters: {
      element: HTMLElement;
      name: string;
      node: LGraphNode;
      options?: DOMWidgetOptions;
      value?: any;
  }
  - element: HTMLElement
  - name: string
  - node: LGraphNode
  - Optional options?: DOMWidgetOptions
  - Optional value?: any
Returns DOMWidget
- Defined in packages/core/src/widgets/DOMWidget.ts:251

Properties

$el

$el: HTMLElement

`Optional` callback

callback?: WidgetCallback<DOMWidget>

`Optional` clicked

clicked?: boolean

computedHeight

computedHeight: number = ...

`Optional` disabled

disabled?: boolean

disposed

disposed: Disposable = ...

`Optional` hidden

hidden?: boolean

`Optional` last_y

last_y?: number

`Optional` marker

marker?: boolean

`Private` `Optional` mouseDownHandler

mouseDownHandler?: ((...args) => any)

Type declaration

- (...args): any
- Parameters
  - Rest ...args: any
  Returns any

name

name: string

node

node: LGraphNode

options

options: DOMWidgetOptions

`Optional` property

property?: string

type

type: string = "dom"

`Optional` width

width?: number

`Optional` y

y?: number

Accessors

canvas

get canvas(): LGraphCanvas
Returns LGraphCanvas
- Defined in packages/core/src/widgets/DOMWidget.ts:364

value

get value(): any
Returns any
Implementation of IWidget.value
- Defined in packages/core/src/widgets/DOMWidget.ts:368
set value(v): void
Parameters
- v: any
Returns void
Implementation of IWidget.value
- Defined in packages/core/src/widgets/DOMWidget.ts:372

Methods

destroy

destroy(): void
Returns void
- Defined in packages/core/src/widgets/DOMWidget.ts:474

draw

draw(ctx, node, widgetWidth, posY, height): void
Called by LGraphCanvas.drawNodeWidgets
Parameters
- ctx: CanvasRenderingContext2D
- node: LGraphNode
- widgetWidth: number
- posY: number
- height: number
Returns void
Implementation of IWidget.draw
- Defined in packages/core/src/widgets/DOMWidget.ts:393

drawInvisible

drawInvisible(): void
Called by LGraphCanvas.drawInvisibleNodeWidgets

Returns void
Implementation of IWidget.drawInvisible
- Defined in packages/core/src/widgets/DOMWidget.ts:450

hideElement

hideElement(): void
Returns void
- Defined in packages/core/src/widgets/DOMWidget.ts:454

onNodeCollapse

onNodeCollapse(node, collapsed): void
Parameters
- node: LGraphNode
- collapsed: boolean
Returns void
Implementation of IWidget.onNodeCollapse
- Defined in packages/core/src/widgets/DOMWidget.ts:478

onNodeModeChange

onNodeModeChange(node, mode): void
Parameters
- node: LGraphNode
- mode: NodeMode
Returns void
Implementation of IWidget.onNodeModeChange
- Defined in packages/core/src/widgets/DOMWidget.ts:492

onNodeRemoved

onNodeRemoved(node): void
Parameters
- node: LGraphNode
Returns void
Implementation of IWidget.onNodeRemoved
- Defined in packages/core/src/widgets/DOMWidget.ts:470

onNodeResize

onNodeResize(node, size): void
Parameters
- node: LGraphNode
- size: Vector2
Returns void
Implementation of IWidget.onNodeResize
- Defined in packages/core/src/widgets/DOMWidget.ts:486

`Optional` onPropertyChange

onPropertyChange(value): void
Parameters
- value: any
Returns void
Implementation of IWidget.onPropertyChange
- Defined in packages/core/src/widgets/DOMWidget.ts:240

onRemoved

onRemoved(): void
Returns void
Implementation of IWidget.onRemoved
- Defined in packages/core/src/widgets/DOMWidget.ts:466

showElement

showElement(): void
Returns void
- Defined in packages/core/src/widgets/DOMWidget.ts:460

sync_ui

sync_ui(): void
Returns void
- Defined in packages/core/src/widgets/DOMWidget.ts:377

updateProperty

updateProperty(): void
Returns void
- Defined in packages/core/src/widgets/DOMWidget.ts:507

Class DOMWidget

Param: options.name

Param: options.element

Param: options.value

Param: options.options

Param: options.node

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

element: HTMLElement

name: string

node: LGraphNode

Optional options?: DOMWidgetOptions

Optional value?: any

Returns DOMWidget

Properties

$el

Optional callback

Optional clicked

computedHeight

Optional disabled

disposed

Optional hidden

Optional last_y

Optional marker

Private Optional mouseDownHandler

Type declaration

Parameters

Returns any

name

node

options

Optional property

type

Optional width

Optional y

Accessors

canvas

Returns LGraphCanvas

value

Returns any

Parameters

Returns void

Methods

destroy

Returns void

draw

Parameters

Returns void

drawInvisible

Returns void

hideElement

Returns void

onNodeCollapse

Parameters

Returns void

onNodeModeChange

Parameters

Returns void

onNodeRemoved

Parameters

Returns void

onNodeResize

Parameters

Returns void

Optional onPropertyChange

Parameters

Returns void

onRemoved

Returns void

showElement

Returns void

sync_ui

Returns void

`Optional` options?: DOMWidgetOptions

`Optional` value?: any

`Optional` callback

`Optional` clicked

`Optional` disabled

`Optional` hidden

`Optional` last_y

`Optional` marker

`Private` `Optional` mouseDownHandler

`Optional` property

`Optional` width

`Optional` y

`Optional` onPropertyChange