Classes#
| Class | Description |
|---|---|
| FeatureAPI | Controls the availability of features within the Creative Editor SDK. |
| InternationalizationAPI | Manages localization and internationalization settings for the Creative Editor SDK. |
| UserInterfaceAPI | Control the user interface and behavior of the Creative Editor SDK. |
| CreativeEditorSDK | The main entry point for the Creative Editor SDK. |
| AssetAPI | Manage asset sources and apply assets to scenes. |
| BlockAPI | Create, manipulate, and query the building blocks of your design. |
| CreativeEngine | The CreativeEngine is the core processing unit of CE.SDK and handles state management, rendering, input handling, and much more. It provides APIs to directly interact with assets, blocks, scenes, and variables. These APIs can be used in a headless environment to build and manipulate designs programmatically, or in a browser to create interactive applications. |
| EditorAPI | Control the design editor’s behavior and settings. |
| EventAPI | Subscribe to block lifecycle events in the design engine. |
| SceneAPI | Create, load, save, and manipulate scenes. |
| VariableAPI | Manage text variables within design templates. |
Functions#
| Function | Description |
|---|---|
| supportsBrowser | Checks if the current browser supports necessary technologies to match our supported browsers |
| checkVideoSupport | Throws an error if the current browser does not support video editing. |
| supportsVideo | Checks if the current browser supports video editing. |
| checkVideoExportSupport | Throws an error if the current browser does not support video exporting. |
| supportsVideoExport | Checks if the current browser supports video exporting. |
| supportsWasm | Checks if the current browser supports web assembly |
Type Aliases#
| Type Alias | Description |
|---|---|
| FeatureId | All built-in CE.SDK Feature Ids. |
| Configuration | Represents the user-provided configuration for the Creative Editor SDK. This type allows for partial configuration settings, making all properties optional. |
| PageFormatDefinition | Represents the definition of a page format in the Creative Editor SDK. This interface defines the width, height, unit, and optional fixed orientation for a page format. |
| DockOrderComponentId | Represents the ID of a dock order component. |
| CanvasMenuComponentId | Represents the ID of a canvas menu component. |
| NavigationBarComponentId | Represents the ID of a navigation bar component. |
| CanvasBarComponentId | Represents the ID of a canvas bar component. |
| InspectorBarComponentId | Represents the ID of an inspector bar component. |
| ComponentId | Represents the ID of a component. |
| AssetLibraryDockComponent | Represents an asset library dock component. |
| DockOrderComponent | Represents a dock order component. |
| DialogType | Represents the type of dialog. |
| DialogSize | Represents the size of the dialog. |
| DialogContent | Represents the content of the dialog. |
| DialogAction | Represents an action in the dialog. |
| DialogProgress | Represents the progress of the dialog. |
| NotificationType | Represents the type of notification. |
| NotificationDuration | Represents the duration of the notification. |
| PanelId | Represents a unique identifier for a panel in the Creative Editor SDK. This type defines specific panel IDs and allows for custom panel IDs. |
| AssetLibraryPanelPayload | Represents the payload for the asset library panel in the Creative Editor SDK. This interface defines the title and entries for the asset library panel. |
| UnknownPanelPayload | Represents an unknown payload for a panel in the Creative Editor SDK. This type defines a generic payload with unknown keys and values. |
| PanelPayload | Represents the payload for a panel in the Creative Editor SDK. This type defines the payload based on the panel ID. |
| PanelOptions | Represents the options for a panel in the Creative Editor SDK. This interface defines the options for a panel, including whether it is closable by the user, its position, whether it is floating, and its payload. |
| Optional | Turn value at K of T into a Partial |
| EditorPluginContext | Represents the context for an editor plugin. This type extends the EnginePluginContext with an optional cesdk property. |
| IsEnabledFeatureContext | Represents the context for determining if a feature is enabled. This type includes the CreativeEngine instance. |
| FeaturePredicateContext | Represents the context for enabling a feature. This type extends IsEnabledFeatureContext and includes a function to check the previous enable state and a function to get the default predicate. |
| FeaturePredicate | The feature predicate is used to enable or disable a feature based on the boolean or the return value of the function. |
| PanelDisposer | Represents a function that disposes of a panel. |
| CustomPanelMountFunction | Represents a function that mounts a custom panel. |
| InsertOrderComponentLocation | Represents the location for inserting an order component. |
| Suffix | Represents additional options for a button, which can be used as a suffix. |
| ChildrenOrder | Represents the order of children components in a dropdown. |
| PreviewTypeImage | Represents an image preview. |
| PreviewTypeColor | Represents a color preview. |
| PreviewType | Represents a preview, which can be either an image or a color. |
| BuilderRenderFunction | Function that defines a component with the help of the passed builder object. |
| HorizontalBlockAlignment | Represents the horizontal alignment of blocks. |
| VerticalBlockAlignment | Represents the vertical alignment of blocks. |
| PositionMode | Represents the mode for positioning blocks. |
| SizeMode | Represents the mode for sizing blocks. |
| ContentFillMode | Represents the mode for filling content within a block. |
| PropertyType | Represents the various types of properties that can be associated with design blocks. Each type corresponds to a different kind of data that can be used to define the properties of a design block within the system. |
| StrokePosition | Represents the position of a stroke relative to the shape’s boundary. |
| StrokeStyle | Represents the style of a stroke. |
| StrokeCornerGeometry | Represents the corner geometry of a stroke. |
| BlendMode | Represents the blend mode of a layer or effect. |
| TextCase | Represents the text case of a text block. |
| BooleanOperation | Represents the names of boolean operations. |
| EngineExportOptions | Represents the options for exporting a design block. |
| VideoExportOptions | Represents the options for exporting a video. |
| AudioExportOptions | Represents the options for exporting audio. |
| DropShadowOptions | Options for configuring drop shadow effects on blocks. |
| AnimationEntry | Configuration options for animations. |
| AnimationOptions | Options for configuring animations (in, loop, out animations). |
| AddImageOptions | Options for adding images to the scene. |
| SettingType | Represents the type of a setting. |
| SettingsBool | Represents the boolean settings available in the editor. |
| SettingsString | Represents the string settings available in the editor. |
| SettingsFloat | Represents the float settings available in the editor. |
| SettingsColor | Represents the color settings available in the editor. |
| Represents the color settings available in the editor. | |
| SettingsEnum | Represents the enum settings available in the editor. |
| ZoomOptions | Options for zooming to a block with optional animation. |
| CreateSceneOptions | Options for creating a video scene. |
| DefaultAssetSourceId | Represents the default asset source IDs used in the editor. |
| DemoAssetSourceId | Represents the default demo asset source IDs used in the editor. |
| Represents a typeface definition used in the editor. | |
| EnginePluginContext | Represents the context for an engine plugin. |
| LogLevel | Provides logging functionality for the Creative Editor SDK. |
| MimeType | Represents the MIME types used in the editor. |
| ImageMimeType | Represents the image MIME types used in the editor. |
| AudioMimeType | Represents the audio MIME types used in the editor. |
| VideoMimeType | Represents the video MIME types used in the editor. |
| ApplicationMimeType | Represents the application MIME types used in the editor. |
| AssetGroups | An asset can be member of multiple groups. Groups have a semantic meaning used to build and group UIs exploring the assets, e.g.sections in the content library, or for things like topics in Unsplash for instance. |
| SortingOrder | The order to sort by if the asset source supports sorting. If set to None, the order is the same as the assets were added to the source. |
| AssetMetaData | Generic asset information |
| AssetColor | Asset Color payload |
| AssetTransformPreset | Transform preset payload |
| AssetProperty | Asset property for payload |
| DesignBlockTypeShorthand | The shorthand block type IDs for the top-level design blocks. These are the IDs used to create new blocks using cesdk.engine.block.create(id). |
| DesignBlockTypeLonghand | The longhand block type IDs for the top-level design blocks. These are the IDs used to create new blocks using cesdk.engine.block.create(id). |
| DesignBlockType | The block type IDs for the top-level design blocks. These are the IDs used to create new blocks using cesdk.engine.block.create(id). Refer to DesignBlockTypeShorthand and DesignBlockTypeLonghand for more details. |
| ShapeTypeShorthand | The shorthand block type IDs for the shape blocks. These are the IDs used to create new shapes using cesdk.engine.block.createShape(id). |
| ShapeTypeLonghand | The longhand block type IDs for the blocks. These are the IDs used to create new shapes using cesdk.engine.block.createShape(id). |
| ShapeType | The block type IDs for the shape blocks. These are the IDs used to create new shapes using cesdk.engine.block.createShape(id). Refer to ShapeTypeShorthand and ShapeTypeLonghand for more details. |
| FillTypeShorthand | The shorthand block type IDs for the fill blocks. These are the IDs used to create new fills using cesdk.engine.block.createFill(id). |
| FillTypeLonghand | The longhand block type IDs for the fill blocks. These are the IDs used to create new fills using cesdk.engine.block.createFill(id). |
| FillType | The block type IDs for the fill blocks. These are the IDs used to create new fills using cesdk.engine.block.createFill(id). Refer to FillTypeShorthand and FillTypeLonghand for more details. |
| EffectTypeShorthand | The shorthand block type IDs for the effect blocks. These are the IDs used to create new effects using cesdk.engine.block.createEffect(id). |
| EffectTypeLonghand | The longhand block type IDs for the effect blocks. These are the IDs used to create new effects using cesdk.engine.block.createEffect(id). |
| EffectType | The block type IDs for the effect blocks. These are the IDs used to create new effects using cesdk.engine.block.createEffect(id). Refer to EffectTypeShorthand and EffectTypeLonghand for more details. |
| BlurTypeShorthand | The shorthand block type IDs for the blur blocks. These are the IDs used to create new blurs using cesdk.engine.block.createBlur(id). |
| BlurTypeLonghand | The longhand block type IDs for the blur blocks. These are the IDs used to create new blurs using cesdk.engine.block.createBlur(id). |
| BlurType | The block type IDs for the blur blocks. These are the IDs used to create new blurs using cesdk.engine.block.createBlur(id). Refer to BlurTypeShorthand and BlurTypeLonghand for more details. |
| AnimationTypeShorthand | The shorthand block type IDs for the animation blocks. These are the IDs used to create new animations using cesdk.engine.block.createAnimation(id). |
| AnimationTypeLonghand | The longhand block type IDs for the animation blocks. These are the IDs used to create new animations using cesdk.engine.block.createAnimation(id). |
| AnimationType | The block type IDs for the animation blocks. These are the IDs used to create new animations using cesdk.engine.block.createAnimation(id). Refer to AnimationTypeShorthand and AnimationTypeLonghand for more details. |
| ObjectTypeShorthand | The shorthand block type IDs for all blocks types in the Creative Engine. Those are the types that can be passed to cesdk.engine.block.findByType(type) for example. |
| ObjectTypeLonghand | The longhand block type IDs for all blocks types in the Creative Engine. Those are the Types returned by the engine when calling cesdk.engine.block.getType(blockId) for example. |
| ObjectType | The block type IDs for all blocks types in the Creative Engine. Those are the types that can be passed to cesdk.engine.block.findByType(type) for example. Refer to ObjectTypeShorthand and ObjectTypeLonghand for more details. |
| OffscreenCanvas | A simplified placeholder type for OffscreenCanvas, to avoid a dependency on @types/offscreencanvas |
| Canvas | An HTML Canvas or an Offscreen Canvas |
| HexColorString | Represents a hexadecimal color value (RGB or RGBA) that starts with a ’#’. |
| PaletteColor | Represents a color definition for the custom color palette. |
| ColorSpace | Represents the color space used in the editor. |
| CutoutType | Represents the type of a cutout. |
| CutoutOperation | Represents the operation performed on a cutout. |
| DesignBlockId | A numerical identifier for a design block |
| HistoryId | A numerical identifier for a history stack |
| SceneLayout | The scene layout determines how the layout stack should layout its pages. |
| AnimationEasing | The easing options for the camera animation. |
| SceneMode | The mode of the scene defines how the editor and playback should behave. |
| ZoomAutoFitAxis | The axis(es) for which to auto-fit. |
| DesignUnit | The unit type in which the page values (size, distances, etc.) are defined. |
| EditMode | Represents the current edit mode of the editor. |
| FontWeight | Represents the weight of a font. |
| FontStyle | Represents the style of a font. |
| RoleString | Represents a role string. |
| Scope | Represents the various scopes that define the capabilities and permissions within the Creative Editor SDK. Each scope corresponds to a specific functionality or action that can be performed within the editor. |
| RGBA | Represents a color in the RGBA color space. |
| CMYK | Represents a color in the CMYK color space. |
| XYWH | Describes a rectangle on the screen. |
| GradientstopRGBA | Represents a gradient stop in the RGBA color space. |
| BlockState | Represents the state of a design block. |
Enumerations#
| Enumeration | Description |
|---|---|
| ViewStyle | Represents the view style options in the Creative Editor SDK. This enum defines the possible view styles, which are ‘advanced’ and ‘default’. |
| PanelPosition | This enum is used to specify the position of various panels within the user interface, such as the inspector, settings, and asset library panels. |
Interfaces#
| Interface | Description |
|---|---|
| CESDKConfiguration | Represents the configuration settings for the Creative Editor SDK. This interface defines various settings such as locale, theme, development mode, user interface, internationalization, accessibility, callbacks, feature flags, and logger. |
| AssetLibraryEntry | Represents an entry in the asset library, combining data and view configurations. |
| ReplaceAssetLibraryEntriesContext | Provides context for replacing asset library entries, including selected blocks and default entry IDs. |
| UserInterface | Specifies the configuration for the user interface of the Creative Editor SDK. |
| ComponentPayload | Represents the payload of a component. |
| OrderComponent | Represents an order component. |
| CustomDockComponent | Represents a custom dock component. |
| ExportOptions | Specifies options for exporting design blocks to various formats. |
| Dialog | Represents a dialog configuration. |
| Notification | Represents a notification configuration. |
| EditorPlugin | Represents an editor plugin. This interface defines the structure of an editor plugin, including its name, version, and initialization function. |
| Translations | Represents a set of translations for the Creative Editor SDK. |
| OrderContext | Interface representing the context for ordering components. |
| ComponentOptions | Represents options for a component. |
| ButtonOptions | Represents options for a button. |
| ButtonGroupOptions | Represents options for a button group. |
| CheckboxOptions | Represents options for a checkbox. |
| SelectValue | Represents a value for a select input. |
| SelectOptions | Represents options for a select input. |
| DropdownChildrenContext | Represents the context for the children of a dropdown. |
| DropdownOptions | Represents options for a dropdown. |
| MediaPreviewOptions | Represents options for a media preview. |
| InputOptions | Represents options for an input. |
| TextAreaOptions | Represents options for a text area. |
| TextInputOptions | Represents options for a text input. |
| NumberInputOptions | Represents options for a number input. |
| ColorInputOptions | Represents options for a color input. |
| SliderOptions | Represents options for a slider. |
| LibraryOptions | Represents options for a library. |
| SectionOptions | Represents options for a section. |
| TextOptions | Represents options for text. |
| HeadingOptions | Represents options for a heading. |
| Builder | Interface for all available builder. Depending on the context different implementation might be used. A “Button” in the canvas menu might render different component than a button in the topbar or a panel. |
| BuilderRenderFunctionContext | Represents the context for rendering a builder function. |
| AddVideoOptions | Options for adding videos to the scene. |
| HTMLCreativeEngineCanvasElement | A wrapper around a plain canvas |
| _EngineConfiguration | Specifies the configuration for the Creative Editor SDK. |
| EnginePlugin | Represents an engine plugin. |
| Logger | Represents a logger function. |
| Source | A single source width an intrinsic width & height. |
| AssetRGBColor | Asset Color payload RGB representation |
| AssetCMYKColor | Asset Color payload CMYK representation |
| AssetSpotColor | Asset Color payload SpotColor representation |
| AssetFixedAspectRatio | Asset transform preset payload fixed aspect ratio |
| AssetFreeAspectRatio | Asset transform preset payload free aspect ratio |
| AssetFixedSize | Asset transform preset payload fixed size |
| AssetStringProperty | Asset string property definition |
| AssetNumberProperty | Asset number property definition |
| AssetBooleanProperty | Asset boolean property definition |
| AssetEnumProperty | Asset enum property definition |
| AssetColorProperty | Asset color property definition |
| AssetPayload | Asset payload |
| Asset | Generic asset information |
| AssetDefinition | Definition of an asset used if an asset is added to an asset source. |
| AssetResult | Single asset result of a query from the engine. |
| CompleteAssetResult | Asset results that are returned from the engine. |
| AssetQueryData | Defines a request for querying assets |
| AssetsQueryResult | Return type of a findAssets query. |
| AssetSource | A source of assets |
| RGBColor | Represents an RGB color value. |
| RGBAColor | Represents an RGBA color value. |
| CMYKColor | Represents a CMYK color value. |
| SpotColor | Represents a spot color value. |
| GradientColorStop | Represents a gradient color stop. |
| Range | An open range. |
| Font | Represents a font. |
| Typeface | Represents a typeface. |
| Buffer | Represents a buffer of data. |
| TransientResource | Represents a transient resource. |
| BlockEvent | Represents an event related to a design block. |
Namespaces#
| Namespace | Description |
|---|---|
| ConfigTypes | Defines the configuration settings for the Creative Editor SDK. |
| CESDKConfiguration | Namespace for CESDKConfiguration to include deprecated keys. This namespace includes deprecated keys that are part of the public API via the CombinedConfiguration type. These keys are used in the ConfigMigrations but are not used internally. |
| UserInterfaceElements | Defines the configuration for user interface elements, including panels, dock, libraries, blocks, navigation, and inspector bar. |
| ExperimentalUserInterfaceAPI | Provides experimental methods for controlling the UI of the Creative Editor SDK. |
| ExperimentalBuilder | Namespace containing experimental features for the builder. These features are subject to change and may not be stable for production use. |
Variables#
| Variable | Description |
|---|---|
| Provides a set of predefined log levels for the Creative Editor SDK. | |
| Represents the MIME types used in the editor. |