Window

Window

Class representing an iframe window from Contentstack UI. Not available for Custom Widgets.

Methods

disableAutoResizing() → {Window}

Source:
This method disables auto resizing of the extension height.
Returns:
.
Type
Window

enableAutoResizing() → {Window}

Source:
This method enables auto resizing of the extension height.
Returns:
.
Type
Window

enableResizing() → {external:Promise}

Source:
This method activates the resize button that gives you the provision to resize the window size of your Dashboard Widget.
Returns:
A promise object which will resolve when a resize button is visible on the Dashboard Widget.
Type
external:Promise

onDashboardResize(callback) → {boolean}

Source:
This function executes the callback function whenever a Dashboard Widget extension is maximized or minimized. Only applicable on Dashboard Widget extensions.
Parameters:
Name Type Description
callback function Function to be called when a Dashboard Widget extension is maximized or minimized
Returns:
Will return true
Type
boolean

updateHeight(height) → {external:Promise}

Source:
This method updates the extension height on Contentstack UI. If the ‘height’ argument is not passed, it will calculate the scroll height and set the height of extension window accordingly.
Parameters:
Name Type Description
height string | number Desired height of the iframe window
Returns:
A promise object which will be resolved when Contentstack UI sends an acknowledgement stating that the height has been updated.
Type
external:Promise