PopupManagerPlugin
Defined in: plugins/PopupManagerPlugin.ts:37
PopupManager
Extends
Section titled “Extends”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PopupManagerPlugin(
id):PopupManagerPlugin
Defined in: plugins/Plugin.ts:48
Parameters
Section titled “Parameters”string = 'Plugin'
Returns
Section titled “Returns”PopupManagerPlugin
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”__dill_pixel_method_binding_root
Section titled “__dill_pixel_method_binding_root”__dill_pixel_method_binding_root:
boolean
Defined in: plugins/Plugin.ts:39
Inherited from
Section titled “Inherited from”Plugin.__dill_pixel_method_binding_root
readonlyid:string='popups'
Defined in: plugins/PopupManagerPlugin.ts:38
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”onHidePopup
Section titled “onHidePopup”onHidePopup:
Signal<(detail) =>void>
Defined in: plugins/PopupManagerPlugin.ts:43
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.onHidePopup
onPopupChanged
Section titled “onPopupChanged”onPopupChanged:
Signal<(detail) =>void>
Defined in: plugins/PopupManagerPlugin.ts:44
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.onPopupChanged
onShowPopup
Section titled “onShowPopup”onShowPopup:
Signal<(detail) =>void>
Defined in: plugins/PopupManagerPlugin.ts:42
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.onShowPopup
readonlyview:Container<Application<DataSchema,ActionContext,Action,Renderer>>
Defined in: plugins/PopupManagerPlugin.ts:39
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get app():
A
Defined in: plugins/Plugin.ts:53
Returns
Section titled “Returns”A
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”current
Section titled “current”Get Signature
Section titled “Get Signature”get current():
undefined|IPopup<any>
Defined in: plugins/PopupManagerPlugin.ts:60
Returns
Section titled “Returns”undefined | IPopup<any>
Implementation of
Section titled “Implementation of”currentPopupId
Section titled “currentPopupId”Get Signature
Section titled “Get Signature”get currentPopupId():
undefined|string|number
Defined in: plugins/PopupManagerPlugin.ts:52
Returns
Section titled “Returns”undefined | string | number
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.currentPopupId
hasActivePopups
Section titled “hasActivePopups”Get Signature
Section titled “Get Signature”get hasActivePopups():
boolean
Defined in: plugins/PopupManagerPlugin.ts:67
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.hasActivePopups
options
Section titled “options”Get Signature
Section titled “Get Signature”get options():
O
Defined in: plugins/Plugin.ts:44
Returns
Section titled “Returns”O
Implementation of
Section titled “Implementation of”Inherited from
Section titled “Inherited from”popupCount
Section titled “popupCount”Get Signature
Section titled “Get Signature”get popupCount():
number
Defined in: plugins/PopupManagerPlugin.ts:56
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.popupCount
Methods
Section titled “Methods”addPopup()
Section titled “addPopup()”addPopup<
T>(id,popup):void
Defined in: plugins/PopupManagerPlugin.ts:95
Add a popup
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”The id of the popup
string | number
The popup constructor
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: plugins/Plugin.ts:79
Add signal connections to the container.
Parameters
Section titled “Parameters”…SignalConnection[]
The signal connections to add.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.addSignalConnection
Inherited from
Section titled “Inherited from”clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:85
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.clearSignalConnections
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/PopupManagerPlugin.ts:85
Destroy the PopupManager
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Overrides
Section titled “Overrides”hidePopup()
Section titled “hidePopup()”hidePopup<
T>(id,data?):Promise<undefined|IPopup<T>>
Defined in: plugins/PopupManagerPlugin.ts:141
Hide a popup
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”The id of the popup
string | number
T
Returns
Section titled “Returns”Promise<undefined | IPopup<T>>
a promise resolving to the popup, if it exists
Implementation of
Section titled “Implementation of”initialize()
Section titled “initialize()”initialize():
void
Defined in: plugins/PopupManagerPlugin.ts:76
Initialize the PopupManager
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.initialize
Overrides
Section titled “Overrides”postInitialize()
Section titled “postInitialize()”postInitialize(
_app):void|Promise<void>
Defined in: plugins/Plugin.ts:68
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.postInitialize
Inherited from
Section titled “Inherited from”removeAllPopups()
Section titled “removeAllPopups()”removeAllPopups(
animate):void
Defined in: plugins/PopupManagerPlugin.ts:166
Remove all popups
Parameters
Section titled “Parameters”animate
Section titled “animate”boolean = false
Whether to animate the removal
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IPopupManagerPlugin.removeAllPopups
showPopup()
Section titled “showPopup()”showPopup<
T>(id,config):Promise<undefined|IPopup<T>>
Defined in: plugins/PopupManagerPlugin.ts:105
Show a popup
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”The id of the popup
string | number
config
Section titled “config”Partial<PopupConfig<T>> = {}
The configuration for the popup
Returns
Section titled “Returns”Promise<undefined | IPopup<T>>
a promise resolving to the popup, if it exists