ActionsAPI
Registers a custom action for a specific event type.
Returns the custom export video action if registered, otherwise returns the default.
Executes a registered action with the provided parameters. Throws an error if the action is not registered.
Returns all registered action IDs.
CreativeEditorSDK
The version of the CE.SDK package.
Access to the CreativeEngine instance that powers the editor.
Access to the [UserInterfaceAPI](https://img.ly/docs/cesdk/angular/api/cesdk-js/classes/userinterfaceapi/) for controlling the editor's user interface
Access to the [InternationalizationAPI](https://img.ly/docs/cesdk/angular/api/cesdk-js/classes/internationalizationapi/) to control locale and translations
Access to the [FeatureAPI](https://img.ly/docs/cesdk/angular/api/cesdk-js/classes/featureapi/) to control feature availability
Access to the [ActionsAPI](https://img.ly/docs/cesdk/angular/api/cesdk-js/classes/actionsapi/) to control event actions
Access to the [UtilsAPI](https://img.ly/docs/cesdk/angular/api/cesdk-js/classes/utilsapi/) for utility functions
The version of the Creative Editor SDK
Disposes the editor and engine if no longer needed.
Creates an editor and renders it for the given container.
Registers a callback function to be executed when resetEditor is called.
Disable the warning logged when no scene is available.
Resets the editor to a clean state by disabling all features, clearing UI configurations, and removing asset sources.
Re-applies the user's initial deprecated configuration that was passed to
CreativeEditorSDK.create(). This restores deprecated configuration
values that may have been cleared by resetEditor().
Adds translations to be used by the editor.
Adds and initializes a plugin to the editor.
Convenience function to register a set of our default asset sources.
Convenience function that registers a set of demo asset sources
Trigger a refetch of the asset source and update the asset library panel with the new items accordingly.
Create a scene with a single empty page with the given format.
Create a scene with a single empty page with the given format.
Loads the given image and creates a scene with a single page showing the image.
Create a scene from the provided video.
Load an encoded scene from the provided string.
Load an encoded scene from the provided string.
Load the scene stored in the file at the given URL.
Load a previously archived scene from the URL to the scene file.
Save and return a scene as a base64 encoded string.
Exports one or multiple page(s) as an file in the given mimeType
| Name | Type |
| ------ | ------ |
| addIconSet() | (id, svgSprite) => void |
| setComponentOrder() | (\_options, order) => void |
| setTheme() | (theme) => void |
| Name | Type |
| ------ | ------ |
| setTranslations() | (definition) => void |
Returns the baseURL that was provided in the configuration during editor initialization.
Predicates are evaluated in this order:
set()
set()
FeatureAPI
Enables one or more features using their default predicates.
Disables one or more features.
Sets a feature's enabled state, replacing any existing predicates.
Lists all registered feature IDs, optionally filtered by a pattern.
Gets the predicate chain for a specific feature.
Checks if one or more features are currently enabled.
Checks if a feature has registered predicates.
InternationalizationAPI
Gets the currently active locale.
Returns all available locales that have been loaded.
Sets the active locale for the editor interface.
Adds custom translations for the editor interface.
Retrieves the translations for the specified locales.
Translates a key or array of keys to the current locale.
UserInterfaceAPI
Adds a new asset library entry for display in asset libraries.
Updates an existing asset library entry with new properties.
Removes an asset library entry from the available entries.
Gets a specific asset library entry by its ID.
Gets all currently registered asset library entry IDs.
Sets the asset library entries to use for the background track in video scenes.
Gets the asset library entries configured for the background track in video scenes.
Sets a function that determines which asset library entries to use for replacement operations.
Registers a panel with builder-based rendering system.
): void ``` ***
Registers a panel with builder-based rendering system.
Registers a component that can be rendered at different UI locations.
): void ```
Displays a modal dialog with custom content and actions.
Updates an existing dialog with new content or properties.
Closes a dialog programmatically.
Displays a non-blocking notification message to the user.
Dismisses a notification programmatically.
Updates an existing notification with new content or properties.
PLEASE NOTE: This contains experimental APIs.
Gets the current view style of the editor interface.
Sets the view style of the editor interface.
programmatically applies a crop preset to a design block.
Opens a panel if it exists, is not already open, and is currently registered.
Closes panels that match the given pattern. Supports wildcard matching.
Checks if a panel is currently open.
Gets all panel IDs, optionally filtered by state or position.
Sets the position of a panel within the editor interface.
Gets the current position of a panel.
Sets whether a panel floats over the canvas.
Checks if a panel is currently floating over the canvas.
Gets the resolved theme that is currently being used. If the theme configuration is 'system', returns the OS preference. If the theme configuration is a function, it is evaluated lazily and the result is returned.
Sets the theme configuration.
Sets the rendering order of components in the dock area.
Gets the current rendering order of dock components.
Updates a component in the render order of the dock area.
Removes a component from the render order of the dock area.
Inserts a component into the render order of the dock area.
Sets the rendering order of components in the inspector bar.
Gets the current rendering order of inspector bar components.
Updates a component in the render order of the inspector bar.
Removes a component from the render order of the inspector bar.
Inserts a component into the render order of the inspector bar.
Sets the rendering order of components in the canvas menu.
Gets the current rendering order of canvas menu components.
Updates a component in the render order of the canvas menu.
Removes a component from the render order of the canvas menu.
Inserts a component into the render order of the canvas menu.
Sets the rendering order of components in the navigation bar.
Updates a component in the render order of the navigation bar.
Removes a component from the render order of the navigation bar.
Inserts a component into the render order of the navigation bar.
Gets the current rendering order of navigation bar components.
Sets the rendering order of components in the canvas bar.
Gets the current rendering order of canvas bar components at the specified position.
Updates a component in the render order of the canvas bar.
Removes a component from the render order of the canvas bar.
Inserts a component into the render order of the canvas bar.
Adds a custom icon set to the editor interface.
Gets the resolved scale that is currently being used. If the scale configuration is a function, it is evaluated lazily and the result is returned.
Sets the scale configuration.
Sets the rendering order of components in a UI area.
Gets the current rendering order of components in a UI area.
Updates components matching a criteria in one or more UI areas.
Removes components matching a criteria from one or more UI areas.
Inserts one or more components into a UI area at a specified position.
Gets the active order context for a UI area.
Sets the active order context for a UI area.
UtilsAPI
Generates the automatic, localized fallback name for a design block. When the block does not have an explicit name set, this mirrors the naming shown in the UI panels.
Shows and manages a loading dialog with progress tracking
Exports content with a loading dialog and progress tracking. Automatically handles both static exports (images, PDFs) and video exports based on MIME type.
Opens a file picker dialog for the user to select a file
Downloads a blob, string, or OPFS path as a file to the user's device
Performs a local upload of a file (development only)
Calculates the recommended viewport padding based on current viewport size and settings. This utility matches the internal padding used by the SDK for zoom operations. The calculation accounts for safe area insets to ensure content remains visible in UI-safe regions (avoiding notches, rounded corners, system overlays, etc.).
Checks if the current browser supports video decoding/playback.
Checks if the current browser supports video encoding/export.
UserInterfaceAPI
| Type Parameter |
| ------ |
| T |
| Type Parameter |
| ------ |
| T |
| Parameter | Type |
| ------ | ------ |
| id | string |
| Type Parameter |
| ------ |
| T |