DataStore Actions
Table of Contents
Viewport Actions
setViewports
Description: Updates the list of all viewports.
Parameters:
viewports: Viewports– Object containing all viewport definitions
setViewport
Description: Sets the current active viewport.
Parameters:
viewport: number– Index of the viewport to activate
setViewportType
Description: Sets viewport based on type.
Parameters:
viewportType: 'mobile' | 'tablet' | 'desktop'
setPrevViewport
Description: Switches to the previous viewport.
Parameters:
viewportType: 'mobile' | 'tablet' | 'desktop' | ''(optional) – Limit previous viewport selection by type
setNextViewport
Description: Switches to the next viewport.
Parameters:
viewportType: 'mobile' | 'tablet' | 'desktop' | ''(optional) – Limit next viewport selection by type
setDesktop / setTablet / setMobile
Description: Stores the current viewport as the default for desktop, tablet, or mobile.
Parameters: None
setIframeSize
Description: Sets the iframe size and adjusts the viewport to fit.
Parameters:
size: Size– Width and height for the iframe
Status Indicator Actions
| Action | Description | Parameters |
|---|---|---|
setRegistering / unsetRegistering | Updates registering indicator | None |
setLoading / unsetLoading | Updates loading indicator | None |
setSaving / unsetSaving | Updates saving indicator | None |
setAutoSaving / unsetAutoSaving | Updates autosaving indicator | None |
setActive / unsetActive | Updates active state | None |
Editing & Inspecting Actions
| Action | Description | Parameters |
|---|---|---|
setEditing / unsetEditing / toggleEditing | Updates editing indicator | None |
setInspecting / unsetInspecting / toggleInspecting | Updates inspecting indicator | None |
toggleActive | Toggles active viewport simulation | None |
setInspectorPosition | Updates inspector position | position: string |
Viewport Toggle Actions
| Action | Description | Parameters |
|---|---|---|
toggleDesktop | Switches to stored desktop viewport | None |
toggleTablet | Switches to stored tablet viewport | None |
toggleMobile | Switches to stored mobile viewport | None |
Block Management Actions
registerBlockInit
Description: Initializes a block’s state.
Parameters:
clientId: string– Unique block IDblockName: string– Name of the blockattributes: BlockAttributes– Initial block attributes
updateBlockChanges
Description: Updates block changes for a specific viewport.
Parameters:
clientId: stringblockName: stringattributes: BlockAttributesviewport: number | null(optional)
addBlockPropertyChanges
Description: Adds a style property to a block’s changes.
Parameters:
clientId: stringblockName: stringviewport: numberprop: string– Name of the property
removeBlock
Description: Removes a block entirely.
Parameters:
clientId: string
removeBlockSaves / restoreBlockSaves
Description: Removes or restores saved properties for a block.
Parameters:
clientId: stringblockName: stringprops: string[]– List of propertiesviewport: number
saveBlock
Description: Permanently saves a block.
Parameters:
clientId: stringblockName: string
clearBlocks
Description: Clears all blocks.
Parameters: None
Renderer Actions
registerRenderer
Description: Registers a custom renderer function.
Parameters:
prop: string– Property namecallback: Function– Rendering callbackpriority: number– Priority of the renderer (default: 10)groupId: string– Optional group IDpanelId: string– Optional panel IDmapping: RendererMapping– Optional mapping for renderer