Class InputControl<T, D>

A control represents widgets the user can interact with.

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

autoType canChangeType changeType? id index? label onChange? options placeInHeader props readonly type

Accessors

datastructure socketType value

Constructors

constructor

  • new InputControl<T, D>(params): InputControl<T, D>

  • Type Parameters

    • T extends
          | "number"
          | "integer"
          | "vector"
          | "remote-file"
          | "text"
          | "checkbox"
          | "group-name-ref"
          | "textarea"
          | "select" =
          | "number"
          | "integer"
          | "vector"
          | "remote-file"
          | "text"
          | "checkbox"
          | "group-name-ref"
          | "textarea"
          | "select"
    • D extends "scalar" | "array" = "scalar" | "array"

    Parameters

    Returns InputControl<T, D>

Properties

autoType

autoType: boolean = false

canChangeType

canChangeType: boolean = ...

OptionalchangeType

changeType?: ((type: SocketType) => void) = ...

id

id: string

Control id, unique string generated by getUID function

Optionalindex

index?: number

Control index, used for sorting controls. Default is 0

label

label: string = ...

OptionalonChange

onChange?: ((value: InputControlValueType<T>) => void)

options

options: undefined | string[] = ...

placeInHeader

placeInHeader: boolean = ...

props

props: HTMLInputAttributes = ...

readonly

readonly: boolean = ...

type

type:
    | "number"
    | "integer"
    | "vector"
    | "remote-file"
    | "text"
    | "checkbox"
    | "group-name-ref"
    | "textarea"
    | "select" = ...

Accessors

datastructure

socketType

value

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors