Class ListBladeApi<T>

Type Parameters

Hierarchy

BladeApi<LabeledValueBladeController<T, ListController<T>>>
- ListBladeApi

Implements

EventListenable<ApiChangeEvents<T>>

Index

Accessors

disabled element hidden label options value

Methods

dispose exportState importState off on

Accessors

disabled

get disabled(): boolean
Returns boolean
Inherited from BladeApi.disabled
- Defined in core/src/blade/common/api/blade.ts:21
set disabled(disabled: boolean): void
Parameters
- disabled: boolean
Returns void
Inherited from BladeApi.disabled
- Defined in core/src/blade/common/api/blade.ts:25

element

get element(): HTMLElement
Returns HTMLElement
Inherited from BladeApi.element
- Defined in core/src/blade/common/api/blade.ts:17

hidden

get hidden(): boolean
Returns boolean
Inherited from BladeApi.hidden
- Defined in core/src/blade/common/api/blade.ts:29
set hidden(hidden: boolean): void
Parameters
- hidden: boolean
Returns void
Inherited from BladeApi.hidden
- Defined in core/src/blade/common/api/blade.ts:33

label

get label(): undefined | null | string
Returns undefined | null | string
- Defined in tweakpane/src/main/ts/blade/list/api/list.ts:29
set label(label: undefined | null | string): void
Parameters
- label: undefined | null | string
Returns void
- Defined in tweakpane/src/main/ts/blade/list/api/list.ts:33

options

get options(): ListItem<T>[]
Returns ListItem<T>[]
- Defined in tweakpane/src/main/ts/blade/list/api/list.ts:37
set options(options: ListItem<T>[]): void
Parameters
- options: ListItem<T>[]
Returns void
- Defined in tweakpane/src/main/ts/blade/list/api/list.ts:41

value

get value(): T
Returns T
- Defined in tweakpane/src/main/ts/blade/list/api/list.ts:45
set value(value: T): void
Parameters
- value: T
Returns void
- Defined in tweakpane/src/main/ts/blade/list/api/list.ts:49

Methods

dispose

dispose(): void
Returns void
Inherited from BladeApi.dispose
- Defined in core/src/blade/common/api/blade.ts:37

exportState

exportState(): BladeState
Returns BladeState
Inherited from BladeApi.exportState
- Defined in core/src/blade/common/api/blade.ts:45

importState

importState(state: BladeState): boolean
Parameters
- state: BladeState
Returns boolean
Inherited from BladeApi.importState
- Defined in core/src/blade/common/api/blade.ts:41

off

off<EventName>(eventName: EventName, handler: ((ev: ApiChangeEvents<T>[EventName]) => void)): ListBladeApi<T>
Type Parameters
- EventName extends "change"
Parameters
- eventName: EventName
- handler: ((ev: ApiChangeEvents<T>[EventName]) => void)
  - - (ev: ApiChangeEvents<T>[EventName]): void
    - Parameters
      
      ev: ApiChangeEvents<T>[EventName]
      
      Returns void
Returns ListBladeApi<T>
Implementation of EventListenable.off
- Defined in tweakpane/src/main/ts/blade/list/api/list.ts:70

on

on<EventName>(eventName: EventName, handler: ((ev: ApiChangeEvents<T>[EventName]) => void)): ListBladeApi<T>
Type Parameters
- EventName extends "change"
Parameters
- eventName: EventName
- handler: ((ev: ApiChangeEvents<T>[EventName]) => void)
  - - (ev: ApiChangeEvents<T>[EventName]): void
    - Parameters
      
      ev: ApiChangeEvents<T>[EventName]
      
      Returns void
Returns ListBladeApi<T>
Implementation of EventListenable.on
- Defined in tweakpane/src/main/ts/blade/list/api/list.ts:53

Class ListBladeApi<T>

Type Parameters

T

Hierarchy

Implements

Index

Accessors

Methods

Accessors

disabled

Returns boolean

Parameters

disabled: boolean

Returns void

element

Returns HTMLElement

hidden

Returns boolean

Parameters

hidden: boolean

Returns void

label

Returns undefined | null | string

Parameters

label: undefined | null | string

Returns void

options

Returns ListItem<T>[]

Parameters

options: ListItem<T>[]

Returns void

value

Returns T

Parameters

value: T

Returns void

Methods

dispose

Returns void

exportState

Returns BladeState

importState

Parameters

state: BladeState

Returns boolean

off

Type Parameters

EventName extends "change"

Parameters

eventName: EventName

handler: ((ev: ApiChangeEvents<T>[EventName]) => void)

Parameters

ev: ApiChangeEvents<T>[EventName]

Returns void

Returns ListBladeApi<T>

on

Type Parameters

EventName extends "change"

Parameters

eventName: EventName

handler: ((ev: ApiChangeEvents<T>[EventName]) => void)

Parameters

ev: ApiChangeEvents<T>[EventName]

Returns void

Returns ListBladeApi<T>

Settings

Member Visibility

Theme