Save Scenes to a String

In this example, we will show you how to save scenes as a string with the CreativeEditor SDK.

Explore a full code sample on Stackblitz or view the code on Github.

CreativeEditor SDK allows you to save scenes in a binary format to share them between editors or store them for later editing. This is done by converting the contents of a scene to a single string, which can then be stored or transferred.

Warning#

A scene file does not include any fonts or images. Only the source URIs of assets, the general layout, and element properties are stored. When loading scenes in a new environment, ensure previously used asset URIs are available.

To get hold of such a string, you need to use engine.scene.saveToString(). This is an asynchronous method returning a Promise. After waiting for the Promise to resolve, we receive a plain string holding the entire scene currently loaded in the editor. This includes all pages and any hidden elements, but none of the actual asset data.

The returned string consists solely of ASCII characters and can safely be used further or written to a database.


import CreativeEngine from 'https://cdn.img.ly/packages/imgly/cesdk-engine/1.41.1/index.js';

const config = {
  license: 'mtLT-_GJwMhE7LDnO8KKEma7qSuzWuDxiKuQcxHKmz3fjaXWY2lT3o3Z2VdL5twm',
  userId: 'guides-user',
  baseURL: 'https://cdn.img.ly/packages/imgly/cesdk-engine/1.41.1/assets'
};

CreativeEngine.init(config).then(async (engine) => {
  engine.scene
    .saveToString()
    .then((sceneAsString) => {
      console.log('Save succeeded');
      console.log(sceneAsString);
    })
    .catch((error) => {
      console.error('Save failed', error);
    });
});