ItemSettingsAPI interface
An interface representing item settings related APIs
Methods
| on |
Registers to a callback function invoked when the item settings panel is closed. |
| open(Open |
Opens the item settings panel. |
| set |
Adjusts the height of the extesnion iframe embedded in "Item Settings -> About". |
Method Details
onClose((config: OnCloseItemSettingsContext) => void)
Registers to a callback function invoked when the item settings panel is closed.
function onClose(callback: (config: OnCloseItemSettingsContext) => void)Parameters
- callback
-
(config: OnCloseItemSettingsContext) => void
The callback function
open(OpenItemSettingsConfig)
Opens the item settings panel.
function open(config: OpenItemSettingsConfig): Promise<OpenUIResult>Parameters
- config
- OpenItemSettingsConfig
The configuration of the item settings panel
Returns
Promise<OpenUIResult>
A promise which resolves when the item settings panel opens up
setIframeDimensions({ iframeHeight: string, itemId: string })
Adjusts the height of the extesnion iframe embedded in "Item Settings -> About".
function setIframeDimensions(config: { iframeHeight: string, itemId: string })Parameters
- config
-
{ iframeHeight: string, itemId: string }
Includes iframe height to set (in pixels, example: '10px')