Skip to content

Input

Classes

Input<S>

Extends

Type Parameters

S extends Socket = Socket

Implements

  • Input<S>

Constructors

new Input()
new Input<S>(params): Input<S>
Parameters

params: PortParams<S> & object

Returns

Input<S>

Overrides

Port.constructor

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/Input.svelte.ts:20

Properties

alwaysShowLabel
alwaysShowLabel: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/socket/Input.svelte.ts:18

control
control: null | Control = null;

Control instance

Implementation of

ClassicPreset.Input.control

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/Input.svelte.ts:12

description
description: undefined | string;
Inherited from

Port.description

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/port.svelte.ts:17

hideLabel
hideLabel: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/socket/Input.svelte.ts:19

id
readonly id: string;

Port id, unique string generated by getUID function

Implementation of

ClassicPreset.Input.id

Inherited from

Port.id

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/port.svelte.ts:14

index
index: undefined | number;

Port index, used for sorting ports. Default is 0

Implementation of

ClassicPreset.Input.index

Inherited from

Port.index

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/port.svelte.ts:18

isRequired
readonly isRequired: boolean;
Defined in

tmp/graph-editor/src/lib/graph-editor/socket/Input.svelte.ts:7

label
label: undefined | string;
Implementation of

ClassicPreset.Input.label

Inherited from

Port.label

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/port.svelte.ts:16

multipleConnections
readonly multipleConnections: boolean;
Implementation of

ClassicPreset.Input.multipleConnections

Inherited from

Port.multipleConnections

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/port.svelte.ts:15

showControl
showControl: boolean;

Whether the control is visible. Can be managed dynamically by extensions. Default is true

Implementation of

ClassicPreset.Input.showControl

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/Input.svelte.ts:16

socket
readonly socket: S;
Implementation of

ClassicPreset.Input.socket

Inherited from

Port.socket

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/port.svelte.ts:13

Methods

addControl()
addControl(control): void

Add control to the input port

Parameters

control: Control

Control instance

Returns

void

Implementation of

ClassicPreset.Input.addControl

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/Input.svelte.ts:37

removeControl()
removeControl(): void

Remove control from the input port

Returns

void

Implementation of

ClassicPreset.Input.removeControl

Defined in

tmp/graph-editor/src/lib/graph-editor/socket/Input.svelte.ts:45