Skip to main content

Class: TweakpaneWrapper

UI-Plugins.TweakpaneWrapper

Hierarchy

Properties

undoManager

Optional Readonly undoManager: JSUndoManager


_pane

Protected Optional _pane: Pane


_container

Protected Readonly _container: HTMLElement


_refreshQueue

Protected _refreshQueue: Record<TUiRefreshModes, [undefined | IUiConfigContainer<any, string>, undefined | FolderApi, number, undefined | string][]>


_typeGenerators

Protected _typeGenerators: any

Constructors

constructor

new TweakpaneWrapper(expanded?, bigTheme?, limitedOptions?, autoPostFrame?, container?)

Parameters

NameTypeDefault value
expandedbooleanfalse
bigThemebooleanfalse
limitedOptionsbooleanfalse
autoPostFramebooleantrue
containerHTMLElementdocument.body

Overrides

SimpleEventDispatcher<'postFrame'\>.constructor

Methods

refreshQueue

refreshQueue(mode): void

Parameters

NameType
modeTUiRefreshModes

Returns

void


addToRefreshQueue

addToRefreshQueue(mode, params): void

Parameters

NameType
modeTUiRefreshModes
params[undefined | IUiConfigContainer<any, string>, undefined | FolderApi, number]

Returns

void


dispose

dispose(): void

Returns

void


appendUiObject

appendUiObject(p?, parent?): void

Parameters

NameType
p?IUiConfigContainer<any, string>
parent?FolderApi

Returns

void


appendChild

appendChild(ui): void

Parameters

NameType
uiUiObjectConfig<any, string>

Returns

void


removeUiObject

removeUiObject(objectMain?): void

Parameters

NameType
objectMain?IUiConfigContainer<any, string>

Returns

void


removeUiConfig

removeUiConfig(uiConfig?): void

Dispose and removes the UI associated with a config, doesn't makes change to the object or its parent.

Parameters

NameType
uiConfig?UiObjectConfig<any, string>

Returns

void


alert

alert(message?): Promise<void>

Parameters

NameType
message?string

Returns

Promise<void>


confirm

confirm(message?): Promise<boolean>

Parameters

NameType
message?string

Returns

Promise<boolean>


prompt

prompt(message?, _default?, cancel?): Promise<null | string>

Parameters

NameTypeDefault value
message?stringundefined
_default?stringundefined
cancelbooleantrue

Returns

Promise<null | string>


_appendUiObject

Protected _appendUiObject(objectMain?, parent?): void

Parameters

NameType
objectMain?IUiConfigContainer<any, string>
parent?FolderApi

Returns

void