Class InputBindingApi<In, Ex>

The API for the input binding between the parameter and the pane.

Type parameters

In

The internal type.
Ex

The external type (= parameter object).

Hierarchy

BladeApi<InputBindingController<In>>
- InputBindingApi

Index

Accessors

Methods

Accessors

disabled

get disabled(): boolean
set disabled(disabled: boolean): any

- Defined in node_modules/@tweakpane/core/dist/cjs/blade/common/api/blade.d.ts:12
Returns boolean
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/common/api/blade.d.ts:13
Parameters
- disabled: boolean
Returns any

hidden

get hidden(): boolean
set hidden(hidden: boolean): any

- Defined in node_modules/@tweakpane/core/dist/cjs/blade/common/api/blade.d.ts:14
Returns boolean
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/common/api/blade.d.ts:15
Parameters
- hidden: boolean
Returns any

label

get label(): undefined | string
set label(label: undefined | string): any

- Defined in node_modules/@tweakpane/core/dist/cjs/blade/input-binding/api/input-binding.d.ts:20
Returns undefined | string
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/input-binding/api/input-binding.d.ts:21
Parameters
- label: undefined | string
Returns any

Methods

dispose

dispose(): void

Inherited from BladeApi.dispose
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/common/api/blade.d.ts:16
Returns void

on

on<EventName>(eventName: EventName, handler: (ev: InputBindingApiEvents<Ex>[EventName]["event"]) => void): InputBindingApi<In, Ex>

- Defined in node_modules/@tweakpane/core/dist/cjs/blade/input-binding/api/input-binding.d.ts:22
Type parameters
- EventName: "change"
Parameters
- eventName: EventName
- handler: (ev: InputBindingApiEvents<Ex>[EventName]["event"]) => void
  - - (ev: InputBindingApiEvents<Ex>[EventName]["event"]): void
    - Parameters
      - ev: InputBindingApiEvents<Ex>[EventName]["event"]
      Returns void
Returns InputBindingApi<In, Ex>

refresh

refresh(): void

- Defined in node_modules/@tweakpane/core/dist/cjs/blade/input-binding/api/input-binding.d.ts:23
Returns void

Generated using TypeDoc