Search
Loading...
Skip to content

Package: @cesdk/cesdk-js

Classes#

ClassDescription
FeatureAPIControls the availability of features within the Creative Editor SDK.
InternationalizationAPIManages localization and internationalization settings for the Creative Editor SDK.
UserInterfaceAPIControl the user interface and behavior of the Creative Editor SDK.
CreativeEditorSDKThe main entry point for the Creative Editor SDK.
AssetAPIManage asset sources and apply assets to scenes.
BlockAPICreate, manipulate, and query the building blocks of your design.
CreativeEngineThe 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.
EditorAPIControl the design editor’s behavior and settings.
EventAPISubscribe to block lifecycle events in the design engine.
SceneAPICreate, load, save, and manipulate scenes.
VariableAPIManage text variables within design templates.

Functions#

FunctionDescription
supportsBrowserChecks if the current browser supports necessary technologies to match our supported browsers
checkVideoSupportThrows an error if the current browser does not support video editing.
supportsVideoChecks if the current browser supports video editing.
checkVideoExportSupportThrows an error if the current browser does not support video exporting.
supportsVideoExportChecks if the current browser supports video exporting.
supportsWasmChecks if the current browser supports web assembly

Type Aliases#

Type AliasDescription
FeatureIdAll built-in CE.SDK Feature Ids.
Configuration-
PageFormatDefinition-
DockOrderComponentId-
CanvasMenuComponentIdA list of the component IDs that can be used in the canvas menu.
NavigationBarComponentIdA list of the component IDs that can be used in the navigation bar.
CanvasBarComponentIdA list of the component IDs that can be used in the canvas bar.
InspectorBarComponentIdA list of the component IDs that can be used in the inspector bar.
ComponentId-
AssetLibraryDockComponent-
DockOrderComponent-
DialogType-
DialogSize-
DialogContent-
DialogAction-
DialogProgress-
NotificationType-
NotificationDuration-
PanelId-
AssetLibraryPanelPayload-
UnknownPanelPayload-
PanelPayload-
PanelOptions-
OptionalTurn value at K of T into a Partial
EditorPluginContext-
IsEnabledFeatureContext-
FeaturePredicateContextThe context for the feature predicate function.
FeaturePredicateThe feature predicate is used to enable or disable a feature based on the boolean or the return value of the function.
PanelDisposer-
CustomPanelMountFunction-
Suffix-
PreviewTypeImage-
PreviewTypeColor-
PreviewType-
BuilderRenderFunctionFunction that defines a component with the help of the passed builder object.
HorizontalBlockAlignment- Left: The blocks get left aligned. - Right: The blocks get right aligned. - Center: The blocks get center aligned.
VerticalBlockAlignment- Top: The blocks get top aligned. - Bottom: The blocks get bottom aligned. - Center: The blocks get center aligned.
PositionMode- Absolute: Position in absolute design units. - Percent: Position in relation to the block’s parent’s size in percent, where 1.0 means 100%. - Auto: Position is automatically determined
SizeMode- Absolute: Size in absolute design units. - Percent: Size in relation to the block’s parent’s size in percent, where 1.0 means 100%. - Auto: Size is automatically determined
ContentFillMode- Crop: Manual crop. - Cover: Automatically cover the entire frame. - Contain: Automatically contain content inside frame.
PropertyType-
StrokePosition-
StrokeStyle-
StrokeCornerGeometry-
BlendMode-
TextCase-
BooleanOperationNames of boolean operations.
EngineExportOptions-
VideoExportOptions-
AudioExportOptions-
DropShadowOptionsOptions for configuring drop shadow effects on blocks.
AnimationEntryConfiguration options for animations.
AnimationOptionsOptions for configuring animations (in, loop, out animations).
AddImageOptionsOptions for adding images to the scene.
SettingType-
SettingsBool-
SettingsString-
SettingsFloat-
SettingsColor-
SettingsColorRGBA-
SettingsEnum-
ZoomOptionsOptions for zooming to a block with optional animation.
CreateSceneOptionsOptions for creating a video scene.
DefaultAssetSourceId-
DemoAssetSourceId-
TypefaceDefinition-
EnginePluginContext-
LogLevel-
MimeType-
ImageMimeType-
AudioMimeType-
VideoMimeType-
ApplicationMimeType-
AssetGroupsAn 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.
SortingOrderThe 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.
AssetMetaDataGeneric asset information
AssetColorAsset Color payload
AssetTransformPresetTransform preset payload
AssetPropertyAsset property for payload
DesignBlockTypeShorthandThe 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).
DesignBlockTypeLonghandThe 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).
DesignBlockTypeThe 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.
ShapeTypeShorthandThe shorthand block type IDs for the shape blocks. These are the IDs used to create new shapes using cesdk.engine.block.createShape(id).
ShapeTypeLonghandThe longhand block type IDs for the blocks. These are the IDs used to create new shapes using cesdk.engine.block.createShape(id).
ShapeTypeThe 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.
FillTypeShorthandThe shorthand block type IDs for the fill blocks. These are the IDs used to create new fills using cesdk.engine.block.createFill(id).
FillTypeLonghandThe longhand block type IDs for the fill blocks. These are the IDs used to create new fills using cesdk.engine.block.createFill(id).
FillTypeThe 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.
EffectTypeShorthandThe shorthand block type IDs for the effect blocks. These are the IDs used to create new effects using cesdk.engine.block.createEffect(id).
EffectTypeLonghandThe longhand block type IDs for the effect blocks. These are the IDs used to create new effects using cesdk.engine.block.createEffect(id).
EffectTypeThe 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.
BlurTypeShorthandThe shorthand block type IDs for the blur blocks. These are the IDs used to create new blurs using cesdk.engine.block.createBlur(id).
BlurTypeLonghandThe longhand block type IDs for the blur blocks. These are the IDs used to create new blurs using cesdk.engine.block.createBlur(id).
BlurTypeThe 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.
AnimationTypeShorthandThe shorthand block type IDs for the animation blocks. These are the IDs used to create new animations using cesdk.engine.block.createAnimation(id).
AnimationTypeLonghandThe longhand block type IDs for the animation blocks. These are the IDs used to create new animations using cesdk.engine.block.createAnimation(id).
AnimationTypeThe 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.
ObjectTypeShorthandThe 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.
ObjectTypeLonghandThe 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.
ObjectTypeThe 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.
OffscreenCanvasA simplified placeholder type for OffscreenCanvas, to avoid a dependency on @types/offscreencanvas
CanvasAn HTML Canvas or an Offscreen Canvas
HexColorStringA hexadecimal color value (RGB or RGBA) that starts with a ’#‘
PaletteColorA color definition for the custom color palette. The RGB and CMYK components must all be specified in the range [0-1].
ColorSpace-
CutoutType-
CutoutOperation-
DesignBlockIdA numerical identifier for a design block
HistoryIdA numerical identifier for a history stack
SceneLayoutThe scene layout determines how the layout stack should layout its pages.
AnimationEasingThe easing options for the camera animation.
SceneModeThe mode of the scene defines how the editor and playback should behave.
ZoomAutoFitAxisThe axis(es) for which to auto-fit.
DesignUnitThe unit type in which the page values (size, distances, etc.) are defined.
EditMode-
FontWeight-
FontStyle-
RoleString-
Scope-
RGBA-
CMYK-
XYWHDescribes a rectangle on the screen - x and y indicate the position - w and h indicate the width and height
GradientstopRGBA-
BlockStateDescribes the state of the block which affect its rendering.

