Class RootApi

Hierarchy

FolderApi
- RootApi
  - Pane

Index

Accessors

Methods

Accessors

children

get children(): BladeApi<BladeController<View>>[]

- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:37
Returns BladeApi<BladeController<View>>[]

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

element

get element(): HTMLElement

- Defined in src/main/ts/blade/root/api/root.ts:19
Returns HTMLElement

expanded

get expanded(): boolean
set expanded(expanded: boolean): any

- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:33
Returns boolean
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:34
Parameters
- expanded: 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

title

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

- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:35
Returns undefined | string
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:36
Parameters
- title: undefined | string
Returns any

Methods

add

add<A>(api: A, opt_index?: number): A

Inherited from FolderApi.add
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:44
Type parameters
- A: BladeApi<BladeController<View>, A>
Parameters
- api: A
- Optional opt_index: number
Returns A

addBlade

addBlade(params: BaseBladeParams): BladeApi<BladeController<View>>

Inherited from FolderApi.addBlade
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:46
Parameters
- params: BaseBladeParams
Returns BladeApi<BladeController<View>>

addButton

addButton(params: ButtonParams): ButtonApi

Inherited from FolderApi.addButton
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:41
Parameters
- params: ButtonParams
Returns ButtonApi

addFolder

addFolder(params: FolderParams): FolderApi

Inherited from FolderApi.addFolder
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:40
Parameters
- params: FolderParams
Returns FolderApi

addInput

addInput<O, Key>(object: O, key: Key, opt_params?: InputParams): InputBindingApi<unknown, O[Key]>

Inherited from FolderApi.addInput
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:38
Type parameters
- O: Record<string, any>
- Key: string
Parameters
- object: O
- key: Key
- Optional opt_params: InputParams
Returns InputBindingApi<unknown, O[Key]>

addMonitor

addMonitor<O, Key>(object: O, key: Key, opt_params?: MonitorParams): MonitorBindingApi<O[Key]>

Inherited from FolderApi.addMonitor
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:39
Type parameters
- O: Record<string, any>
- Key: string
Parameters
- object: O
- key: Key
- Optional opt_params: MonitorParams
Returns MonitorBindingApi<O[Key]>

addSeparator

addSeparator(opt_params?: BaseParams): SeparatorApi

Inherited from FolderApi.addSeparator
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:42
Parameters
- Optional opt_params: BaseParams
Returns SeparatorApi

addTab

addTab(params: TabParams): TabApi

Inherited from FolderApi.addTab
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:43
Parameters
- params: TabParams
Returns TabApi

dispose

dispose(): void

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

exportPreset

exportPreset(): PresetObject

- Defined in src/main/ts/blade/root/api/root.ts:41
Exports a preset of all inputs.

Returns PresetObject

An exported preset object.

importPreset

importPreset(preset: PresetObject): void

- Defined in src/main/ts/blade/root/api/root.ts:27
Imports a preset of all inputs.

Parameters
- preset: PresetObject
  
  The preset object to import.
Returns void

on

on<EventName>(eventName: EventName, handler: (ev: FolderApiEvents[EventName]["event"]) => void): FolderApi

Inherited from FolderApi.on
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:52
Adds a global event listener. It handles all events of child inputs/monitors.

Type parameters
- EventName: keyof FolderApiEvents
Parameters
- eventName: EventName
  
  The event name to listen.
- handler: (ev: FolderApiEvents[EventName]["event"]) => void
  - - (ev: FolderApiEvents[EventName]["event"]): void
    - Parameters
      - ev: FolderApiEvents[EventName]["event"]
      Returns void
Returns FolderApi

The API object itself.

refresh

refresh(): void

- Defined in src/main/ts/blade/root/api/root.ts:53
Refreshes all bindings of the pane.

Returns void

remove

remove(api: BladeApi<BladeController<View>>): void

Inherited from FolderApi.remove
- Defined in node_modules/@tweakpane/core/dist/cjs/blade/folder/api/folder.d.ts:45
Parameters
- api: BladeApi<BladeController<View>>
Returns void

Generated using TypeDoc