Skip to main content

Class: WidgetNamespace

Hierarchy

  • NamespaceBase

    WidgetNamespace

Methods

closePopup

closePopup(restoreFocus?): Promise<void>

Parameters

NameTypeDefault value
restoreFocusbooleantrue

Returns

Promise<void>


getDimensions

getDimensions(widgetInstanceId): Promise<DOMRect>

Parameters

NameType
widgetInstanceIdnumber

Returns

Promise<DOMRect>


getWidgetContext

getWidgetContext<T>(): Promise<WidgetLocationContextDataMap[T] extends undefined ? { widgetInstanceId: string } : WidgetLocationContextDataMap[T] & { widgetInstanceId: string }>

Type parameters

NameType
Textends WidgetLocation

Returns

Promise<WidgetLocationContextDataMap[T] extends undefined ? { widgetInstanceId: string } : WidgetLocationContextDataMap[T] & { widgetInstanceId: string }>


getWidgetsAtLocation

getWidgetsAtLocation(location, remId?): Promise<{ fileName: string ; pluginId: string }[]>

Parameters

NameType
locationWidgetLocation
remId?string

Returns

Promise<{ fileName: string ; pluginId: string }[]>


openPopup

openPopup(widgetFileName, contextData?, clickOutsideToClose?): Promise<void>

Parameters

NameType
widgetFileNamestring
contextData?any
clickOutsideToClose?boolean

Returns

Promise<void>