Class Input<S>

Type Parameters

S extends Socket = Socket

Hierarchy (view full)

Port<S>
- Input

Implements

Input<S>

Index

Constructors

constructor

new Input<S>(params): Input<S>
Type Parameters
- S extends Socket<SocketType, "scalar" | "array"> = Socket<SocketType, "scalar" | "array">
Parameters
- params: PortParams<S> & {
      alwaysShowLabel?: boolean;
      hideLabel?: boolean;
      isRequired?: boolean;
  }
Returns Input<S>
Overrides Port.constructor
- Defined in src/lib/graph-editor/socket/Input.svelte.ts:20

Properties

alwaysShowLabel

alwaysShowLabel: boolean = ...

control

control: null | Control = null

Control instance

description

description: undefined | string = ...

hideLabel

hideLabel: boolean = ...

`Readonly`id

id: string

Port id, unique string generated by getUID function

index

index: undefined | number = ...

Port index, used for sorting ports. Default is 0

`Readonly`isRequired

isRequired: boolean

label

label: undefined | string = ...

`Readonly`multipleConnections

multipleConnections: boolean

showControl

showControl: boolean = ...

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

`Readonly`socket

socket: S

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 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 src/lib/graph-editor/socket/Input.svelte.ts:45

Class Input<S>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Input<S>

Properties

alwaysShowLabel

control

description

hideLabel

`Readonly`id

index

`Readonly`isRequired

label

`Readonly`multipleConnections

showControl

`Readonly`socket

Methods

addControl

Parameters

Returns void

removeControl

Returns void

Settings

On This Page

Class Input<S>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Input<S>

Properties

alwaysShowLabel

control

description

hideLabel

Readonlyid

index

ReadonlyisRequired

label

ReadonlymultipleConnections

showControl

Readonlysocket

Methods

addControl

Parameters

Returns void

removeControl

Returns void

Settings

On This Page

`Readonly`id

`Readonly`isRequired

`Readonly`multipleConnections

`Readonly`socket