Class Pane

The root pane of Tweakpane.

Hierarchy

RootApi
- Pane

Index

Constructors

constructor

new Pane(opt_config?: PaneConfig): Pane
Parameters
- Optional opt_config: PaneConfig
Returns Pane
Overrides RootApi.constructor
- Defined in tweakpane/src/main/ts/pane/pane.ts:50

Accessors

children

get children(): BladeApi<BladeController<View>>[]
Children of the container.

Returns BladeApi<BladeController<View>>[]
Inherited from RootApi.children
- Defined in core/src/blade/folder/api/folder.ts:68

disabled

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

document

get document(): Document
Returns Document
- Defined in tweakpane/src/main/ts/pane/pane.ts:76

element

get element(): HTMLElement
Returns HTMLElement
Inherited from RootApi.element
- Defined in tweakpane/src/main/ts/blade/root/api/root.ts:13

expanded

get expanded(): boolean
Returns boolean
Inherited from RootApi.expanded
- Defined in core/src/blade/folder/api/folder.ts:52
set expanded(expanded: boolean): void
Parameters
- expanded: boolean
Returns void
Inherited from RootApi.expanded
- Defined in core/src/blade/folder/api/folder.ts:56

hidden

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

title

get title(): undefined | string
Returns undefined | string
Inherited from RootApi.title
- Defined in core/src/blade/folder/api/folder.ts:60
set title(title: undefined | string): void
Parameters
- title: undefined | string
Returns void
Inherited from RootApi.title
- Defined in core/src/blade/folder/api/folder.ts:64

Methods

add

add<A>(api: A, opt_index?: number): A
Type Parameters
- A extends BladeApi<BladeController<View>, A>
Parameters
- api: A
- Optional opt_index: number
Returns A
Inherited from RootApi.add
- Defined in core/src/blade/folder/api/folder.ts:92

addBinding

addBinding<O, Key>(object: O, key: Key, opt_params?: BindingParams): BindingApi<unknown, O[Key], BindingController<unknown, ValueController<unknown, View, Value<unknown>>, BindingValue<unknown>>>
Creates a new binding and add it to the container.

Returns
The API object.
Type Parameters
- O extends Bindable
- Key extends string | number | symbol
Parameters
- object: O
  
  The binding target.
- key: Key
  
  The key of the target property.
- Optional opt_params: BindingParams
  
  The options of a binding.
Returns BindingApi<unknown, O[Key], BindingController<unknown, ValueController<unknown, View, Value<unknown>>, BindingValue<unknown>>>
Inherited from RootApi.addBinding
- Defined in core/src/blade/folder/api/folder.ts:72

addBlade

addBlade(params: BaseBladeParams): BladeApi<BladeController<View>>
Creates a new blade and add it to the container.
Parameters
- params: BaseBladeParams
  
  The options for a blade.
Returns BladeApi<BladeController<View>>
Inherited from RootApi.addBlade
- Defined in core/src/blade/folder/api/folder.ts:100

addButton

addButton(params: ButtonParams): ButtonApi
Parameters
- params: ButtonParams
Returns ButtonApi
Inherited from RootApi.addButton
- Defined in core/src/blade/folder/api/folder.ts:84

addFolder

addFolder(params: FolderParams): FolderApi
Parameters
- params: FolderParams
Returns FolderApi
Inherited from RootApi.addFolder
- Defined in core/src/blade/folder/api/folder.ts:80

addTab

addTab(params: TabParams): TabApi
Parameters
- params: TabParams
Returns TabApi
Inherited from RootApi.addTab
- Defined in core/src/blade/folder/api/folder.ts:88

dispose

dispose(): void
Returns void
Overrides RootApi.dispose
- Defined in tweakpane/src/main/ts/pane/pane.ts:83

exportState

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

importState

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

off

off<EventName>(eventName: EventName, handler: ((ev: FolderApiEvents[EventName]) => void)): Pane
Removes a global event listener.

Returns
The API object itself.
Type Parameters
- EventName extends keyof FolderApiEvents
Parameters
- eventName: EventName
  
  The event name to listen.
- handler: ((ev: FolderApiEvents[EventName]) => void)
  
  The event handler.
  - - (ev: FolderApiEvents[EventName]): void
    - Parameters
      
      ev: FolderApiEvents[EventName]
      
      Returns void
Returns Pane
Inherited from RootApi.off
- Defined in core/src/blade/folder/api/folder.ts:133

on

on<EventName>(eventName: EventName, handler: ((ev: FolderApiEvents[EventName]) => void)): Pane
Adds a global event listener. It handles all events of child inputs/monitors.

Returns
The API object itself.
Type Parameters
- EventName extends keyof FolderApiEvents
Parameters
- eventName: EventName
  
  The event name to listen.
- handler: ((ev: FolderApiEvents[EventName]) => void)
  
  The event handler.
  - - (ev: FolderApiEvents[EventName]): void
    - Parameters
      
      ev: FolderApiEvents[EventName]
      
      Returns void
Returns Pane
Inherited from RootApi.on
- Defined in core/src/blade/folder/api/folder.ts:110

refresh

refresh(): void
Refreshes the target.

Returns void
Inherited from RootApi.refresh
- Defined in core/src/blade/common/api/container-blade.ts:25

registerPlugin

registerPlugin(bundle: TpPluginBundle): void
Parameters
- bundle: TpPluginBundle
Returns void
- Defined in tweakpane/src/main/ts/pane/pane.ts:102

remove

remove(api: BladeApi<BladeController<View>>): void
Parameters
- api: BladeApi<BladeController<View>>
Returns void
Inherited from RootApi.remove
- Defined in core/src/blade/folder/api/folder.ts:96

Class Pane

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Optional opt_config: PaneConfig

Returns Pane

Accessors

children

Returns BladeApi<BladeController<View>>[]

disabled

Returns boolean

Parameters

disabled: boolean

Returns void

document

Returns Document

element

Returns HTMLElement

expanded

Returns boolean

Parameters

expanded: boolean

Returns void

hidden

Returns boolean

Parameters

hidden: boolean

Returns void

title

Returns undefined | string

Parameters

title: undefined | string

Returns void

Methods

add

Type Parameters

A extends BladeApi<BladeController<View>, A>

Parameters

api: A

Optional opt_index: number

Returns A

addBinding

Returns

Type Parameters

O extends Bindable

Key extends string | number | symbol

Parameters

object: O

key: Key

Optional opt_params: BindingParams

Returns BindingApi<unknown, O[Key], BindingController<unknown, ValueController<unknown, View, Value<unknown>>, BindingValue<unknown>>>

addBlade

Parameters

params: BaseBladeParams

Returns BladeApi<BladeController<View>>

addButton

Parameters

params: ButtonParams

Returns ButtonApi

addFolder

Parameters

params: FolderParams

Returns FolderApi

addTab

Parameters

params: TabParams

Returns TabApi

dispose

Returns void

exportState

Returns BladeState

importState

Parameters

state: BladeState

Returns boolean

`Optional` opt_config: PaneConfig

`Optional` opt_index: number

`Optional` opt_params: BindingParams