Enumerations#

EnumerationDescription
ViewStyle-
PanelPosition-

Interfaces#

InterfaceDescription
CESDKConfiguration-
AssetLibraryEntry-
ReplaceAssetLibraryEntriesContext-
UserInterface-
ComponentPayload-
OrderComponent-
CustomDockComponent-
ExportOptions-
Dialog-
Notification-
EditorPlugin-
Translations-
OrderContext-
ButtonOptions-
ButtonGroupOptions-
CheckboxOptions-
SelectValue-
SelectOptions-
DropdownChildrenContext-
DropdownOptions-
MediaPreviewOptions-
InputOptions-
TextAreaOptions-
TextInputOptions-
NumberInputOptions-
ColorInputOptions-
SliderOptions-
LibraryOptions-
SectionOptions-
TextOptions-
HeadingOptions-
BuilderInterface 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-
AddVideoOptionsOptions for adding videos to the scene.
HTMLCreativeEngineCanvasElementA wrapper around a plain canvas
_EngineConfiguration-
EnginePlugin-
Logger-
SourceA single source width an intrinsic width & height.
AssetRGBColorAsset Color payload RGB representation
AssetCMYKColorAsset Color payload CMYK representation
AssetSpotColorAsset Color payload SpotColor representation
AssetFixedAspectRatioAsset transform preset payload fixed aspect ratio
AssetFreeAspectRatioAsset transform preset payload free aspect ratio
AssetFixedSizeAsset transform preset payload fixed size
AssetStringPropertyAsset string property definition
AssetNumberPropertyAsset number property definition
AssetBooleanPropertyAsset boolean property definition
AssetEnumPropertyAsset enum property definition
AssetColorPropertyAsset color property definition
AssetPayloadAsset payload
AssetGeneric asset information
AssetDefinitionDefinition of an asset used if an asset is added to an asset source.
AssetResultSingle asset result of a query from the engine.
CompleteAssetResultAsset results that are returned from the engine.
AssetQueryDataDefines a request for querying assets
AssetsQueryResultReturn type of a findAssets query.
AssetSourceA source of assets
RGBColorAll components between 0 and 1
RGBAColorAll components between 0 and 1
CMYKColorAll components between 0 and 1
SpotColor-
GradientColorStop-
RangeAn open range.
Font-
Typeface-
Buffer-
TransientResource-
BlockEvent-

Namespaces#

NamespaceDescription
ConfigTypes-
CESDKConfiguration-
UserInterfaceElements-
ExperimentalUserInterfaceAPI-
ExperimentalBuilder-

Variables#

VariableDescription
LogLevel-
MimeType-