Classes#
| Class | Description |
|---|---|
| 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. |
| EngineActions | Named, overridable actions for one engine. Actions are either JS closures you register or engine defaults (e.g. undo/redo), and either kind can override the other by reusing the id. |
| EngineError | Structured CE.SDK error. Extends the standard JS Error so existing try { ... } catch (error) { console.log(error.message); } flows keep working — message is the engine’s rendered English string. The structured fields (code, category, hint, args, docsUrl, silent) let consumers branch on stable identifiers instead of matching on the message string and surface customer-facing copy + doc links. |
| EventAPI | Subscribe to block lifecycle events in the design engine. |
| SceneAPI | Create, load, save, and manipulate scenes. |
| ShortcutsAPI | engine.shortcuts — a remappable map of keyboard shortcuts to actions. |
| VariableAPI | Manage text variables within design templates. |
Functions#
| Function | Description |
|---|---|
| checkVideoExportSupport | Throws an error if the current browser does not support video exporting. |
| checkVideoSupport | Throws an error if the current browser does not support video editing. |
| _combineProperties | Combines multiple reactive properties into a single reactive property. |
| _createDerivedProperty | Creates a derived reactive property from one or more sources. |
| _createReactiveProperty | Creates a reactive property with subscribe, value, and update methods. |
| _createTrackedProperty | Creates a reactive property that tracks a source and updates based on a getter/setter. |
| createVariableFontCombinations | Generates an array of Font entries for a variable font file. |
| defaultLogger | - |
| isCMYKColor | Type guard for CMYKColor. |
| isEngineError | Predicate that narrows an unknown thrown value to EngineError. |
| isRGBAColor | Type guard for RGBAColor. |
| isSpotColor | Type guard for SpotColor. |
| _makeSource | Creates a simple event source that can emit values to subscribed listeners. |
| _mergeSources | Merges multiple event sources into a single source that emits when any source emits. |
| normalizeKeyCombo | Convert a combo into the internal canonical form (sorted modifiers, lowercase letters, Mod for Cmd/Ctrl). Exposed so hosts can match against it. |
| supportsBrowser | Checks if the current browser supports necessary technologies to match our supported browsers |
| supportsVideo | Checks if the current browser supports video editing. |
| supportsVideoExport | Checks if the current browser supports video exporting. |
| supportsWasm | Checks if the current browser supports web assembly |
Type Aliases#
| Type Alias | Description |
|---|---|
| AddImageOptions | Options for adding images to the scene. |
| AnimationBaselineDirection | - |
| AnimationBlockSwipeTextDirection | - |
| AnimationEasing | - |
| AnimationEntry | Configuration options for animations. |
| AnimationGrowDirection | - |
| AnimationJumpLoopDirection | - |
| AnimationKenBurnsDirection | - |
| AnimationMergeTextDirection | - |
| AnimationOptions | Options for configuring animations (in, loop, out animations). |
| AnimationSpinDirection | - |
| AnimationSpinLoopDirection | - |
| 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. |
| 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). |
| AnimationTypeShorthand | - |
| AnimationTypewriterTextWritingStyle | - |
| AnimationWipeDirection | - |
| ApplicationMimeType | Represents the application MIME types used in the editor. |
| AssetColor | Asset Color payload |
| AssetFilter | Filter expression — predicate or logical combinator. Combinators nest arbitrarily. The union is mutually exclusive: an object with both and and or, or with property next to a combinator key, is rejected at the type level. |
| 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. |
| AssetMetaData | Generic asset information |
| AssetProperty | Asset property for payload |
| AssetPropertyFilter | A single property predicate. Exactly one of contains (case-insensitive substring) or equals (case-insensitive equality) must be set — the type forbids passing both or neither. On a string-array property (tags, groups), the operator matches if any element matches. |
| AssetPropertyPath | Dot-path against the resolved asset that a property predicate targets: label, id, tags, groups, or meta.<key> (one segment — meta values in the engine are flat strings). |
| AssetStylePresetAnimationProperties | The parameters of an AssetStylePresetAnimation: a map of the animation’s property paths to values. The animation’s animation/* properties (e.g. animation/slide/fade, animation/grow/scaleFactor) are value-checked and autocomplete, as are the animation controls (playback/duration, animationEasing, textWritingStyle, textWritingOverlap); any other property path is still accepted. These are animation paths, distinct from the block-property paths in AssetStylePresetProperties. |
| AssetStylePresetProperties | The look of an AssetStylePreset: a map of property paths to values. Known paths are value-checked and autocomplete (e.g. stroke/enabled must be a boolean, stroke/width a number, fill/solid/color a color); any other property path is still accepted with the broader AssetStylePresetPropertyValue. Keys without a / are namespaced to the block (text/ or caption/); keys with a / are used verbatim. |
| AssetStylePresetPropertyValue | A value a style preset can set on a property: a boolean, number, string (including enum values) or an RGB(A) color. Colors must be RGB(A) ({ r, g, b, a? }); CMYK and spot colors are not supported in presets. Structs and source sets cannot be set from a preset. A null value is ignored for regular properties; for the virtual text/path property it clears the baseline path. |
| AssetStylePresetScalableProperty | A length property a style preset may scale with the block’s font size (see AssetStylePreset.scaleWithFontSize). Restricted to the decoration lengths for which scaling is meaningful — stroke width, drop-shadow offset/blur and the caption background corner radius — not arbitrary numeric properties like rotation or opacity. |
| AssetTransformPreset | Transform preset payload |
| AsyncURIResolver | An async-compatible URI resolver function. |
| AudioExportOptions | Represents the options for exporting audio. |
| AudioFromVideoOptions | Options for configuring audio extraction from video operations. |
| AudioMimeType | Represents the audio MIME types used in the editor. |
| BlendMode | - |
| BlockEnumType | - |
| BlockState | Represents the state of a design block. |
| 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. |
| 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). |
| BlurTypeShorthand | - |
| BooleanOperation | Represents the names of boolean operations. |
| BoolPropertyName | - |
| CameraClampingOvershootMode | - |
| Canvas | An HTML Canvas or an Offscreen Canvas |
| CaptionHorizontalAlignment | - |
| CaptionVerticalAlignment | - |
| CMYK | Represents a color in the CMYK color space. |
| Color | Represents all color types supported by the engine. |
| ColorPickerColorMode | - |
| ColorPropertyName | - |
| ColorSpace | Represents the color space used in the editor. |
| ContentFillMode | - |
| ControlGizmoMoveHandleVisibility | - |
| ControlGizmoResizeHandlesVisibility | - |
| ControlGizmoRotateHandlesVisibility | - |
| ControlGizmoScaleHandlesVisibility | - |
| CreateSceneOptions | Options for creating a video scene. |
| CutoutOperation | Represents the type of a cutout. |
| CutoutType | - |
| Represents the default asset source IDs used in the editor. | |
| Represents the default demo asset source IDs used in the editor. | |
| DesignBlockId | A numerical identifier for a design block |
| 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. |
| 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). |
| DesignBlockTypeShorthand | - |
| DoubleClickSelectionMode | - |
| DoublePropertyName | - |
| DropShadowOptions | Options for configuring drop shadow effects on blocks. |
| EditMode | Represents the current edit mode of the editor. |
| 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. |
| 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). |
| EffectTypeShorthand | - |
| EngineActionId | Known action ids from EngineActionsRegistry. |
| EngineCustomActionFunction | A generic, untyped action function for custom ids. |
| EngineErrorArg | Typed value of a structured-error template argument. The engine preserves the original primitive type (boolean, number, string) when crossing the binding boundary, so customer-facing i18n layers can format numbers, plurals, etc. without parsing stringified values. |
| EngineErrorCode | Every stable catalog error code as a string-literal union. Use it to type-check a branch on EngineError.code (which stays a plain string so unknown/future codes never break consumers): |
| EnginePluginContext | Represents the context for an engine plugin. |
| EnumPropertyName | - |
| EnumValues | - |
| _EqualsFn | A function that compares two values for equality |
| ExportOptions | Represents the options for exporting a design block. |
| FillPixelStreamOrientation | - |
| 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. |
| 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). |
| FillTypeShorthand | - |
| FloatPropertyName | - |
| FontSizeUnit | Extended design unit type that includes Point for font size operations. Maintains consistency with SceneDesignUnit’s capitalized naming convention. |
| FontStyle | Allowed font styles. Mirrors the WASM FontStyle union. |
| FontWeight | Allowed font weights. Mirrors the @cesdk/engine (WASM) FontWeight union so a single Font is interchangeable across bindings. |
| GradientstopRGBA | Represents a gradient stop in the RGBA color space. |
| HeightMode | - |
| HexColorString | Represents a hexadecimal color value (RGB or RGBA) that starts with a ‘#’. |
| HistoryId | A numerical identifier for a history stack |
| HistoryUpdate | Describes the kind of update that triggered an onHistoryUpdatedWithKind callback. |
| HorizontalBlockAlignment | - |
| HorizontalContentFillAlignment | - |
| ImageMimeType | Represents the image MIME types used in the editor. |
| IntPropertyName | - |
| _LegacySource | A simplified source type for legacy API streams |
| _Listener | A listener function that receives value updates |
| ListStyle | Represents the list style of a paragraph. |
| Locale | e.g. en, de, etc. |
| LogLevel | Provides logging functionality for the Creative Editor SDK. |
| MimeType | Represents the MIME types used in the editor. |
| 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. |
| 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. |
| 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. |
| OffscreenCanvas | A simplified placeholder type for OffscreenCanvas, to avoid a dependency on @types/offscreencanvas |
| OptionalPrefix | - |
| PageGuidesSource | - |
| PaletteColor | Represents a color definition for the custom color palette. |
| PositionMode | - |
| PositionXMode | - |
| PositionYMode | - |
| 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. |
| RGBA | Represents a color in the RGBA color space. |
| RoleString | Represents a role string. |
| DesignUnit | - |
| SceneFontSizeUnit | - |
| SceneLayout | - |
| SceneMode | - |
| 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. |
| SettingBoolPropertyName | - |
| SettingColorPropertyName | - |
| SettingEnumPropertyName | - |
| SettingEnumType | - |
| SettingEnumValues | - |
| SettingFloatPropertyName | - |
| SettingIntPropertyName | - |
| SettingKey | Union type of all valid setting keys. |
| SettingsBool | - |
| SettingsColor | Represents the color settings available in the editor. |
| Represents the color settings available in the editor. | |
| SettingsEnum | - |
| SettingsFloat | - |
| SettingsInt | - |
| SettingsString | - |
| SettingStringPropertyName | - |
| SettingType | Represents the type of a setting. |
| SettingValueType | Gets the value type for a specific setting key. |
| 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. |
| ShapeTypeLonghand | The longhand block type IDs for the blocks. These are the IDs used to create new shapes using cesdk.engine.block.createShape(id). |
| ShapeTypeShorthand | - |
| ShapeVectorPathFillRule | - |
| ShortcutRoot | The DOM root the keyboard listener attaches to. |
| ShortcutRun | A shortcut’s effect: an action id run via engine.actions.run, or a function called with the ShortcutContext. Returning false from a function suppresses the automatic preventDefault for that keypress. |
| ShortcutScopeId | Identifier for a UI scope, resolved from the DOM at dispatch time by walking data-shortcut-scope ancestors from the focused element up to the root. |
| SizeMode | - |
| 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. |
| SourceSetPropertyName | - |
| SplitOptions | Options for configuring block split operations. |
| StringPropertyName | - |
| StrokeCap | - |
| StrokeCornerGeometry | - |
| StrokeDashEndCap | - |
| StrokeDashStartCap | - |
| StrokeEndCap | - |
| StrokePosition | - |
| StrokeStartCap | - |
| StrokeStyle | - |
| _Subscription | Represents a subscription to an event. |
| SyncURIResolver | A synchronous URI resolver function. |
| TextAnimationWritingStyle | - |
| TextCase | Represents the text case of a text block. |
| TextDecorationLine | Represents a line type for text decoration. |
| TextDecorationStyle | Represents the style of a text decoration line. |
| HorizontalTextAlignment | - |
| TextVerticalAlignment | - |
| TimelineTrackVisibility | - |
| TouchPinchAction | - |
| TouchRotateAction | - |
| Represents a typeface definition used in the editor. | |
| _Unsubscribe | An unsubscribe function that removes a listener |
| VerticalBlockAlignment | - |
| VerticalContentFillAlignment | - |
| VideoExportOptions | Represents the options for exporting a video. |
| VideoMimeType | Represents the video MIME types used in the editor. |
| WidthMode | - |
| XYWH | Describes a rectangle on the screen. |
| ZoomAutoFitAxis | The axis(es) for which to auto-fit. |
| ZoomOptions | Options for zooming to a block with optional animation. |
Enumerations#
| Enumeration | Description |
|---|---|
| CompressionFormat | Compression format for scene serialization. |
| CompressionLevel | Compression level for scene serialization. |
Interfaces#
| Interface | Description |
|---|---|
| AddVideoOptions | Options for adding videos to the scene. |
| ApplyAssetOptions | Options for applying an asset to the scene. |
| Asset | Generic asset information |
| AssetBooleanProperty | Asset boolean property definition |
| AssetCMYKColor | Asset Color payload CMYK representation |
| AssetColorProperty | Asset color property definition |
| AssetContentAspectRatio | Asset transform preset payload that snaps a block’s frame to the intrinsic aspect ratio of the block’s content (e.g. the underlying image or video). |
| AssetDefinition | Definition of an asset used if an asset is added to an asset source. |
| AssetEnumProperty | Asset enum property definition |
| AssetFixedAspectRatio | Asset transform preset payload fixed aspect ratio |
| AssetFixedSize | Asset transform preset payload fixed size |
| AssetFreeAspectRatio | Asset transform preset payload free aspect ratio |
| AssetNumberProperty | Asset number property definition |
| AssetPayload | Asset payload |
| AssetQueryData | Defines a request for querying assets |
| AssetResult | Single asset result of a query from the engine. |
| _AssetResultCredits | Represents the credits for an asset result. |
| _AssetResultLicense | Represents the license for an asset result. |
| AssetRGBColor | Asset Color payload RGB representation |
| AssetSource | A source of assets |
| AssetSpotColor | Asset Color payload SpotColor representation |
| AssetsQueryResult | Return type of a findAssets query. |
| AssetStringProperty | Asset string property definition |
| AssetStylePreset | A declarative style preset the engine applies to text and caption blocks. The engine parses and applies it identically on every platform. Lives in AssetPayload.stylePreset. |
| AssetStylePresetAnimation | An animation slot of an AssetStylePreset (inAnimation, outAnimation or loopAnimation). |
| AudioTrackInfo | Information about a single audio track from a video. This interface provides comprehensive metadata about audio tracks, including codec information, technical specifications, and track details. |
| BlockEvent | Represents an event related to a design block. |
| BlockStateError | Represents an error state for a design block. |
| BlockStatePending | Represents a pending state for a design block. |
| BlockStateReady | Represents a ready state for a design block. |
| BlurEvent | Dispatched on the engine canvas when the text input has been blurred. Call preventDefault() to disallow this and refocus the engine text input. |
| Buffer | Represents a buffer of data. |
| CharacterInkBox | Tight ink-paint bounding box of a single grapheme, in global scene coordinates. Returned by block.getTextCharacterInkBoxes. The baseline Y is reported separately because it does not equal y + height (the box is the tight ink rect; the baseline anchors glyph descenders). |
| CMYKColor | Represents a CMYK color value. |
| CompleteAssetResult | Asset results that are returned from the engine. |
| Configuration | Specifies the configuration for the Creative Editor SDK. |
| CursorEvent | Dispatched on the engine canvas when the text input has been blurred. Call preventDefault() to disallow this and refocus the engine text input. |
| DominantColor | A single color extracted from the rendered appearance of a block. |
| DominantColorsOptions | Options for BlockAPI.getDominantColors. |
| EngineActionInfo | Info about a registered action, from EngineActions.list. |
| EngineActionsRegistry | Hook for hosts to add strongly-typed action ids. Augment via declare module '@cesdk/engine' to get autocomplete on register/run while still allowing custom string ids. |
| EnginePlugin | Represents an engine plugin. |
| _FindAssetsQuery | Represents a query for finding assets. |
| _Flip | Specifies the horizontal and vertical flip states of a design block. |
| Font | Individual font within a typeface. Field optionality matches @cesdk/engine (WASM) — fields not present in the engine response are simply omitted rather than empty strings. |
| FontMetrics | Font metrics extracted from a font file. Values are in the font’s design units coordinate space. |
| GradientColorStop | Represents a gradient color stop. |
| HTMLCreativeEngineCanvasElement | A wrapper around a plain canvas |
| Logger | Represents a logger function. |
| PageDuration | - |
| Range | An open range. |
| Reaction | Reactions track read calls and provide a way to react if they change. |
| _ReactiveProperty | A reactive property with subscribe, value, and update methods |
| _ReactivePropertyOptions | Options for creating a reactive property |
| Reactor | The reactor coordinates the update of registered Reactions. |
| _ReadonlyReactiveProperty | A read-only reactive property with subscribe and value methods |
| RefocusEvent | Dispatched on the engine canvas right before the engine will refocus its text input after a blur. Call preventDefault() to prevent the refocusing. |
| RGBAColor | Represents an RGBA color value. |
| RGBColor | Represents an RGB color value. |
| Settings | Map of all available settings with their types. This provides type-safe access to all editor settings. |
| Shortcut | A keyboard shortcut. keys is a chord ('Mod+z'); sequences (string arrays) currently bind on their first chord. run is an action id or an inline function. |
| ShortcutContext | Passed to a shortcut’s when check and to a function run. |
| Size2 | - |
| Source | A single source width an intrinsic width & height. |
| _Source | A source that can emit values to subscribed listeners |
| SpotColor | Represents a spot color value. |
| TextDecorationConfig | Configuration for text decorations on a text run. |
| TextFontSizeOptions | Options for text font size operations with unit support. |
| TextRunInfo | Represents a single contiguous text run with uniform formatting. |
| TransientResource | Represents a transient resource. |
| Typeface | Typeface definition |
| _UBQAudioFromVideoOptions | Specifies options for configuring audio extraction from video operations. |
| _UBQExportAudioOptions | Specifies options for exporting audio design blocks to various formats. |
| _UBQExportOptions | Specifies options for exporting design blocks to various formats. |
| _UBQExportVideoOptions | Specifies options for exporting video design blocks to various formats. |
| _UBQSplitOptions | Specifies options for configuring block split operations. |
| Vec2 | - |
| Vec3 | - |