# Imgly Vue > [Source](https:/img.ly/docs/cesdk/vue/user-interface-5a089a) ## Pages - [Imgly Vue Documentation](imgly-vue-documentation.md) - [User Interface](user-interface.md) - [Vue.js Creative Editor](vuejs-creative-editor.md): The CreativeEditor SDK delivers a powerful Vue.js library designed for crafting and editing rich visual designs direc... - [Upgrade](upgrade.md) - [To v1.32](to-v132.md): Version v1.32 introduced powerful new APIs for customizing the CE.SDK web editor. These new APIs render some of the e... - [To v1.19](to-v119.md): Version v1.19 of CreativeEngineSDK and CreativeEditorSDK introduces structural changes to many of the current design ... - [To v1.13](to-v113.md): In version v1.13, the way the CreativeEngine and CreativeEditor SDK are configured has changed. Several configuration... - [To v1.10](to-v110.md): Version v1.10 introduced major changes to how and where engine and the UI store assets. This guide helps you navigate... - [Text](text.md) - [Create and Edit Stickers](create-and-edit-stickers.md) - [Create and Edit Shapes](create-and-edit-shapes.md) - [Settings](settings.md): Settings are configuration values that control CE.SDK editor behavior without modifying scene content. They are acces... - [Serve Assets](serve-assets.md): Configure CE.SDK to load engine and content assets from your own servers instead of the IMG.LY CDN for production dep... - [Download assets for current SDK versioncurl -O https://cdn.img.ly/packages/imgly/cesdk-js/1.67.0/imgly-assets.zip](download-assets-for-current-sdk-versioncurl-o-httpscdnimglypackagesimglycesdk-js.md) - [Create versioned directory and extract assetsmkdir -p public/cesdk/1.67.0unzip imgly-assets.zip -d public/cesdk/1.67.0/rm imgly-assets.zip](create-versioned-directory-and-extract-assetsmkdir-p-publiccesdk1670unzip-imgly-.md): Then configure CE.SDK to use your self-hosted assets: - [Security](security.md): This document provides a comprehensive overview of CE.SDK’s security practices, focusing on data handling, privacy, a... - [Rules](rules.md) - [Prebuilt Solutions](prebuilt-solutions.md) - [Plugins](plugins.md): Learn how to extend CE.SDK functionality with plugins to add custom features, effects, and integrations. - [Improve Performance](improve-performance.md): Optimize CE.SDK integration for faster load times, efficient memory usage, and smooth runtime performance in browser ... - [Video Editor SDK](video-editor-sdk.md): Use CreativeEditor SDK (CE.SDK) to build robust video editing experiences directly in your app. CE.SDK supports both ... - [Overview](overview.md): In CE.SDK, _inserting media into a scene_ means placing visual or audio elements directly onto the canvas—images, vid... - [Outlines](outlines.md) - [Open the Editor](open-the-editor.md) - [LLMs.txt](llmstxt.md): You can also connect your AI assistant directly to our documentation using our [MCP Server](vue/get-started/mcp-serve... - [Licensing](licensing.md): Thanks for your interest in CreativeEditor SDK (CE.SDK). - [Key Concepts](key-concepts.md): CE.SDK is built on two distinct technical layers that work together seamlessly: - [Key Capabilities](key-capabilities.md): This guide gives you a high-level look at what CreativeEditor SDK (CE.SDK) can do—and how deeply it can integrate int... - [Insert Media Into Scenes](insert-media-into-scenes.md) - [Import Media](import-media.md) - [Guides](guides.md) - [Filters and Effects](filters-and-effects.md) - [Fills](fills.md) - [File Format Support](file-format-support.md): CreativeEditor SDK (CE.SDK) supports a wide range of modern file types for importing assets and exporting final conte... - [Engine Interface](engine-interface.md): Access CE.SDK’s cross-platform C++ engine programmatically for client-side automation, background processing, and cus... - [Edit Image](edit-image.md) - [Create Videos](create-videos.md) - [Create Templates](create-templates.md) - [Create Compositions](create-compositions.md) - [Conversion](conversion.md) - [Configuration](configuration.md): Set up CE.SDK with license keys, asset base URLs, user IDs, and runtime configuration options to match your applicati... - [Concepts](concepts.md): Key Concepts and principles of CE.SDK. - [Compatibility & Security](compatibility-security.md): CE.SDK provides robust compatibility and security features across platforms. Learn about supported browsers, framewor... - [System Compatibility](system-compatibility.md): CE.SDK runs entirely on clients and makes use of hardware acceleration provided within that environment. Therefore, t... - [Colors](colors.md) - [Browser Support](browser-support.md): The CreativeEditor SDK requires specific APIs to fully function. For video-related features, the required APIs are on... - [Automate Workflows](automate-workflows.md) - [Animation](animation.md) - [Actions API](actions-api.md): The Actions API provides a centralized way to manage and customize actions for various user interactions in CE.SDK. - [UI Extensions](ui-extensions.md) - [Overview](overview-2.md): The CreativeEditor SDK (CE.SDK) includes a powerful, fully-integrated user interface that enables your users to creat... - [Localization](localization.md): Translate and customize the CE.SDK editor interface for different languages using the built-in I18n API. - [Customization](customization.md) - [Build Your Own UI](build-your-own-ui.md): Build completely custom UIs by integrating CE.SDK’s headless engine directly into your application—no built-in editor... - [Appearance](appearance.md) - [AI Integration](ai-integration.md): Learn how CE.SDK’s new AI intgrations bring intelligent content generation and enhancement directly into your creativ... - [Replace Content](replace-content.md): Dynamically replace content within templates using CE.SDK’s placeholder and variable systems. Find placeholder blocks... - [Use Templates Programmatically](use-templates-programmatically.md): Automate template workflows with CE.SDK’s engine APIs for batch processing, personalization, and headless design gene... - [Overview](overview-3.md): Templates in CreativeEditor SDK (CE.SDK) are pre-designed layouts that serve as starting points for generating static... - [Template Library](template-library.md): Configure and populate the Template Library in CE.SDK so users can browse and select predefined design templates. - [Generate From Template](generate-from-template.md): Generate finished designs from templates by loading, populating variables, and exporting to images, PDFs, or videos p... - [Apply a Template](apply-a-template.md): Apply template content to an existing scene while preserving your canvas dimensions and design unit. - [Overview](overview-4.md): In CreativeEditor SDK (CE.SDK), a _text element_ is an editable, stylable block that you can add to your design. Whet... - [Text Styling](text-styling.md): Style text blocks programmatically with colors, backgrounds, typefaces, and formatting. - [Text and Language Support](text-and-language-support.md): Support right-to-left text, complex scripts, and multilingual typography in your designs using CE.SDK’s comprehensive... - [Font Combinations](font-combinations.md): Create and customize font combinations (text components) that appear in CE.SDK’s asset library for users to insert in... - [Emojis](emojis.md): Configure emoji rendering in CE.SDK text blocks using a dedicated emoji font for consistent cross-platform display. - [Text Effects](text-effects.md): Add visual depth and interest to text blocks using drop shadows and stroke outlines. - [Edit Text](edit-text.md): Edit text content programmatically with range-based APIs for replacing, formatting, and querying text. - [Customize Fonts](customize-fonts.md): Load and configure custom fonts in CE.SDK to match brand guidelines or provide users with a curated font selection. - [Auto-Size](auto-size.md): Configure text blocks to automatically adapt their dimensions or font size for dynamic content. - [Adjust Text Spacing](adjust-text-spacing.md): Control letter spacing, line height, and paragraph spacing in text blocks using the Block API. - [Add Text](add-text.md): Create and configure text blocks in CE.SDK with custom fonts, rich text styling, and dynamic sizing options. - [Insert QR Code](insert-qr-code.md): Add scannable QR codes to designs programmatically using image fills. - [Create Cutout](create-cutout.md): Create cutout paths for cutting printers to produce die-cut stickers, iron-on decals, and custom-shaped prints progra... - [Combine Shapes](combine-shapes.md): Combine multiple shapes using boolean operations to create custom compound designs programmatically. - [Overview](overview-5.md): Learn how CE.SDK’s rules system enforces design constraints and controls editing permissions through the scopes mecha... - [Moderate Content](moderate-content.md): Use CE.SDK’s engine APIs to extract images and text from designs, then integrate with third-party moderation services... - [Enforce Brand Guidelines](enforce-brand-guidelines.md): Learn how to restrict users to approved brand assets—specific colors, fonts, and images—while preventing unauthorized... - [Lock Content](lock-content.md): Lock design elements to prevent unwanted modifications using CE.SDK’s scope-based permission system. - [How to Export Print-Ready PDFs with CE.SDK](how-to-export-print-ready-pdfs-with-cesdk.md): In this guide, you’ll learn how to use the Print Ready PDF plugin to transform CE.SDK’s standard RGB PDF exports into... - [Check PDF versionpdfinfo output.pdf | grep "PDF version"](check-pdf-versionpdfinfo-outputpdf-grep-pdf-version.md) - [Search for PDF/X markersgrep -a "PDF/X-3" output.pdf](search-for-pdfx-markersgrep-a-pdfx-3-outputpdf.md) - [Vue.js Video Editor SDK](vuejs-video-editor-sdk.md): CreativeEditor SDK provides a powerful Vue.js library designed for creating and editing videos directly within the br... - [T-Shirt Designer](t-shirt-designer.md): Quickly add a professional-grade t-shirt design editor to your web app with CE.SDK. - [Photobook Editor](photobook-editor.md): Easily embed a customizable photobook editor into your web app using CreativeEditor SDK (CE.SDK). Designed for develo... - [Postcard Editor](postcard-editor.md): The Postcard Editor is a prebuilt CreativeEditor SDK (CE.SDK) solution designed for quickly creating and personalizin... - [Vue.js Photo Editor SDK](vuejs-photo-editor-sdk.md): The CreativeEditor SDK provides a powerful and intuitive solution designed for seamless photo editing directly in the... - [Multi Image Generation](multi-image-generation.md): Generate multiple on-brand image variations from a single data source — and embed the entire workflow into your web a... - [Mockup Editor](mockup-editor.md): Visualize the final product with confidence using the Mockup Editor, a prebuilt solution built on top of CreativeEdit... - [Design Generation](design-generation.md): Automatically generate on-brand visuals with the Design Generator, a prebuilt solution built on top of CreativeEditor... - [Vue.js Design Tool & Design Editor](vuejs-design-tool-design-editor.md): Give your users a fast, intuitive way to personalize templates with layout, text, and image editing — no design exper... - [Data Merge](data-merge.md): Generate personalized designs at scale by merging structured data into CE.SDK templates. The Data Merge prebuilt solu... - [Automated Video Generation](automated-video-generation.md): Generate dynamic videos from reusable templates — right inside your web app. The Automated Video Generator is a pre-b... - [Automated Image Resizing](automated-image-resizing.md): Automatically generate size variations of your design and scale your marketing materials across platforms — directly ... - [3D Product Configurator](3d-product-configurator.md): Easily embed a customizable 3D product preview experience into your web app with CE.SDK. This prebuilt solution integ... - [AI Image and Video Editor](ai-image-and-video-editor.md): Bring the power of generative AI directly into your app with the AI Editor – a prebuilt, embeddable solution built on... - [Using Strokes](using-strokes.md): Add outlines around shapes, text, and graphics to enhance visual definition and create decorative effects. - [Shadows and Glows](shadows-and-glows.md): Add visual depth and emphasis to design elements using drop shadows and glow effects in CE.SDK. - [Overview](overview-6.md): In CreativeEditor SDK (CE.SDK), _outlines_ refer to visual enhancements added around design elements. They include st... - [URI Resolver](uri-resolver.md): Learn how to intercept and transform asset URIs in CE.SDK, enabling authentication and custom resolution logic. - [Set Zoom Level](set-zoom-level.md): Control the canvas zoom level programmatically using CE.SDK. Learn how to use the zoom APIs to set specific levels, e... - [Overview](overview-7.md): CreativeEditor SDK (CE.SDK) offers multiple ways to open the editor. Whether you’re starting with a blank canvas or i... - [Load a Scene](load-a-scene.md): Load previously saved scenes to resume editing or modify existing designs. - [Import a Design](import-a-design.md): Open existing designs from various sources in CE.SDK, including saved scenes, professional design tool files, and sou... - [Create From Video](create-from-video.md): Open CE.SDK with a video as the starting point for editing. The scene dimensions match the video resolution and timel... - [Create From Image](create-from-image.md): Create an editable scene from an image file using CE.SDK, with automatic page dimensions matching the source image fo... - [Create From Template](create-from-template.md): Load pre-designed templates to give users a professional starting point instead of a blank canvas. - [Create From HTMLCanvas](create-from-htmlcanvas.md): Create a CE.SDK scene from an HTMLCanvas element’s rendered content, enabling editing of canvas-based graphics. - [Start With Blank Canvas](start-with-blank-canvas.md): Create a new scene from scratch to build designs with complete control over canvas dimensions and initial content. - [Insert Videos](insert-videos.md): Insert videos into your CE.SDK scenes using either the convenience API or manual block creation with video fills. - [Insert Shapes or Stickers](insert-shapes-or-stickers.md): Add vector shapes and pre-made stickers to your designs using CE.SDK’s block API. Shapes require fills to be visible ... - [Positioning and Alignment](positioning-and-alignment.md): Position, align, and distribute design elements precisely using CE.SDK’s layout APIs and snapping system. - [Insert Images](insert-images.md): Insert images into your designs programmatically using CE.SDK’s engine API. - [Insert Audio](insert-audio.md): Add audio files to video projects using CE.SDK’s audio block system for background music, sound effects, and voiceovers. - [Source Sets](source-sets.md): Configure source sets for images and videos so CE.SDK automatically selects the optimal resolution for editing previe... - [Size Limits](size-limits.md): CreativeEditor SDK (CE.SDK) supports importing high-resolution images, video, and audio, but there are practical limi... - [Overview](overview-8.md): In CE.SDK, assets are the building blocks of your creative workflow—whether they’re images, videos, audio, fonts, or ... - [Retrieve MIME Type](retrieve-mime-type.md): Detect the MIME type of resources loaded in the engine and relocate them to external URLs using`engine.editor.getMim... - [Import From Remote Source](import-from-remote-source.md) - [Import From Local Source](import-from-local-source.md) - [Supported File Formats for Import](supported-file-formats-for-import.md): When building creative applications with CE.SDK, understanding which file formats your users can import is crucial fo... - [Edit or Remove Assets](edit-or-remove-assets.md): Manage assets in local asset sources by updating metadata, removing individual assets, or deleting entire sources. - [Asset Content JSON Schema](asset-content-json-schema.md): Reference documentation for the JSON schema structure used to define asset source content in CE.SDK. - [Using Default Assets](using-default-assets.md): import type { EditorPlugin, EditorPluginContext } from '@cesdk/cesdk-js';import packageJson from './package.json'; - [Asset Concepts](asset-concepts.md): Understand the foundational architecture of CE.SDK’s asset system and how asset sources organize content across platf... - [Capture From Camera](capture-from-camera.md) - [Asset Library](asset-library.md) - [Get Started](get-started.md): Welcome to our documentation! This guide will help you get started with our SDK on your preferred platform. - [Vue.js Project Without UI](vuejs-project-without-ui.md): This guide walks you through embedding the **CreativeEditor SDK (CE.SDK) Engine**—without the default UI—into a **Vue... - [New Vue.js Project](new-vuejs-project.md): This guide walks you through integrating the **CreativeEditor SDK (CE.SDK)** into a new Vue.js application. By the en... - [MCP Server](mcp-server.md): The CE.SDK MCP server provides a standardized interface that allows any compatible AI assistant to search and access ... - [Existing Vue.js Project](existing-vuejs-project.md): This guide walks you through integrating the **CreativeEditor SDK (CE.SDK)** into an existing Vue.js application. By ... - [Clone GitHub Vue Project](clone-github-vue-project.md): This guide will walk you through downloading and running a pre-built CreativeEditor SDK (CE.SDK) Vue.js integration p... - [Supported Filters and Effects](supported-filters-and-effects.md): Discover all available filters and effects in CE.SDK and learn how to check if a block supports them. - [Filters & Effects Library](filters-effects-library.md): In CreativeEditor SDK (CE.SDK), _filters_ and _effects_ refer to visual modifications that enhance or transform the a... - [Gradient Fills](gradient-fills.md): Create smooth color transitions in shapes, text, and design blocks using CE.SDK’s gradient fill system with support f... - [Distortion Effects](distortion-effects.md): Apply distortion effects to warp, shift, and transform images and videos for dynamic artistic visuals. - [Duotone](duotone.md): Apply duotone effects to images, mapping tones to two colors for stylized visuals and brand-specific treatments. - [Create a Custom LUT Filter](create-a-custom-lut-filter.md): Apply custom LUT (Look-Up Table) filters to achieve brand-consistent color grading directly through CE.SDK’s effect API. - [Pseudocode for .cube to tiled PNG conversion# 1. Parse the .cube file to extract the 3D LUT data# 2. Reshape data into (blue_slices, height, width, 3) array# 3. Arrange slices in a grid matching tile configuration# 4. Save as PNG with Image.fromarray()](pseudocode-for-cube-to-tiled-png-conversion-1-parse-the-cube-file-to-extract-the.md): The simplest approach is to use CE.SDK’s existing LUT assets as a starting point. The built-in filters use pre-genera... - [Create Custom Filters](create-custom-filters.md): Extend CE.SDK with your own LUT filters by creating and registering custom filter asset sources for brand-specific co... - [Chroma Key (Green Screen)](chroma-key-green-screen.md): Replace specific colors with transparency using CE.SDK’s green screen effect for video compositing and virtual backgr... - [Blur Effects](blur-effects.md): Apply blur effects to design elements using CE.SDK’s dedicated blur system for creating depth, focus, and atmospheric... - [Apply Filters and Effects](apply-filters-and-effects.md): Apply professional color grading, blur effects, and artistic treatments to design elements using CE.SDK’s visual effe... - [Video Fills](video-fills.md): Apply motion content to design elements by filling shapes, backgrounds, and text with videos using CE.SDK’s video fil... - [Fills](fills-2.md): Some [design blocks](vue/concepts/blocks-90241e/) in CE.SDK allow you to modify or replace their fill. The fill is an... - [Image Fills](image-fills.md): Fill shapes, text, and design blocks with photos and images from URLs, uploads, or asset libraries using CE.SDK’s ver... - [Color Fills](color-fills.md): Apply uniform solid colors to shapes, text, and design blocks using CE.SDK’s comprehensive color fill system with sup... - [Store Custom Metadata](store-custom-metadata.md): Attach custom key-value metadata to design blocks in CE.SDK for tracking asset origins, storing application state, or... - [Save](save.md): Save and serialize designs in CE.SDK for later retrieval, sharing, or storage using string or archive formats. - [Export for Social Media](export-for-social-media.md): Export vertical video designs for social media platforms with the correct dimensions, formats, and quality settings. ... - [Pre-Export Validation](pre-export-validation.md): Validate your design before export by detecting elements outside the page, protruding content, obscured text, and oth... - [Export for Printing](export-for-printing.md): Export print-ready PDFs from CE.SDK with options for high compatibility mode, underlayers for special media like fabr... - [Export](export.md) - [Create Thumbnail](create-thumbnail.md): Generate thumbnail preview images from CE.SDK scenes by exporting with target dimensions for galleries and design man... - [Trim Video Clips](trim-video-clips.md): Control video playback timing by trimming clips to specific start points and durations using CE.SDK’s timeline UI and... - [Transform](transform.md) - [Split Video and Audio](split-video-and-audio.md): Split video and audio clips at specific time points using CE.SDK’s timeline UI and programmatic split API to create i... - [Redact Sensitive Content in Videos](redact-sensitive-content-in-videos.md): Redact sensitive video content using blur, pixelization, or solid overlays for privacy protection. - [Join and Arrange Video Clips](join-and-arrange-video-clips.md): Combine multiple video clips into sequences and organize them on the timeline using CE.SDK’s track system and program... - [Add Captions](add-captions.md): Add synchronized captions to video projects using CE.SDK’s caption system, with support for importing subtitle files,... - [Add Watermark](add-watermark.md): Add text and image watermarks to video content for copyright protection, branding, and content attribution using CE.S... - [Vectorize](vectorize.md): Convert raster images into scalable vector graphics that resize without quality loss using CE.SDK’s vectorizer plugin. - [Transform](transform-2.md) - [Replace Colors](replace-colors.md): Transform images by swapping specific colors using the Recolor effect or remove backgrounds with the Green Screen eff... - [Remove Background](remove-background.md): Remove image backgrounds to isolate subjects for compositing, product photography, or creating transparent overlays. - [Image Editor SDK](image-editor-sdk.md): The CreativeEditor SDK (CE.SDK) offers powerful image editing capabilities designed for seamless integration into you... - [Add Watermark](add-watermark-2.md): Add text and image watermarks to designs programmatically using CE.SDK’s block API. - [Update Caption Presets](update-caption-presets.md): Extend CE.SDK’s video caption feature with custom caption presets by updating the content.json file. Caption presets ... - [Video and Audio Timeline Web Editor](video-and-audio-timeline-web-editor.md): The CreativeEditor SDK (CE.SDK) offers features for editing the video timeline, the horizontal layout where you arran... - [Create Videos Overview](create-videos-overview.md): In addition to static designs, CE.SDK also allows you to create and edit videos. Working with videos introduces the c... - [Video Limitations](video-limitations.md): CE.SDK performs video processing client-side, providing privacy and responsiveness while introducing hardware-depende... - [Control Audio and Video](control-audio-and-video.md): Play, pause, seek, and preview audio and video content programmatically using CE.SDK’s playback control APIs. - [Overview](overview-9.md): In CE.SDK, a _template_ is a reusable, structured design that defines editable areas and constraints for end users. T... - [Lock the Template](lock-the-template.md): Set up a two-surface integration where template creators have full editing access while template adopters can only mo... - [Import Templates](import-templates.md): Load design templates into CE.SDK from archive URLs, scene URLs, and serialized strings. - [Create From Scratch](create-from-scratch.md): Build reusable design templates entirely through code using CE.SDK’s programmatic APIs for automation, batch generati... - [Edit or Remove Templates](edit-or-remove-templates.md): Modify existing templates and manage template lifecycle in your asset library using CE.SDK. - [Add to Template Library](add-to-template-library.md): Create a template library where users can browse, preview, and apply templates from a custom asset source. - [Dynamic Content](dynamic-content.md): Dynamic content transforms static designs into flexible, data-driven templates. CE.SDK provides three complementary c... - [Programmatic Creation](programmatic-creation.md): Build compositions entirely through code using CE.SDK’s APIs for automation, batch processing, and custom interfaces. - [Overview](overview-10.md): In CreativeEditor SDK (CE.SDK), a _composition_ is an arrangement of multiple design elements—such as images, text, s... - [Multi-Page Layouts](multi-page-layouts.md): Create multi-page designs in CE.SDK for brochures, presentations, catalogs, and other documents requiring multiple pa... - [Lock Design](lock-design.md): Protect design elements from unwanted modifications using CE.SDK’s scope-based permission system. - [Design a Layout](design-a-layout.md): Create structured compositions using stack layouts that automatically arrange pages vertically or horizontally with c... - [Layer Management](layer-management.md): Organize design elements in CE.SDK using a hierarchical layer stack to control stacking order, visibility, and elemen... - [Group and Ungroup Objects](group-and-ungroup-objects.md): Group multiple blocks to move, scale, and transform them as a single unit; ungroup to edit them individually. - [Create a Collage](create-a-collage.md): This guide shows you how to add a **Collage** feature in your web app with the help of the CE.SDK. A collage allows y... - [Blend Modes](blend-modes.md): Control how design blocks visually blend with underlying layers using CE.SDK’s blend mode system for professional lay... - [Add a Background](add-a-background.md): Add backgrounds to designs using fills for pages and shapes, and the background color property for text blocks. - [Audio](audio.md): The **CreativeEditor (CE.SDK)** provides different **audio features** you can leverage in web-based apps. This sectio... - [To PNG](to-png.md): Export designs to PNG format with lossless quality and optional transparency support. - [To PDF](to-pdf.md): The CE.SDK allows you to convert JPEG, PNG, WebP, BMP and SVG images into PDFs directly in the browser—no server-side... - [To Base64](to-base64.md): Convert CE.SDK exports to Base64-encoded strings for embedding in HTML, storing in databases, or transmitting via JSO... - [Overview](overview-11.md): CreativeEditor SDK (CE.SDK) allows you to export designs into a variety of formats, making it easy to prepare assets ... - [Undo and History](undo-and-history.md): Implement undo/redo functionality and manage multiple history stacks to track editing operations. - [Terminology](terminology.md): A reference guide to the core terms and concepts used throughout CE.SDK documentation. - [Scenes](scenes.md): Scenes are the root container for all designs in CE.SDK. They hold pages, blocks, and the camera that controls what y... - [Templating](templating.md): Templates transform static designs into dynamic, data-driven content. They combine reusable layouts with variable tex... - [Resources](resources.md): Manage external media files—images, videos, audio, and fonts—that blocks reference via URIs in CE.SDK. - [Pages](pages.md): Pages define the format of your designs—every graphic block, text element, and media file lives inside a page. This g... - [Events](events.md): Monitor and react to block changes in real time by subscribing to creation, update, and destruction events in your CE... - [Editing Workflow](editing-workflow.md): CE.SDK controls editing access through roles and scopes, enabling template workflows where designers create locked la... - [Editor State](editor-state.md): Editor state determines how users interact with content on the canvas by controlling which editing mode is active and... - [Design Units](design-units.md): Control measurement systems for precise physical dimensions—create print-ready documents with millimeter or inch unit... - [Buffers](buffers.md): Store and manage temporary binary data directly in memory using CE.SDK’s buffer API for dynamically generated content. - [Blocks](blocks.md): Work with blocks—the fundamental building units for all visual elements in CE.SDK designs. - [Assets](assets.md): Understand the asset system—how external media and resources like images, stickers, or videos are handled in CE.SDK. - [Architecture](architecture.md): Understand how CE.SDK is structured around the CreativeEngine and its six interconnected APIs. - [Replace Individual Colors](replace-individual-colors.md): Selectively replace specific colors in images using CE.SDK’s Recolor and Green Screen effects. - [Overview](overview-12.md): Colors are a fundamental part of design in the CreativeEditor SDK (CE.SDK). Whether you’re designing for digital scre... - [For Screen](for-screen.md) - [For Print](for-print.md) - [Create a Color Palette](create-a-color-palette.md): Build custom color palettes that appear in the CE.SDK color picker using sRGB, CMYK, and Spot colors. - [Color Conversion](color-conversion.md): Convert colors between sRGB, CMYK, and spot color spaces programmatically in CE.SDK. - [Color Basics](color-basics.md): Understand the three color spaces in CE.SDK and when to use each for screen or print workflows. - [Apply Colors](apply-colors.md): Apply solid colors to design elements like shapes, text, and backgrounds using CE.SDK’s color system with support for... - [Adjust Colors](adjust-colors.md): Fine-tune images and design elements using CE.SDK’s color adjustments system to control brightness, contrast, saturat... - [Overview](overview-13.md): Workflow automation with CreativeEditor SDK (CE.SDK) enables you to programmatically generate, manipulate, and export... - [Automate Design Generation](automate-design-generation.md): Automating design generation simplifies workflows and allows you to create dynamic, personalized designs at scale. By... - [Data Merge](data-merge-2.md): Generate personalized designs from a single template by merging external data into CE.SDK templates using text variab... - [Batch Processing](batch-processing.md): This guide shows you how to use CE.SDK to create and manage batch processing workflows in the browser. Batch processi... - [Auto-Resize](auto-resize.md): Configure blocks to dynamically adjust their dimensions using three sizing modes: Absolute for fixed values, Percent ... - [API Reference](api-reference.md): For Vue, the following packages are available: - [Package: documentation](package-documentation.md): | Class | Description | - [Package: documentation](package-documentation-2.md): | Class | Description | - [Supported Animation Types](supported-animation-types.md): Apply entrance, exit, and loop animations to design blocks using the available animation types in CE.SDK. - [Overview](overview-14.md): Animations in CreativeEditor SDK (CE.SDK) bring your designs to life by adding motion to images, text, and design ele... - [Edit Animations](edit-animations.md): Modify existing animations by reading properties, changing duration and easing, and replacing or removing animations ... - [Create Animations](create-animations.md): Add motion to design elements by creating entrance, exit, and loop animations using CE.SDK’s animation system. - [Register a New Component](register-a-new-component.md): Register custom UI components using CE.SDK’s builder system and place them in different areas of the editor interface... - [Quick Actions](quick-actions.md): Extend CE.SDK with one-click editing actions using official plugins for background removal, vectorization, QR codes, ... - [Notifications and Dialogs](notifications-and-dialogs.md): Display notifications and dialogs to communicate with users during the editing experience using CE.SDK’s UI API. - [Customize UI Behavior](customize-ui-behavior.md): Control CE.SDK’s interface programmatically at runtime through event subscriptions, panel operations, notifications, ... - [Create a Custom Panel](create-a-custom-panel.md): Create custom sidebar panels that integrate with CE.SDK’s user interface using the builder system and built-in compon... - [Add a New Button](add-a-new-button.md): Add custom buttons to the CE.SDK editor to trigger actions, control panels, or implement custom workflows. - [Asset Library](asset-library-2.md): Extend the asset library by adding custom asset sources, enabling user uploads, and organizing content with groups an... - [Add a Custom Feature](add-a-custom-feature.md): Bundle custom functionality into reusable plugins for CE.SDK. - [Save and Export Buttons](save-and-export-buttons.md): This guide shows you how to add, customize, and configure save and export buttons in the CE.SDK navigation bar. You’l... - [Rearrange Buttons](rearrange-buttons.md): Control the layout of CE.SDK’s UI areas by rearranging, inserting, and removing components using the Ordering APIs. Y... - [Panel Customization](panel-customization.md): This guide shows you how to control CE.SDK’s UI panels programmatically, allowing you to show, hide, position, and co... - [Page Format](page-format.md): CE.SDK includes a built-in page format selector in the resize panel that lets users choose from predefined page sizes... - [Navigation Bar](navigation-bar.md): This guide explains how to customize the navigation bar in CE.SDK. The navigation bar is the horizontal toolbar at th... - [Inspector Bar](inspector-bar.md): This guide shows you how to customize the inspector bar in CE.SDK, the contextual toolbar that appears above the canv... - [Hide Elements](hide-elements.md): CE.SDK provides flexible APIs to control the visibility of every UI element. You can hide elements using the Feature ... - [Force Crop](force-crop.md): Programmatically apply crop presets to enforce specific aspect ratios or dimensions on design blocks using the`apply... - [Dock](dock.md): Customize the dock to control which asset libraries appear and how they are organized for your users. - [Disable or Enable Features](disable-or-enable-features.md): Control which editor features are available to users using the Feature API. - [Crop Presets](crop-presets.md): Customize crop presets to provide users with aspect ratio options tailored to your application’s needs. - [Color Palette](color-palette.md): CE.SDK’s color palette system allows you to replace the default colors with custom brand colors, ensuring consistent ... - [Canvas Menu](canvas-menu.md): Customize the canvas menu - the context menu that appears when clicking elements on the canvas - to create tailored e... - [Canvas Bar](canvas-bar.md): Customize the Canvas Bar to add, remove, or rearrange components for your specific workflow. - [Theming](theming.md): Customize the visual appearance of CE.SDK’s user interface through theming, allowing you to adapt colors, fonts, and ... - [Icons](icons.md): Customize the editor’s icons by registering custom SVG icon sets and using them in dock entries, custom components, a... - [Custom Labels](custom-labels.md): Customize UI text labels in CE.SDK to match your brand voice and product terminology without changing the entire inte... - [Change UI Font](change-ui-font.md): Customize the font family used throughout the CE.SDK editor interface to match your application’s branding. - [AI Video Generation](ai-video-generation.md): We add AI-powered video generation to CE.SDK applications for creating dynamic videos from text or animating static i... - [AI Text Generation](ai-text-generation.md): We add AI-powered text generation to CE.SDK applications for creating headlines, descriptions, captions, and marketin... - [Proxy Server](proxy-server.md): For security reasons, you should never include your AI service API keys directly in client-side code. Instead, you sh... - [Integrate AI Into CE.SDK](integrate-ai-into-cesdk.md): Add AI-powered generation capabilities to your CE.SDK application for generating images, videos, audio, and text usin... - [Initialize a new project or use an existing onenpm install @cesdk/cesdk-jsnpm install @imgly/plugin-ai-apps-web](initialize-a-new-project-or-use-an-existing-onenpm-install-cesdkcesdk-jsnpm-inst.md) - [Install individual AI generation packages as needednpm install @imgly/plugin-ai-image-generation-webnpm install @imgly/plugin-ai-video-generation-webnpm install @imgly/plugin-ai-audio-generation-webnpm install @imgly/plugin-ai-text-generation-web](install-individual-ai-generation-packages-as-needednpm-install-imglyplugin-ai-im.md): Import the providers from their respective packages: - [AI Image Generation](ai-image-generation.md): We add AI image generation to CE.SDK applications for creating visuals from text descriptions or transforming existin... - [Custom AI Provider](custom-ai-provider.md): Build a custom AI-powered image generation provider for CE.SDK using the`@imgly/plugin-ai-generation-web`package. Y... - [Create a new project or use an existing onemkdir my-image-providercd my-image-provider](create-a-new-project-or-use-an-existing-onemkdir-my-image-providercd-my-image-pr.md) - [Install required dependenciesnpm install @imgly/plugin-ai-generation-web @imgly/plugin-ai-image-generation-web @cesdk/cesdk-js typescript](install-required-dependenciesnpm-install-imglyplugin-ai-generation-web-imglyplug.md): Then import the packages in your TypeScript file: - [Audio Generation](audio-generation.md): Add AI-powered text-to-speech and sound effect generation directly into your CE.SDK application using the Audio Gener... - [Edit Shapes](edit-shapes.md): This guide shows how to programmatically edit shapes using the Block API, covering geometry modifications, fill chang... - [Create Shapes](create-shapes.md): Create and configure geometric shapes programmatically using the Engine API—rectangles, ellipses, stars, polygons, li... - [Create Stickers](create-stickers.md): Create stickers from images for use in your designs, perfect for adding icons, logos, emoji, and detailed multi-color... - [From Photoshop](from-photoshop.md): Import Adobe Photoshop (PSD) files into CE.SDK, converting them into editable scenes while preserving layers, text, s... - [From InDesign](from-indesign.md): Import Adobe InDesign (IDML) files into CE.SDK, converting them into editable scenes while preserving text, shapes, i... - [Import Design from Archive](import-design-from-archive.md): Load archived CE.SDK scenes that bundle design structure with all fonts, images, and assets in a single portable file. - [From Your Server](from-your-server.md): Learn how to load images, videos, and audio from your backend servers into CE.SDK for integration with CMS, DAM, or c... - [Integrate Unsplash Stock Images](integrate-unsplash-stock-images.md): Integrate Unsplash’s vast library of royalty-free stock images directly into CE.SDK, allowing users to search and add... - [Integrate Third-Party APIs](integrate-third-party-apis.md): CE.SDK makes it easy to integrate any third-party API using the custom asset source mechanism, allowing you to import... - [Integrate Soundstripe Audio Library](integrate-soundstripe-audio-library.md): Integrate Soundstripe’s vast library of royalty-free audio tracks directly into CE.SDK, enabling users to search and ... - [Import Remote Assets](import-remote-assets.md): Load asset definitions from remote JSON files hosted on CDNs or servers into CE.SDK’s asset library. - [Integrate Pexels Stock Images](integrate-pexels-stock-images.md): Connect CE.SDK to Pexels API to search and add royalty-free stock photos directly to your designs. - [Integrate Getty Images Stock Photos](integrate-getty-images-stock-photos.md): Integrate Getty Images’ premium stock photography library directly into CE.SDK, allowing users to search and add prof... - [Integrate IMG.LY Premium Assets](integrate-imgly-premium-assets.md): Host IMG.LY premium templates on your infrastructure and integrate them directly into CE.SDK’s asset library. - [Environment files.env.env.local.env.*.local](environment-filesenvenvlocalenvlocal.md): Load the base URL from environment variables with validation: - [Versioning of Assets](versioning-of-assets.md): Manage how CE.SDK stores and resolves asset URLs in saved designs, ensuring designs remain functional when assets are... - [From User Upload](from-user-upload.md): Enable users to upload images and videos from their devices directly into CE.SDK. - [Record Video](record-video.md): Display live camera feeds in CE.SDK scenes using`PixelStreamFill`and apply real-time effects to the video. - [Thumbnails](thumbnails.md): Learn how to configure thumbnail images for assets in CE.SDK’s asset library. - [Customize](customize.md): Adapt the asset library to match your application’s structure and user needs. - [Refresh Assets](refresh-assets.md): Learn how to refresh asset sources when external changes occur outside CE.SDK. - [Basics](basics.md): CE.SDK treats all insertable content as assets—images, videos, audio, stickers, shapes, templates, and text presets f... - [Export with a Color Mask](export-with-a-color-mask.md): Remove specific colors from exported images and generate alpha masks using CE.SDK’s color mask export API for print w... - [To WebP](to-webp.md): Export designs to WebP format for optimized web delivery with smaller file sizes than PNG or JPEG. - [Export to Raw Data](export-to-raw-data.md): Exporting designs to raw pixel data gives you direct access to uncompressed RGBA bytes, enabling custom image process... - [To PNG](to-png-2.md): Export your designs as PNG images with full transparency support and configurable compression. - [To PDF](to-pdf-2.md): Export your designs as PDF documents with high compatibility mode and underlayer support for special media printing. - [To MP4](to-mp4.md): Export your video compositions as MP4 files with H.264 encoding, progress tracking, and configurable quality settings. - [Size Limits](size-limits-2.md): Configure size limits to balance quality and performance in CE.SDK applications. - [Partial Export](partial-export.md): Export individual design elements, grouped blocks, or specific pages from your scene instead of exporting everything ... - [To JPEG](to-jpeg.md): Export CE.SDK designs to JPEG format—ideal for photographs, social media, and web content where file size matters mor... - [Options](options.md): Export your designs to multiple formats including PNG, JPEG, WebP, PDF, and MP4. CE.SDK handles all export processing... - [Compress](compress.md): Compression reduces file sizes during export while maintaining visual quality. With CE.SDK you can fine-tune compress... - [Scale Videos in Web Apps](scale-videos-in-web-apps.md): The CreativeEditor provides a scaling feature to edit videos in your web app, to render an intended composition. Expl... - [Resize](resize.md): The **CreativeEditor SDK (CE.SDK)** provides a video resizing feature. This guide offers a complete overview of the r... - [Move Videos](move-videos.md): Position videos on the canvas using absolute pixel coordinates or percentage-based positioning for responsive layouts. - [Flip](flip.md): Use **CE.SDK** to **mirror video clips** horizontally or vertically in your web app. Flip videos to create mirror eff... - [Rotate Videos](rotate-videos.md): Rotate video elements to any angle using radians or degrees, with precise programmatic control and UI rotation handles. - [Crop Videos](crop-videos.md): Crop videos to focus on specific areas, remove unwanted edges, or prepare clips for fixed formats like 9:16 stories u... - [Scale Images](scale-images.md): Scale images proportionally with`engine.block.scale()`using configurable anchor points, or stretch individual axes ... - [Rotate Images](rotate-images.md): Rotate images to adjust orientation, correct crooked photos, or create creative effects using CE.SDK’s rotation APIs. - [Move Images](move-images.md): Position images on the canvas using absolute pixel coordinates or percentage-based positioning for responsive layouts. - [Crop](crop.md): Crop images to focus on key subjects, remove unwanted elements, or prepare visuals for specific formats like social m... - [Resize](resize-2.md): Change image dimensions using absolute pixel values, percentage-based sizing for responsive layouts, or auto-sizing b... - [Adjust Audio Volume](adjust-audio-volume.md): Control audio playback volume using CE.SDK’s timeline UI and the programmatic volume control API, from silent (0.0) t... - [Adjust Audio Playback Speed](adjust-audio-playback-speed.md): Control audio playback speed by adjusting the speed multiplier using CE.SDK’s timeline UI and programmatic speed adju... - [Import Templates from Scene Files](import-templates-from-scene-files.md): CE.SDK lets you load complete design templates from scene files to start projects from pre-designed templates, implem... - [Text Variables](text-variables.md): Text variables enable data-driven template personalization in CE.SDK. Insert placeholder tokens like`{{firstName}}`... - [Set Editing Constraints](set-editing-constraints.md): Control what users can edit in templates by setting fine-grained permissions on individual blocks or globally across ... - [Placeholders](placeholders.md): Placeholders turn design blocks into drop-zones that users can swap content into while maintaining full control over ... - [Loop Audio](loop-audio.md): Create seamless repeating audio playback for background music, sound effects, and rhythmic elements using CE.SDK’s au... - [Add Sound Effects](add-sound-effects.md): Generate sound effects programmatically using buffers with arbitrary audio data. Create notification chimes, alert to... - [Add Music](add-music.md): Add background music and audio tracks to video projects using CE.SDK’s audio block system for rich multimedia experie... - [Headless](headless.md): CreativeEditor SDK (CE.SDK) **Headless Mode** allows your web app to control the Engine API without loading the built... - [P3 Colors](p3-colors.md): Understand the P3 wide color gamut and its availability across CE.SDK platforms. - [sRGB Colors](srgb-colors.md): Apply sRGB colors to design elements for screen-based output using RGBA color values with red, green, blue, and alpha... - [Spot Colors](spot-colors.md): Define and manage spot colors programmatically for professional print workflows with exact color matching through pre... - [CMYK Colors](cmyk-colors.md): Work with CMYK colors in CE.SDK for professional print production workflows with support for color space conversion a... - [Text Animations](text-animations.md): Create engaging text animations that reveal content line by line, word by word, or character by character with granul... - [Base Animations](base-animations.md): Add motion to design blocks with entrance, exit, and loop animations using CE.SDK’s animation system. - [For Audio Processing](for-audio-processing.md): Export audio from pages, video blocks, audio blocks, and tracks to WAV or MP4 format for external processing, transcr... - [Variable: TouchRotateActionValues](variable-touchrotateactionvalues.md): const TouchRotateActionValues: readonly ["None", "Rotate"]; - [Variable: WidthModeValues](variable-widthmodevalues.md): const WidthModeValues: readonly ["Absolute", "Percent", "Auto"]; - [Variable: TextVerticalAlignmentValues](variable-textverticalalignmentvalues.md): const TextVerticalAlignmentValues: readonly ["Top", "Bottom", "Center"]; - [Variable: TouchPinchActionValues](variable-touchpinchactionvalues.md): const TouchPinchActionValues: readonly ["None", "Zoom", "Scale"]; - [Variable: TextHorizontalAlignmentValues](variable-texthorizontalalignmentvalues.md): const TextHorizontalAlignmentValues: readonly ["Left", "Right", "Center"]; - [Variable: TextAnimationWritingStyleValues](variable-textanimationwritingstylevalues.md): const TextAnimationWritingStyleValues: readonly ["Block", "Line", "Character", "Word"]; - [Variable: StrokeStyleValues](variable-strokestylevalues.md): const StrokeStyleValues: readonly ["Dashed", "DashedRound", "Dotted", "LongDashed", "LongDashedRound", "Solid"]; - [Variable: StrokePositionValues](variable-strokepositionvalues.md): const StrokePositionValues: readonly ["Center", "Inner", "Outer"]; - [Variable: StrokeCornerGeometryValues](variable-strokecornergeometryvalues.md): const StrokeCornerGeometryValues: readonly ["Bevel", "Miter", "Round"]; - [Variable: SceneModeValues](variable-scenemodevalues.md): const SceneModeValues: readonly ["Design", "Video"]; - [Variable: SHAPE\_TYPES](variable-shape-types.md): const SHAPE_TYPES: readonly ["rect", "line", "ellipse", "polygon", "star", "vector_path"]; - [Variable: SceneLayoutValues](variable-scenelayoutvalues.md): const SceneLayoutValues: readonly ["Free", "VerticalStack", "HorizontalStack", "DepthStack"]; - [Variable: SceneDesignUnitValues](variable-scenedesignunitvalues.md): const SceneDesignUnitValues: readonly ["Pixel", "Millimeter", "Inch"]; - [Variable: PositionYModeValues](variable-positionymodevalues.md): const PositionYModeValues: readonly ["Absolute", "Percent", "Auto"]; - [Variable: PositionXModeValues](variable-positionxmodevalues.md): const PositionXModeValues: readonly ["Absolute", "Percent", "Auto"]; - [Variable: MimeType](variable-mimetype.md): const MimeType: object; - [Variable: LogLevel](variable-loglevel.md): LogLevel: object; - [Variable: HeightModeValues](variable-heightmodevalues.md): const HeightModeValues: readonly ["Absolute", "Percent", "Auto"]; - [Variable: FillPixelStreamOrientationValues](variable-fillpixelstreamorientationvalues.md): const FillPixelStreamOrientationValues: readonly ["Up", "Down", "Left", "Right", "UpMirrored", "DownMirrored", "LeftM... - [Variable: FILL\_TYPES](variable-fill-types.md): const FILL_TYPES: readonly ["color", "gradient/linear", "gradient/radial", "gradient/conical", "image", "video", "pix... - [Variable: EFFECT\_TYPES](variable-effect-types.md): const EFFECT_TYPES: readonly ["adjustments", "cross_cut", "dot_pattern", "duotone_filter", "extrude_blur", "glow", "g... - [Variable: DoubleClickSelectionModeValues](variable-doubleclickselectionmodevalues.md): const DoubleClickSelectionModeValues: readonly ["Direct", "Hierarchical"]; - [Variable: CutoutTypeValues](variable-cutouttypevalues.md): const CutoutTypeValues: readonly ["Solid", "Dashed"]; - [Variable: DESIGN\_BLOCK\_TYPES](variable-design-block-types.md): const DESIGN_BLOCK_TYPES: readonly ["scene", "stack", "camera", "page", "graphic", "audio", "text", "group", "cutout"... - [Variable: CaptionVerticalAlignmentValues](variable-captionverticalalignmentvalues.md): const CaptionVerticalAlignmentValues: readonly ["Top", "Bottom", "Center"]; - [Variable: ContentFillModeValues](variable-contentfillmodevalues.md): const ContentFillModeValues: readonly ["Crop", "Cover", "Contain"]; - [Variable: CameraClampingOvershootModeValues](variable-cameraclampingovershootmodevalues.md): const CameraClampingOvershootModeValues: readonly ["Center", "Reverse"]; - [Variable: CaptionHorizontalAlignmentValues](variable-captionhorizontalalignmentvalues.md): const CaptionHorizontalAlignmentValues: readonly ["Left", "Right", "Center"]; - [Variable: BlendModeValues](variable-blendmodevalues.md): const BlendModeValues: readonly ["PassThrough", "Normal", "Darken", "Multiply", "ColorBurn", "LinearBurn", "DarkenCol... - [Variable: BLUR\_TYPES](variable-blur-types.md): const BLUR_TYPES: readonly ["uniform", "linear", "mirrored", "radial"]; - [Variable: AnimationWipeDirectionValues](variable-animationwipedirectionvalues.md): const AnimationWipeDirectionValues: readonly ["Up", "Right", "Down", "Left"]; - [Variable: AnimationTypewriterTextWritingStyleValues](variable-animationtypewritertextwritingstylevalues.md): const AnimationTypewriterTextWritingStyleValues: readonly ["Character", "Word"]; - [Variable: AnimationSpinLoopDirectionValues](variable-animationspinloopdirectionvalues.md): const AnimationSpinLoopDirectionValues: readonly ["Clockwise", "CounterClockwise"]; - [Variable: AnimationSpinDirectionValues](variable-animationspindirectionvalues.md): const AnimationSpinDirectionValues: readonly ["Clockwise", "CounterClockwise"]; - [Variable: AnimationMergeTextDirectionValues](variable-animationmergetextdirectionvalues.md): const AnimationMergeTextDirectionValues: readonly ["Right", "Left"]; - [Variable: AnimationKenBurnsDirectionValues](variable-animationkenburnsdirectionvalues.md): const AnimationKenBurnsDirectionValues: readonly ["Up", "Right", "Down", "Left"]; - [Variable: AnimationJumpLoopDirectionValues](variable-animationjumploopdirectionvalues.md): const AnimationJumpLoopDirectionValues: readonly ["Up", "Right", "Down", "Left"]; - [Variable: AnimationGrowDirectionValues](variable-animationgrowdirectionvalues.md): const AnimationGrowDirectionValues: readonly ["Horizontal", "Vertical", "All"]; - [Variable: AnimationEasingValues](variable-animationeasingvalues.md): const AnimationEasingValues: readonly ["Linear", "EaseIn", "EaseOut", "EaseInOut", "EaseInQuart", "EaseOutQuart", "Ea... - [Variable: AnimationBlockSwipeTextDirectionValues](variable-animationblockswipetextdirectionvalues.md): const AnimationBlockSwipeTextDirectionValues: readonly ["Up", "Right", "Down", "Left"]; - [Variable: AnimationBaselineDirectionValues](variable-animationbaselinedirectionvalues.md): const AnimationBaselineDirectionValues: readonly ["Up", "Right", "Down", "Left"]; - [Variable: ANIMATION\_TYPES](variable-animation-types.md): const ANIMATION_TYPES: readonly ["slide", "pan", "fade", "blur", "grow", "zoom", "pop", "wipe", "baseline", "crop_zoo... - [Class: VariableAPI](class-variableapi.md): Manage text variables within design templates. - [Class: SceneAPI](class-sceneapi.md): Create, load, save, and manipulate scenes. - [Class: EventAPI](class-eventapi.md): Subscribe to block lifecycle events in the design engine. - [Class: EditorAPI](class-editorapi.md): Control the design editor’s behavior and settings. - [Class: CreativeEngine](class-creativeengine.md): The CreativeEngine is the core processing unit of CE.SDK and handles state management, rendering, input handling, and... - [Class: BlockAPI](class-blockapi.md): Create, manipulate, and query the building blocks of your design. - [Class: AssetAPI](class-assetapi.md): Manage asset sources and apply assets to scenes. - [Function: supportsWasm](function-supportswasm.md): function supportsWasm(): boolean; - [Function: supportsVideoExport](function-supportsvideoexport.md): function supportsVideoExport(): Promise; - [Function: supportsVideo](function-supportsvideo.md): function supportsVideo(): boolean; - [Function: supportsBrowser](function-supportsbrowser.md): function supportsBrowser(): boolean; - [Function: \_mergeSources](function-mergesources.md): function _mergeSources(...sources): (listener) => _Unsubscribe; - [Function: isSpotColor](function-isspotcolor.md): function isSpotColor(color): color is SpotColor; - [Function: \_makeSource](function-makesource.md): function _makeSource(): _Source; - [Function: isRGBAColor](function-isrgbacolor.md): function isRGBAColor(color): color is RGBAColor; - [Function: defaultLogger](function-defaultlogger.md): function defaultLogger(message, level?): void; - [Function: isCMYKColor](function-iscmykcolor.md): function isCMYKColor(color): color is CMYKColor; - [Function: \_createTrackedProperty](function-createtrackedproperty.md): function _createTrackedProperty( getter, setter, source,options?): _ReactiveProperty; - [Function: \_createReactiveProperty](function-createreactiveproperty.md): function _createReactiveProperty(initialValue, options?): _ReactiveProperty; - [Function: \_createDerivedProperty](function-createderivedproperty.md): function _createDerivedProperty( sources, derive,options?): _ReadonlyReactiveProperty; - [Function: \_combineProperties](function-combineproperties.md): function _combineProperties(properties, options?): _ReadonlyReactiveProperty; - [Function: checkVideoSupport](function-checkvideosupport.md): function checkVideoSupport(): void; - [Function: checkVideoExportSupport](function-checkvideoexportsupport.md): function checkVideoExportSupport(): Promise; - [Interface: Vec3](interface-vec3.md): | Property | Type | - [Interface: \_UBQSplitOptions](interface-ubqsplitoptions.md): Specifies options for configuring block split operations. - [Interface: Vec2](interface-vec2.md): | Property | Type | - [Interface: \_UBQExportOptions](interface-ubqexportoptions.md): Specifies options for exporting design blocks to various formats. - [Interface: \_UBQExportVideoOptions](interface-ubqexportvideooptions.md): Specifies options for exporting video design blocks to various formats. - [Interface: \_UBQExportAudioOptions](interface-ubqexportaudiooptions.md): Specifies options for exporting audio design blocks to various formats. - [Interface: \_UBQAudioFromVideoOptions](interface-ubqaudiofromvideooptions.md): Specifies options for configuring audio extraction from video operations. - [Interface: Typeface](interface-typeface.md): Represents a typeface. - [Interface: TransientResource](interface-transientresource.md): Represents a transient resource. - [Interface: TextFontSizeOptions](interface-textfontsizeoptions.md): Options for text font size operations with unit support. - [Interface: SpotColor](interface-spotcolor.md): Represents a spot color value. - [Interface: \_Source](interface-source.md): A source that can emit values to subscribed listeners - [Interface: Source](interface-source-2.md): A single source width an intrinsic width & height. - [Interface: Size2](interface-size2.md): | Property | Type | - [Interface: RGBColor](interface-rgbcolor.md): Represents an RGB color value. - [Interface: Settings](interface-settings.md): Map of all available settings with their types. This provides type-safe access to all editor settings. - [Interface: RGBAColor](interface-rgbacolor.md): Represents an RGBA color value. - [Interface: RefocusEvent](interface-refocusevent.md): Dispatched on the engine canvas right before the engine will refocus its text input after a blur. Call`preventDefaul... - [Interface: \_ReadonlyReactiveProperty](interface-readonlyreactiveproperty.md): A read-only reactive property with subscribe and value methods - [Interface: Reactor](interface-reactor.md): The reactor coordinates the update of registered _Reactions_. - [Interface: Reaction](interface-reaction.md): Reactions track read calls and provide a way to react if they change. - [Interface: \_ReactivePropertyOptions](interface-reactivepropertyoptions.md): Options for creating a reactive property - [Interface: \_ReactiveProperty](interface-reactiveproperty.md): A reactive property with subscribe, value, and update methods - [Interface: Range](interface-range.md): An open range. - [Interface: Logger](interface-logger.md): Represents a logger function. - [Interface: PageDuration](interface-pageduration.md): | Property | Type | - [Interface: HTMLCreativeEngineCanvasElement](interface-htmlcreativeenginecanvaselement.md): A wrapper around a plain canvas - [Interface: GradientColorStop](interface-gradientcolorstop.md): Represents a gradient color stop. - [Interface: \_Flip](interface-flip.md): Specifies the horizontal and vertical flip states of a design block. - [Interface: Font](interface-font.md): Represents a font. - [Interface: \_FindAssetsQuery](interface-findassetsquery.md): Represents a query for finding assets. - [Interface: EnginePlugin](interface-engineplugin.md): Represents an engine plugin. - [Interface: CursorEvent](interface-cursorevent.md): Dispatched on the engine canvas when the text input has been blurred. Call`preventDefault()`to disallow this and re... - [Interface: CompleteAssetResult](interface-completeassetresult.md): Asset results that are returned from the engine. - [Interface: Configuration](interface-configuration.md): Specifies the configuration for the Creative Editor SDK. - [Interface: CMYKColor](interface-cmykcolor.md): Represents a CMYK color value. - [Interface: Buffer](interface-buffer.md): Represents a buffer of data. - [Interface: BlockStateReady](interface-blockstateready.md): Represents a ready state for a design block. - [Interface: BlurEvent](interface-blurevent.md): Dispatched on the engine canvas when the text input has been blurred. Call`preventDefault()`to disallow this and re... - [Interface: BlockStatePending](interface-blockstatepending.md): Represents a pending state for a design block. - [Interface: BlockStateError](interface-blockstateerror.md): Represents an error state for a design block. - [Interface: BlockEvent](interface-blockevent.md): Represents an event related to a design block. - [Interface: AudioTrackInfo](interface-audiotrackinfo.md): Information about a single audio track from a video. This interface provides comprehensive metadata about audio track... - [Interface: AssetStringProperty](interface-assetstringproperty.md): Asset string property definition - [Interface: AssetsQueryResult](interface-assetsqueryresult.md): Return type of a`findAssets`query. - [Interface: AssetSpotColor](interface-assetspotcolor.md): Asset Color payload SpotColor representation - [Interface: AssetSource](interface-assetsource.md): A source of assets - [Interface: AssetRGBColor](interface-assetrgbcolor.md): Asset Color payload RGB representation - [Interface: \_AssetResultLicense](interface-assetresultlicense.md): Represents the license for an asset result. - [Interface: \_AssetResultCredits](interface-assetresultcredits.md): Represents the credits for an asset result. - [Interface: AssetResult](interface-assetresult.md): Single asset result of a query from the engine. - [Interface: AssetQueryData](interface-assetquerydata.md): Defines a request for querying assets - [Interface: AssetPayload](interface-assetpayload.md): Asset payload - [Interface: AssetNumberProperty](interface-assetnumberproperty.md): Asset number property definition - [Interface: AssetFreeAspectRatio](interface-assetfreeaspectratio.md): Asset transform preset payload free aspect ratio - [Interface: AssetFixedAspectRatio](interface-assetfixedaspectratio.md): Asset transform preset payload fixed aspect ratio - [Interface: AssetFixedSize](interface-assetfixedsize.md): Asset transform preset payload fixed size - [Interface: AssetEnumProperty](interface-assetenumproperty.md): Asset enum property definition - [Interface: AssetDefinition](interface-assetdefinition.md): Definition of an asset used if an asset is added to an asset source. - [Interface: AssetColorProperty](interface-assetcolorproperty.md): Asset color property definition - [Interface: AssetCMYKColor](interface-assetcmykcolor.md): Asset Color payload CMYK representation - [Interface: AssetBooleanProperty](interface-assetbooleanproperty.md): Asset boolean property definition - [Interface: Asset](interface-asset.md): Generic asset information - [Interface: ApplyAssetOptions](interface-applyassetoptions.md): Options for applying an asset to the scene. - [Interface: AddVideoOptions](interface-addvideooptions.md): Options for adding videos to the scene. - [Variable: MimeType](variable-mimetype-2.md): const MimeType: object; - [Variable: LogLevel](variable-loglevel-2.md): LogLevel: object; - [Type Alias: ZoomOptions](type-alias-zoomoptions.md): type ZoomOptions = object; - [Type Alias: ZoomAutoFitAxis](type-alias-zoomautofitaxis.md): type ZoomAutoFitAxis = "Horizontal" | "Vertical" | "Both"; - [Type Alias: XYWH](type-alias-xywh.md): type XYWH = [number, number, number, number]; - [Type Alias: WidthMode](type-alias-widthmode.md): type WidthMode = typeof WidthModeValues[number]; - [Type Alias: VideoExportOptions](type-alias-videoexportoptions.md): type VideoExportOptions = object; - [Type Alias: VideoMimeType](type-alias-videomimetype.md): type VideoMimeType = Extract; - [Type Alias: VerticalBlockAlignment](type-alias-verticalblockalignment.md): type VerticalBlockAlignment = TextVerticalAlignment; - [Type Alias: \_Unsubscribe](type-alias-unsubscribe.md): type _Unsubscribe = () => void; - [Type Alias: TypefaceDefinition](type-alias-typefacedefinition.md): type TypefaceDefinition = object; - [Type Alias: TouchRotateAction](type-alias-touchrotateaction.md): type TouchRotateAction = typeof TouchRotateActionValues[number]; - [Type Alias: TouchPinchAction](type-alias-touchpinchaction.md): type TouchPinchAction = typeof TouchPinchActionValues[number]; - [Type Alias: TextVerticalAlignment](type-alias-textverticalalignment.md): type TextVerticalAlignment = typeof TextVerticalAlignmentValues[number]; - [Type Alias: TextCase](type-alias-textcase.md): type TextCase = "Normal" | "Uppercase" | "Lowercase" | "Titlecase"; - [Type Alias: TextAnimationWritingStyle](type-alias-textanimationwritingstyle.md): type TextAnimationWritingStyle = typeof TextAnimationWritingStyleValues[number]; - [Type Alias: \_Subscription](type-alias-subscription.md): type _Subscription = number; - [Type Alias: StrokeStyle](type-alias-strokestyle.md): type StrokeStyle = typeof StrokeStyleValues[number]; - [Type Alias: StrokePosition](type-alias-strokeposition.md): type StrokePosition = typeof StrokePositionValues[number]; - [Type Alias: StrokeCornerGeometry](type-alias-strokecornergeometry.md): type StrokeCornerGeometry = typeof StrokeCornerGeometryValues[number]; - [Type Alias: StringPropertyName](type-alias-stringpropertyname.md): type StringPropertyName = | "name" | "scene/pageFormatId" | "type" | "uuid" | "page/titleTemplate" | "audio/fil... - [Type Alias: SplitOptions](type-alias-splitoptions.md): type SplitOptions = object; - [Type Alias: SourceSetPropertyName](type-alias-sourcesetpropertyname.md): type SourceSetPropertyName = "fill/image/sourceSet" | string & object; - [Type Alias: SortingOrder](type-alias-sortingorder.md): type SortingOrder = "None" | "Ascending" | "Descending"; - [Type Alias: SizeMode](type-alias-sizemode.md): type SizeMode = | WidthMode | HeightMode; - [Type Alias: ShapeTypeShorthand](type-alias-shapetypeshorthand.md): type ShapeTypeShorthand = typeof SHAPE_TYPES[number]; - [Type Alias: ShapeTypeLonghand](type-alias-shapetypelonghand.md): type ShapeTypeLonghand =`//ly.img.ubq/shape/${ShapeTypeShorthand}`; - [Type Alias: ShapeType](type-alias-shapetype.md): type ShapeType = | ShapeTypeShorthand | ShapeTypeLonghand; - [Type Alias: SettingValueType](type-alias-settingvaluetype.md): type SettingValueType = Settings[K]; - [Type Alias: SettingType](type-alias-settingtype.md): type SettingType = "Bool" | "Int" | "Float" | "String" | "Color" | "Enum"; - [Type Alias: SettingStringPropertyName](type-alias-settingstringpropertyname.md): type SettingStringPropertyName = | "basePath" | "defaultEmojiFontFileUri" | "defaultFontFileUri" | "upload/suppor... - [Type Alias: SettingsString](type-alias-settingsstring.md): type SettingsString = SettingStringPropertyName; - [Type Alias: SettingsInt](type-alias-settingsint.md): type SettingsInt = SettingIntPropertyName; - [Type Alias: SettingsFloat](type-alias-settingsfloat.md): type SettingsFloat = SettingFloatPropertyName; - [Type Alias: SettingsEnum](type-alias-settingsenum.md): type SettingsEnum = SettingEnumType; - [Type Alias: SettingsColorRGBA](type-alias-settingscolorrgba.md): type SettingsColorRGBA = SettingsColor; - [Type Alias: SettingsColor](type-alias-settingscolor.md): type SettingsColor = SettingColorPropertyName; - [Type Alias: SettingsBool](type-alias-settingsbool.md): type SettingsBool = SettingBoolPropertyName; - [Type Alias: SettingKey](type-alias-settingkey.md): type SettingKey = keyof Settings; - [Type Alias: SettingIntPropertyName](type-alias-settingintpropertyname.md): type SettingIntPropertyName = "maxImageSize" | string & object; - [Type Alias: SettingFloatPropertyName](type-alias-settingfloatpropertyname.md): type SettingFloatPropertyName = | "positionSnappingThreshold" | "rotationSnappingThreshold" | "controlGizmo/blockS... - [Type Alias: SettingEnumValues](type-alias-settingenumvalues.md): type SettingEnumValues = | TouchPinchAction | TouchRotateAction | CameraClampingOvershootMode | DoubleClickSelect... - [Type Alias: SettingEnumType](type-alias-settingenumtype.md): type SettingEnumType = object; - [Type Alias: SettingEnumPropertyName](type-alias-settingenumpropertyname.md): type SettingEnumPropertyName = | "touch/pinchAction" | "touch/rotateAction" | "camera/clamping/overshootMode" | "... - [Type Alias: SettingColorPropertyName](type-alias-settingcolorpropertyname.md): type SettingColorPropertyName = | "clearColor" | "handleFillColor" | "highlightColor" | "pageHighlightColor" | "... - [Type Alias: SettingBoolPropertyName](type-alias-settingboolpropertyname.md): type SettingBoolPropertyName = | "alwaysHighlightPlaceholders" | "doubleClickToCropEnabled" | "showBuildVersion" ... - [Type Alias: Scope](type-alias-scope.md): type Scope = | "text/edit" | "text/character" | "fill/change" | "fill/changeType" | "stroke/change" | "shape/ch... - [Type Alias: SceneMode](type-alias-scenemode.md): type SceneMode = typeof SceneModeValues[number]; - [Type Alias: SceneLayout](type-alias-scenelayout.md): type SceneLayout = typeof SceneLayoutValues[number]; - [Type Alias: RoleString](type-alias-rolestring.md): type RoleString = "Creator" | "Adopter" | "Viewer" | "Presenter"; - [Type Alias: RGBA](type-alias-rgba.md): type RGBA = [number, number, number, number]; - [Type Alias: PropertyType](type-alias-propertytype.md): type PropertyType = | "Bool" | "Int" | "Float" | "String" | "Color" | "Enum" | "Struct" | "Double" | "Source... - [Type Alias: PositionYMode](type-alias-positionymode.md): type PositionYMode = typeof PositionYModeValues[number]; - [Type Alias: PositionXMode](type-alias-positionxmode.md): type PositionXMode = typeof PositionXModeValues[number]; - [Type Alias: PositionMode](type-alias-positionmode.md): type PositionMode = | PositionXMode | PositionYMode; - [Type Alias: PaletteColor](type-alias-palettecolor.md): type PaletteColor = | HexColorString | RGBColor | RGBAColor | SpotColor; - [Type Alias: OptionalPrefix](type-alias-optionalprefix.md): type OptionalPrefix =`ubq://${T}`| T; - [Type Alias: OffscreenCanvas](type-alias-offscreencanvas.md): type OffscreenCanvas = object; - [Type Alias: ObjectTypeShorthand](type-alias-objecttypeshorthand.md): type ObjectTypeShorthand = | DesignBlockTypeShorthand |`shape/${ShapeTypeShorthand}`|`fill/${FillTypeShorthand}... - [Type Alias: ObjectTypeLonghand](type-alias-objecttypelonghand.md): type ObjectTypeLonghand = | DesignBlockTypeLonghand | ShapeTypeLonghand | FillTypeLonghand | EffectTypeLonghand ... - [Type Alias: ObjectType](type-alias-objecttype.md): type ObjectType = | ObjectTypeShorthand | ObjectTypeLonghand; - [Type Alias: MimeType](type-alias-mimetype.md): type MimeType = typeof MimeType[keyof typeof MimeType]; - [Type Alias: LogLevel](type-alias-loglevel.md): type LogLevel = "Info" | "Warning" | "Error"; - [Type Alias: Locale](type-alias-locale.md): type Locale = string; - [Type Alias: \_LegacySource](type-alias-legacysource.md): type _LegacySource = (handler) => () => void; - [Type Alias: \_Listener](type-alias-listener.md): type _Listener = (value) => void; - [Type Alias: IntPropertyName](type-alias-intpropertyname.md): type IntPropertyName = | "effect/lut_filter/horizontalTileCount" | "effect/lut_filter/verticalTileCount" | "effect... - [Type Alias: ImageMimeType](type-alias-imagemimetype.md): type ImageMimeType = Extract; - [Type Alias: HorizontalBlockAlignment](type-alias-horizontalblockalignment.md): type HorizontalBlockAlignment = HorizontalTextAlignment; - [Type Alias: HorizontalTextAlignment](type-alias-horizontaltextalignment.md): type HorizontalTextAlignment = typeof TextHorizontalAlignmentValues[number]; - [Type Alias: HexColorString](type-alias-hexcolorstring.md): type HexColorString = string; - [Type Alias: HistoryId](type-alias-historyid.md): type HistoryId = number; - [Type Alias: GradientstopRGBA](type-alias-gradientstoprgba.md): type GradientstopRGBA = [number, number, number, number, number]; - [Type Alias: HeightMode](type-alias-heightmode.md): type HeightMode = typeof HeightModeValues[number]; - [Type Alias: FontWeight](type-alias-fontweight.md): type FontWeight = | "thin" | "extraLight" | "light" | "normal" | "medium" | "semiBold" | "bold" | "extraBold"... - [Type Alias: FontStyle](type-alias-fontstyle.md): type FontStyle = "normal" | "italic"; - [Type Alias: FloatPropertyName](type-alias-floatpropertyname.md): type FloatPropertyName = | "globalBoundingBox/height" | "globalBoundingBox/width" | "globalBoundingBox/x" | "glob... - [Type Alias: FontSizeUnit](type-alias-fontsizeunit.md): type FontSizeUnit = | DesignUnit | "Point"; - [Type Alias: FillTypeShorthand](type-alias-filltypeshorthand.md): type FillTypeShorthand = typeof FILL_TYPES[number]; - [Type Alias: FillTypeLonghand](type-alias-filltypelonghand.md): type FillTypeLonghand =`//ly.img.ubq/fill/${FillTypeShorthand}`; - [Type Alias: FillType](type-alias-filltype.md): type FillType = | FillTypeShorthand | FillTypeLonghand; - [Type Alias: FillPixelStreamOrientation](type-alias-fillpixelstreamorientation.md): type FillPixelStreamOrientation = typeof FillPixelStreamOrientationValues[number]; - [Type Alias: ExportOptions](type-alias-exportoptions.md): type ExportOptions = object; - [Type Alias: \_EqualsFn](type-alias-equalsfn.md): type _EqualsFn = (a, b) => boolean; - [Type Alias: EnumValues](type-alias-enumvalues.md): type EnumValues = | BlendMode | ContentFillMode | HeightMode | PositionXMode | PositionYMode | DesignUnit | Sc... - [Type Alias: EnumPropertyName](type-alias-enumpropertyname.md): type EnumPropertyName = | "blend/mode" | "contentFill/mode" | "height/mode" | "position/x/mode" | "position/y/mo... - [Type Alias: EnginePluginContext](type-alias-engineplugincontext.md): type EnginePluginContext = object; - [Type Alias: EffectTypeShorthand](type-alias-effecttypeshorthand.md): type EffectTypeShorthand = typeof EFFECT_TYPES[number]; - [Type Alias: EffectTypeLonghand](type-alias-effecttypelonghand.md): type EffectTypeLonghand =`//ly.img.ubq/effect/${EffectTypeShorthand}`; - [Type Alias: EffectType](type-alias-effecttype.md): type EffectType = | EffectTypeShorthand | EffectTypeLonghand; - [Type Alias: EditMode](type-alias-editmode.md): type EditMode = "Transform" | "Crop" | "Text" | "Playback" | "Trim" | string & object; - [Type Alias: DropShadowOptions](type-alias-dropshadowoptions.md): type DropShadowOptions = object; - [Type Alias: DoublePropertyName](type-alias-doublepropertyname.md): type DoublePropertyName = | "playback/time" | "playback/duration" | "playback/timeOffset" | "audio/totalDuration"... - [Type Alias: DoubleClickSelectionMode](type-alias-doubleclickselectionmode.md): type DoubleClickSelectionMode = typeof DoubleClickSelectionModeValues[number]; - [Type Alias: DesignUnit](type-alias-designunit.md): type DesignUnit = typeof SceneDesignUnitValues[number]; - [Type Alias: DesignBlockTypeShorthand](type-alias-designblocktypeshorthand.md): type DesignBlockTypeShorthand = typeof DESIGN_BLOCK_TYPES[number]; - [Type Alias: DesignBlockTypeLonghand](type-alias-designblocktypelonghand.md): type DesignBlockTypeLonghand =`//ly.img.ubq/${DesignBlockTypeShorthand}`; - [Type Alias: DesignBlockType](type-alias-designblocktype.md): type DesignBlockType = | DesignBlockTypeShorthand | DesignBlockTypeLonghand; - [Type Alias: DesignBlockId](type-alias-designblockid.md): type DesignBlockId = number; - [Type Alias: DemoAssetSourceId](type-alias-demoassetsourceid.md): type DemoAssetSourceId = | "ly.img.template" | "ly.img.image.upload" | "ly.img.video.upload" | "ly.img.audio.uplo... - [Type Alias: DefaultAssetSourceId](type-alias-defaultassetsourceid.md): type DefaultAssetSourceId = | "ly.img.sticker" | "ly.img.vectorpath" | "ly.img.colors.defaultPalette" | "ly.img.f... - [Type Alias: CutoutType](type-alias-cutouttype.md): type CutoutType = typeof CutoutTypeValues[number]; - [Type Alias: CutoutOperation](type-alias-cutoutoperation.md): type CutoutOperation = "Difference" | "Intersection" | "Union" | "XOR"; - [Type Alias: CreateSceneOptions](type-alias-createsceneoptions.md): type CreateSceneOptions = object; - [Type Alias: ContentFillMode](type-alias-contentfillmode.md): type ContentFillMode = typeof ContentFillModeValues[number]; - [Type Alias: ColorSpace](type-alias-colorspace.md): type ColorSpace = "sRGB" | "CMYK" | "SpotColor"; - [Type Alias: ColorPropertyName](type-alias-colorpropertyname.md): type ColorPropertyName = | "dropShadow/color" | "fill/solid/color" | "stroke/color" | "backgroundColor/color" | ... - [Type Alias: Color](type-alias-color.md): type Color = | RGBAColor | CMYKColor | SpotColor; - [Type Alias: CMYK](type-alias-cmyk.md): type CMYK = [number, number, number, number]; - [Type Alias: CaptionVerticalAlignment](type-alias-captionverticalalignment.md): type CaptionVerticalAlignment = typeof CaptionVerticalAlignmentValues[number]; - [Type Alias: CaptionHorizontalAlignment](type-alias-captionhorizontalalignment.md): type CaptionHorizontalAlignment = typeof CaptionHorizontalAlignmentValues[number]; - [Type Alias: Canvas](type-alias-canvas.md): type Canvas = | HTMLCanvasElement | OffscreenCanvas; - [Type Alias: CameraClampingOvershootMode](type-alias-cameraclampingovershootmode.md): type CameraClampingOvershootMode = typeof CameraClampingOvershootModeValues[number]; - [Type Alias: BoolPropertyName](type-alias-boolpropertyname.md): type BoolPropertyName = | "alwaysOnBottom" | "alwaysOnTop" | "clipped" | "flip/horizontal" | "flip/vertical" | ... - [Type Alias: BooleanOperation](type-alias-booleanoperation.md): type BooleanOperation = "Difference" | "Intersection" | "Union" | "XOR"; - [Type Alias: BlurTypeShorthand](type-alias-blurtypeshorthand.md): type BlurTypeShorthand = typeof BLUR_TYPES[number]; - [Type Alias: BlurTypeLonghand](type-alias-blurtypelonghand.md): type BlurTypeLonghand =`//ly.img.ubq/blur/${BlurTypeShorthand}`; - [Type Alias: BlurType](type-alias-blurtype.md): type BlurType = | BlurTypeShorthand | BlurTypeLonghand; - [Type Alias: BlockState](type-alias-blockstate.md): type BlockState = | BlockStateError | BlockStatePending | BlockStateReady; - [Type Alias: BlockEnumType](type-alias-blockenumtype.md): type BlockEnumType = object; - [Type Alias: BlendMode](type-alias-blendmode.md): type BlendMode = typeof BlendModeValues[number]; - [Type Alias: AudioMimeType](type-alias-audiomimetype.md): type AudioMimeType = Extract; - [Type Alias: AudioFromVideoOptions](type-alias-audiofromvideooptions.md): type AudioFromVideoOptions = object; - [Type Alias: AudioExportOptions](type-alias-audioexportoptions.md): type AudioExportOptions = object; - [Type Alias: AssetTransformPreset](type-alias-assettransformpreset.md): type AssetTransformPreset = | AssetFixedAspectRatio | AssetFreeAspectRatio | AssetFixedSize; - [Type Alias: AssetProperty](type-alias-assetproperty.md): type AssetProperty = | AssetBooleanProperty | AssetColorProperty | AssetEnumProperty | AssetNumberProperty | Ass... - [Type Alias: AssetMetaData](type-alias-assetmetadata.md): type AssetMetaData = object & Record; - [Type Alias: AssetGroups](type-alias-assetgroups.md): type AssetGroups = string[]; - [Type Alias: AssetColor](type-alias-assetcolor.md): type AssetColor = | AssetRGBColor | AssetCMYKColor | AssetSpotColor; - [Type Alias: ApplicationMimeType](type-alias-applicationmimetype.md): type ApplicationMimeType = Extract; - [Type Alias: AnimationTypewriterTextWritingStyle](type-alias-animationtypewritertextwritingstyle.md): type AnimationTypewriterTextWritingStyle = typeof AnimationTypewriterTextWritingStyleValues[number]; - [Type Alias: AnimationWipeDirection](type-alias-animationwipedirection.md): type AnimationWipeDirection = typeof AnimationWipeDirectionValues[number]; - [Type Alias: AnimationTypeShorthand](type-alias-animationtypeshorthand.md): type AnimationTypeShorthand = typeof ANIMATION_TYPES[number]; - [Type Alias: AnimationTypeLonghand](type-alias-animationtypelonghand.md): type AnimationTypeLonghand =`//ly.img.ubq/animation/${AnimationTypeShorthand}`; - [Type Alias: AnimationType](type-alias-animationtype.md): type AnimationType = | AnimationTypeShorthand | AnimationTypeLonghand; - [Type Alias: AnimationSpinLoopDirection](type-alias-animationspinloopdirection.md): type AnimationSpinLoopDirection = typeof AnimationSpinLoopDirectionValues[number]; - [Type Alias: AnimationSpinDirection](type-alias-animationspindirection.md): type AnimationSpinDirection = typeof AnimationSpinDirectionValues[number]; - [Type Alias: AnimationMergeTextDirection](type-alias-animationmergetextdirection.md): type AnimationMergeTextDirection = typeof AnimationMergeTextDirectionValues[number]; - [Type Alias: AnimationOptions](type-alias-animationoptions.md): type AnimationOptions = object; - [Type Alias: AnimationKenBurnsDirection](type-alias-animationkenburnsdirection.md): type AnimationKenBurnsDirection = typeof AnimationKenBurnsDirectionValues[number]; - [Type Alias: AnimationJumpLoopDirection](type-alias-animationjumploopdirection.md): type AnimationJumpLoopDirection = typeof AnimationJumpLoopDirectionValues[number]; - [Type Alias: AnimationGrowDirection](type-alias-animationgrowdirection.md): type AnimationGrowDirection = typeof AnimationGrowDirectionValues[number]; - [Type Alias: AnimationEntry](type-alias-animationentry.md): type AnimationEntry = object; - [Type Alias: AnimationEasing](type-alias-animationeasing.md): type AnimationEasing = typeof AnimationEasingValues[number]; - [Type Alias: AnimationBlockSwipeTextDirection](type-alias-animationblockswipetextdirection.md): type AnimationBlockSwipeTextDirection = typeof AnimationBlockSwipeTextDirectionValues[number]; - [Type Alias: AddImageOptions](type-alias-addimageoptions.md): type AddImageOptions = object; - [Type Alias: AnimationBaselineDirection](type-alias-animationbaselinedirection.md): type AnimationBaselineDirection = typeof AnimationBaselineDirectionValues[number]; - [Function: supportsWasm](function-supportswasm-2.md): function supportsWasm(): boolean; - [Function: supportsVideoExport](function-supportsvideoexport-2.md): function supportsVideoExport(): Promise; - [Function: supportsVideo](function-supportsvideo-2.md): function supportsVideo(): boolean; - [Function: supportsBrowser](function-supportsbrowser-2.md): function supportsBrowser(): boolean; - [Function: checkVideoSupport](function-checkvideosupport-2.md): function checkVideoSupport(): void; - [Function: checkVideoExportSupport](function-checkvideoexportsupport-2.md): function checkVideoExportSupport(): Promise; - [Enum: PanelPosition](enum-panelposition.md): This enum is used to specify the position of various panels within the user interface, such as the inspector, setting... - [Class: VariableAPI](class-variableapi-2.md): Manage text variables within design templates. - [Class: UtilsAPI](class-utilsapi.md): UtilsAPI provides utility functions for common operations in the Creative Engine SDK. - [Class: UserInterfaceAPI](class-userinterfaceapi.md): Control the user interface and behavior of the Creative Editor SDK. - [Class: SceneAPI](class-sceneapi-2.md): Create, load, save, and manipulate scenes. - [Class: InternationalizationAPI](class-internationalizationapi.md): Manages localization and internationalization settings for the Creative Editor SDK. - [Class: FeatureAPI](class-featureapi.md): Controls the availability of features within the Creative Editor SDK. - [Class: EventAPI](class-eventapi-2.md): Subscribe to block lifecycle events in the design engine. - [Class: EditorAPI](class-editorapi-2.md): Control the design editor’s behavior and settings. - [Class: CreativeEngine](class-creativeengine-2.md): The CreativeEngine is the core processing unit of CE.SDK and handles state management, rendering, input handling, and... - [Class: CreativeEditorSDK](class-creativeeditorsdk.md): The main entry point for the Creative Editor SDK. - [Class: BlockAPI](class-blockapi-2.md): Create, manipulate, and query the building blocks of your design. - [Class: AssetAPI](class-assetapi-2.md): Manage asset sources and apply assets to scenes. - [Class: ActionsAPI](class-actionsapi.md): ActionsAPI provides a centralized way to manage and customize actions for various user interactions in the Creative E... - [Interface: Typeface](interface-typeface-2.md): Represents a typeface. - [Interface: UserInterface](interface-userinterface.md): Specifies the configuration for the user interface of the Creative Editor SDK. - [Interface: Translations](interface-translations.md): Complete translation type that includes both built-in and custom translations. - [Interface: TransientResource](interface-transientresource-2.md): Represents a transient resource. - [Interface: TextOptions](interface-textoptions.md): Represents options for text. - [Interface: TextInputOptions](interface-textinputoptions.md): Represents options for a text input. - [Interface: TextAreaOptions](interface-textareaoptions.md): Represents options for a text area. - [Interface: SpotColor](interface-spotcolor-2.md): Represents a spot color value. - [Interface: Source](interface-source-3.md): A single source width an intrinsic width & height. - [Interface: SliderOptions](interface-slideroptions.md): Represents options for a slider. - [Interface: SelectValue](interface-selectvalue.md): Represents a value for a select input. - [Interface: SelectOptions](interface-selectoptions.md): Represents options for a select input. - [Interface: SectionOptions](interface-sectionoptions.md): Represents options for a section. - [Interface: RGBColor](interface-rgbcolor-2.md): Represents an RGB color value. - [Interface: RGBAColor](interface-rgbacolor-2.md): Represents an RGBA color value. - [Interface: ReplaceAssetLibraryEntriesContext](interface-replaceassetlibraryentriescontext.md): Provides context for replacing asset library entries, including selected blocks and default entry IDs. - [Interface: RegisteredActions](interface-registeredactions.md): Represents a collection of action functions used throughout the application. Each property corresponds to a specific ... - [Interface: Range](interface-range-2.md): An open range. - [Interface: OrderContext](interface-ordercontext.md): Interface representing the context for ordering components. - [Interface: OrderComponentWithChildren](interface-ordercomponentwithchildren.md): Represents a custom dock component. - [Interface: OrderComponent](interface-ordercomponent.md): Represents an order component. - [Interface: NumberInputOptions](interface-numberinputoptions.md): Represents options for a number input. - [Interface: Notification](interface-notification.md): Represents a notification configuration. - [Interface: NavigationBarCustomActionButton](interface-navigationbarcustomactionbutton.md): Interface representing a generic Action Button in the navigation bar component. Note: This component requires a key a... - [Interface: NavigationBarActionButton](interface-navigationbaractionbutton.md): Base interface for action buttons in the navigation bar. Contains common properties shared across all action button t... - [Interface: MediaPreviewOptions](interface-mediapreviewoptions.md): Represents options for a media preview. - [Interface: Logger](interface-logger-2.md): Represents a logger function. - [Interface: LibraryOptions](interface-libraryoptions.md): Represents options for a library. - [Interface: InputOptions](interface-inputoptions.md): Represents options for an input. - [Interface: HTMLCreativeEngineCanvasElement](interface-htmlcreativeenginecanvaselement-2.md): A wrapper around a plain canvas - [Interface: HeadingOptions](interface-headingoptions.md): Represents options for a heading. - [Interface: GradientColorStop](interface-gradientcolorstop-2.md): Represents a gradient color stop. - [Interface: Font](interface-font-2.md): Represents a font. - [Interface: ExportOptions](interface-exportoptions.md): Specifies options for exporting design blocks to various formats. - [Interface: EnginePlugin](interface-engineplugin-2.md): Represents an engine plugin. - [Interface: \_EngineConfiguration](interface-engineconfiguration.md): Specifies the configuration for the Creative Editor SDK. - [Interface: EditorPlugin](interface-editorplugin.md): Represents an editor plugin. This interface defines the structure of an editor plugin, including its name, version, a... - [Interface: DropdownOptions](interface-dropdownoptions.md): Represents options for a dropdown. - [Interface: DropdownChildrenContext](interface-dropdownchildrencontext.md): Represents the context for the children of a dropdown. - [Interface: Dialog](interface-dialog.md): Represents a dialog configuration. - [Interface: ComponentPayload](interface-componentpayload.md): Represents the payload of a component. - [Interface: CustomDockComponent](interface-customdockcomponent.md): Represents a custom dock component. - [Interface: ComponentOptions](interface-componentoptions.md): Represents options for a component. - [Interface: CompleteAssetResult](interface-completeassetresult-2.md): Asset results that are returned from the engine. - [Interface: ColorInputOptions](interface-colorinputoptions.md): Represents options for a color input. - [Interface: CMYKColor](interface-cmykcolor-2.md): Represents a CMYK color value. - [Interface: CheckboxOptions](interface-checkboxoptions.md): Represents options for a checkbox. - [Interface: CESDKConfiguration](interface-cesdkconfiguration.md): Represents the configuration settings for the Creative Editor SDK. This interface defines various settings such as lo... - [Interface: CanvasMenuOptionsComponent](interface-canvasmenuoptionscomponent.md): Interface representing the canvas menu options dropdown component. This component can contain children components tha... - [Interface: CanvasMenuCustomActionButton](interface-canvasmenucustomactionbutton.md): Interface representing a custom canvas menu action button. Note: This component requires a key and has a required lab... - [Interface: CanvasMenuActionButton](interface-canvasmenuactionbutton.md): Base interface for action buttons in the canvas menu. Contains common properties shared across all canvas menu button... - [Interface: ButtonOptions](interface-buttonoptions.md): Represents options for a button. - [Interface: ButtonGroupOptions](interface-buttongroupoptions.md): Represents options for a button group. - [Interface: BuiltinTranslations](interface-builtintranslations.md): Built-in translation keys provided by the Creative Editor SDK. - [Interface: BuilderRenderFunctionContext](interface-builderrenderfunctioncontext.md): Represents the context for rendering a builder function. - [Interface: Builder](interface-builder.md): Interface for all available builder. Depending on the context different implementation might be used. A “Button” in t... - [Interface: Buffer](interface-buffer-2.md): Represents a buffer of data. - [Interface: BlockEvent](interface-blockevent-2.md): Represents an event related to a design block. - [Interface: AssetStringProperty](interface-assetstringproperty-2.md): Asset string property definition - [Interface: AssetsQueryResult](interface-assetsqueryresult-2.md): Return type of a`findAssets`query. - [Interface: AssetSpotColor](interface-assetspotcolor-2.md): Asset Color payload SpotColor representation - [Interface: AssetSource](interface-assetsource-2.md): A source of assets - [Interface: AssetRGBColor](interface-assetrgbcolor-2.md): Asset Color payload RGB representation - [Interface: AssetResult](interface-assetresult-2.md): Single asset result of a query from the engine. - [Interface: AssetQueryData](interface-assetquerydata-2.md): Defines a request for querying assets - [Interface: AssetPayload](interface-assetpayload-2.md): Asset payload - [Interface: AssetNumberProperty](interface-assetnumberproperty-2.md): Asset number property definition - [Interface: AssetLibraryEntry](interface-assetlibraryentry.md): Represents an entry in the asset library, combining data and view configurations. - [Interface: AssetFixedSize](interface-assetfixedsize-2.md): Asset transform preset payload fixed size - [Interface: AssetFreeAspectRatio](interface-assetfreeaspectratio-2.md): Asset transform preset payload free aspect ratio - [Interface: AssetFixedAspectRatio](interface-assetfixedaspectratio-2.md): Asset transform preset payload fixed aspect ratio - [Interface: AssetEnumProperty](interface-assetenumproperty-2.md): Asset enum property definition - [Interface: AssetDefinition](interface-assetdefinition-2.md): Definition of an asset used if an asset is added to an asset source. - [Interface: AssetColorProperty](interface-assetcolorproperty-2.md): Asset color property definition - [Interface: AssetCMYKColor](interface-assetcmykcolor-2.md): Asset Color payload CMYK representation - [Interface: Asset](interface-asset-2.md): Generic asset information - [Interface: AssetBooleanProperty](interface-assetbooleanproperty-2.md): Asset boolean property definition - [Interface: ApplyAssetOptions](interface-applyassetoptions-2.md): Options for applying an asset to the scene. - [Interface: AddVideoOptions](interface-addvideooptions-2.md): Options for adding videos to the scene. - [Type Alias: ZoomToPageAction](type-alias-zoomtopageaction.md): type ZoomToPageAction = (options?) => Promise; - [Type Alias: ZoomToSelectionAction](type-alias-zoomtoselectionaction.md): type ZoomToSelectionAction = (options?) => Promise; - [Type Alias: ZoomToLevelAction](type-alias-zoomtolevelaction.md): type ZoomToLevelAction = (level, options?) => void | Promise; - [Type Alias: ZoomToBlockAction](type-alias-zoomtoblockaction.md): type ZoomToBlockAction = (blockId, options?) => Promise; - [Type Alias: ZoomOptions](type-alias-zoomoptions-2.md): type ZoomOptions = object; - [Type Alias: ZoomOutAction](type-alias-zoomoutaction.md): type ZoomOutAction = (options?) => void | Promise; - [Type Alias: ZoomInAction](type-alias-zoominaction.md): type ZoomInAction = (options?) => void | Promise; - [Type Alias: ZoomAutoFitAxis](type-alias-zoomautofitaxis-2.md): type ZoomAutoFitAxis = "Horizontal" | "Vertical" | "Both"; - [Type Alias: XYWH](type-alias-xywh-2.md): type XYWH = [number, number, number, number]; - [Type Alias: ViewStyle](type-alias-viewstyle.md): type ViewStyle = "advanced" | "default"; - [Type Alias: VideoExportOptions](type-alias-videoexportoptions-2.md): type VideoExportOptions = object; - [Type Alias: VideoMimeType](type-alias-videomimetype-2.md): type VideoMimeType = Extract; - [Type Alias: VerticalBlockAlignment](type-alias-verticalblockalignment-2.md): type VerticalBlockAlignment = TextVerticalAlignment; - [Type Alias: UploadAction](type-alias-uploadaction.md): type UploadAction = (file, onProgress, context?) => Promise; - [Type Alias: UnknownTranslations](type-alias-unknowntranslations.md): type UnknownTranslations = object; - [Type Alias: UnknownPanelPayload](type-alias-unknownpanelpayload.md): type UnknownPanelPayload = object; - [Type Alias: TypefaceDefinition](type-alias-typefacedefinition-2.md): type TypefaceDefinition = object; - [Type Alias: TimelineZoomToLevelAction](type-alias-timelinezoomtolevelaction.md): type TimelineZoomToLevelAction = (level) => void; - [Type Alias: TimelineZoomToFitAction](type-alias-timelinezoomtofitaction.md): type TimelineZoomToFitAction = () => void; - [Type Alias: TimelineZoomResetAction](type-alias-timelinezoomresetaction.md): type TimelineZoomResetAction = () => void; - [Type Alias: TimelineZoomOutAction](type-alias-timelinezoomoutaction.md): type TimelineZoomOutAction = () => void; - [Type Alias: TimelineZoomInAction](type-alias-timelinezoominaction.md): type TimelineZoomInAction = () => void; - [Type Alias: TimelineExpandAction](type-alias-timelineexpandaction.md): type TimelineExpandAction = () => void; - [Type Alias: TimelineCollapseAction](type-alias-timelinecollapseaction.md): type TimelineCollapseAction = () => void; - [Type Alias: TextCase](type-alias-textcase-2.md): type TextCase = "Normal" | "Uppercase" | "Lowercase" | "Titlecase"; - [Type Alias: Suffix](type-alias-suffix.md): type Suffix = Partial>; - [Type Alias: StrokePosition](type-alias-strokeposition-2.md): type StrokePosition = typeof StrokePositionValues[number]; - [Type Alias: StrokeCornerGeometry](type-alias-strokecornergeometry-2.md): type StrokeCornerGeometry = typeof StrokeCornerGeometryValues[number]; - [Type Alias: StrokeStyle](type-alias-strokestyle-2.md): type StrokeStyle = typeof StrokeStyleValues[number]; - [Type Alias: SplitOptions](type-alias-splitoptions-2.md): type SplitOptions = object; - [Type Alias: SortingOrder](type-alias-sortingorder-2.md): type SortingOrder = "None" | "Ascending" | "Descending"; - [Type Alias: SizeMode](type-alias-sizemode-2.md): type SizeMode = WidthMode | HeightMode; - [Type Alias: ShareSceneAction](type-alias-sharesceneaction.md): type ShareSceneAction = () => void | Promise; - [Type Alias: ShapeTypeShorthand](type-alias-shapetypeshorthand-2.md): type ShapeTypeShorthand = typeof SHAPE_TYPES[number]; - [Type Alias: ShapeTypeLonghand](type-alias-shapetypelonghand-2.md): type ShapeTypeLonghand =`//ly.img.ubq/shape/${ShapeTypeShorthand}`; - [Type Alias: ShapeType](type-alias-shapetype-2.md): type ShapeType = | ShapeTypeShorthand | ShapeTypeLonghand; - [Type Alias: SettingType](type-alias-settingtype-2.md): type SettingType = "Bool" | "Int" | "Float" | "String" | "Color" | "Enum"; - [Type Alias: SettingsString](type-alias-settingsstring-2.md): type SettingsString = SettingStringPropertyName; - [Type Alias: SettingsFloat](type-alias-settingsfloat-2.md): type SettingsFloat = SettingFloatPropertyName; - [Type Alias: SettingsEnum](type-alias-settingsenum-2.md): type SettingsEnum = SettingEnumType; - [Type Alias: SettingsColorRGBA](type-alias-settingscolorrgba-2.md): type SettingsColorRGBA = SettingsColor; - [Type Alias: SettingsColor](type-alias-settingscolor-2.md): type SettingsColor = SettingColorPropertyName; - [Type Alias: SettingsBool](type-alias-settingsbool-2.md): type SettingsBool = SettingBoolPropertyName; - [Type Alias: ScrollToPageAction](type-alias-scrolltopageaction.md): type ScrollToPageAction = (options?) => Promise; - [Type Alias: Scope](type-alias-scope-2.md): type Scope = | "text/edit" | "text/character" | "fill/change" | "fill/changeType" | "stroke/change" | "shape/ch... - [Type Alias: ScrollToBlockAction](type-alias-scrolltoblockaction.md): type ScrollToBlockAction = (blockId, options?) => Promise; - [Type Alias: SceneLayout](type-alias-scenelayout-2.md): type SceneLayout = typeof SceneLayoutValues[number]; - [Type Alias: SceneMode](type-alias-scenemode-2.md): type SceneMode = typeof SceneModeValues[number]; - [Type Alias: SaveSceneAction](type-alias-savesceneaction.md): type SaveSceneAction = () => void | Promise; - [Type Alias: RoleString](type-alias-rolestring-2.md): type RoleString = "Creator" | "Adopter" | "Viewer" | "Presenter"; - [Type Alias: RGBA](type-alias-rgba-2.md): type RGBA = [number, number, number, number]; - [Type Alias: PropertyType](type-alias-propertytype-2.md): type PropertyType = | "Bool" | "Int" | "Float" | "String" | "Color" | "Enum" | "Struct" | "Double" | "Source... - [Type Alias: PreviewTypeImage](type-alias-previewtypeimage.md): type PreviewTypeImage = object; - [Type Alias: PreviewTypeColor](type-alias-previewtypecolor.md): type PreviewTypeColor = object; - [Type Alias: PreviewType](type-alias-previewtype.md): type PreviewType = | PreviewTypeImage | PreviewTypeColor; - [Type Alias: PositionMode](type-alias-positionmode-2.md): type PositionMode = PositionXMode | PositionYMode; - [Type Alias: PasteAction](type-alias-pasteaction.md): type PasteAction = () => void | Promise; - [Type Alias: PanelPayload](type-alias-panelpayload.md): type PanelPayload = T extends "//ly.img.panel/assetLibrary" ? AssetLibraryPanelPayload : UnknownPanelPayload; - [Type Alias: PanelOptions](type-alias-paneloptions.md): type PanelOptions = object; - [Type Alias: PanelId](type-alias-panelid.md): type PanelId = | "//ly.img.panel/assetLibrary" | "//ly.img.panel/assetLibrary.replace" | "//ly.img.panel/settings"... - [Type Alias: PanelDisposer](type-alias-paneldisposer.md): type PanelDisposer = () => void; - [Type Alias: PaletteColor](type-alias-palettecolor-2.md): type PaletteColor = | HexColorString | RGBColor | RGBAColor | SpotColor; - [Type Alias: PageFormatDefinition](type-alias-pageformatdefinition.md): type PageFormatDefinition = object; - [Type Alias: OrderComponentMatcher](type-alias-ordercomponentmatcher.md): type OrderComponentMatcher = | "first" | "last" | number | C["id"] | Partial | (component, index) => bool... - [Type Alias: Optional](type-alias-optional.md): type Optional = Omit & Partial; - [Type Alias: OnUnsupportedBrowserAction](type-alias-onunsupportedbrowseraction.md): type OnUnsupportedBrowserAction = () => void; - [Type Alias: OnExportVideoOptions](type-alias-onexportvideooptions.md): type OnExportVideoOptions = VideoExportOptions & object; - [Type Alias: OnExportOptions](type-alias-onexportoptions.md): type OnExportOptions = EngineExportOptions & object; - [Type Alias: OffscreenCanvas](type-alias-offscreencanvas-2.md): type OffscreenCanvas = object; - [Type Alias: ObjectTypeShorthand](type-alias-objecttypeshorthand-2.md): type ObjectTypeShorthand = | DesignBlockTypeShorthand |`shape/${ShapeTypeShorthand}`|`fill/${FillTypeShorthand}... - [Type Alias: ObjectTypeLonghand](type-alias-objecttypelonghand-2.md): type ObjectTypeLonghand = | DesignBlockTypeLonghand | ShapeTypeLonghand | FillTypeLonghand | EffectTypeLonghand ... - [Type Alias: ObjectType](type-alias-objecttype-2.md): type ObjectType = | ObjectTypeShorthand | ObjectTypeLonghand; - [Type Alias: NotificationType](type-alias-notificationtype.md): type NotificationType = "success" | "error" | "info" | "warning" | "loading"; - [Type Alias: NotificationDuration](type-alias-notificationduration.md): type NotificationDuration = number | "infinite" | "short" | "medium" | "long"; - [Type Alias: NavigationBarOrderComponent](type-alias-navigationbarordercomponent.md): type NavigationBarOrderComponent = | NavigationBarComponents| OrderComponentWithChildren void | Promise; - [Type Alias: ImageMimeType](type-alias-imagemimetype-2.md): type ImageMimeType = Extract; - [Type Alias: HistoryId](type-alias-historyid-2.md): type HistoryId = number; - [Type Alias: HorizontalBlockAlignment](type-alias-horizontalblockalignment-2.md): type HorizontalBlockAlignment = TextHorizontalAlignment; - [Type Alias: HexColorString](type-alias-hexcolorstring-2.md): type HexColorString = string; - [Type Alias: GradientstopRGBA](type-alias-gradientstoprgba-2.md): type GradientstopRGBA = [number, number, number, number, number]; - [Type Alias: FontWeight](type-alias-fontweight-2.md): type FontWeight = | "thin" | "extraLight" | "light" | "normal" | "medium" | "semiBold" | "bold" | "extraBold"... - [Type Alias: FontStyle](type-alias-fontstyle-2.md): type FontStyle = "normal" | "italic"; - [Type Alias: FillTypeShorthand](type-alias-filltypeshorthand-2.md): type FillTypeShorthand = typeof FILL_TYPES[number]; - [Type Alias: FillTypeLonghand](type-alias-filltypelonghand-2.md): type FillTypeLonghand =`//ly.img.ubq/fill/${FillTypeShorthand}`; - [Type Alias: FillType](type-alias-filltype-2.md): type FillType = | FillTypeShorthand | FillTypeLonghand; - [Type Alias: FileMimeType](type-alias-filemimetype.md): type FileMimeType = | "image/png" | "image/jpeg" | "image/webp" | "image/x-tga" | "audio/wav" | "video/mp4" | ... - [Type Alias: FeaturePredicateContext](type-alias-featurepredicatecontext.md): type FeaturePredicateContext = IsEnabledFeatureContext & object; - [Type Alias: FeaturePredicate](type-alias-featurepredicate.md): type FeaturePredicate = boolean | (context) => boolean; - [Type Alias: FeatureId](type-alias-featureid.md): type FeatureId = | "ly.img.navigation.bar" | "ly.img.navigation.back" | "ly.img.navigation.close" | "ly.img.navig... - [Type Alias: ExportSceneAction](type-alias-exportsceneaction.md): type ExportSceneAction = (options) => void | Promise; - [Type Alias: ExportAction](type-alias-exportaction.md): type ExportAction = (options?) => void | Promise; - [Type Alias: EnginePluginContext](type-alias-engineplugincontext-2.md): type EnginePluginContext = object; - [Type Alias: EngineExportOptions](type-alias-engineexportoptions.md): type EngineExportOptions = object; - [Type Alias: EffectTypeShorthand](type-alias-effecttypeshorthand-2.md): type EffectTypeShorthand = typeof EFFECT_TYPES[number]; - [Type Alias: EffectTypeLonghand](type-alias-effecttypelonghand-2.md): type EffectTypeLonghand =`//ly.img.ubq/effect/${EffectTypeShorthand}`; - [Type Alias: EffectType](type-alias-effecttype-2.md): type EffectType = | EffectTypeShorthand | EffectTypeLonghand; - [Type Alias: EditorPluginContext](type-alias-editorplugincontext.md): type EditorPluginContext = EnginePluginContext & object; - [Type Alias: EditMode](type-alias-editmode-2.md): type EditMode = "Transform" | "Crop" | "Text" | "Playback" | "Trim" | string & object; - [Type Alias: DropShadowOptions](type-alias-dropshadowoptions-2.md): type DropShadowOptions = object; - [Type Alias: DockOrderComponentId](type-alias-dockordercomponentid.md): type DockOrderComponentId = "ly.img.separator" | "ly.img.spacer" | string & object; - [Type Alias: DockOrderComponent](type-alias-dockordercomponent.md): type DockOrderComponent = | CustomDockComponent | AssetLibraryDockComponent; - [Type Alias: DialogType](type-alias-dialogtype.md): type DialogType = "regular" | "success" | "error" | "info" | "warning" | "loading"; - [Type Alias: DialogSize](type-alias-dialogsize.md): type DialogSize = "regular" | "large"; - [Type Alias: DialogProgress](type-alias-dialogprogress.md): type DialogProgress = | number | "indeterminate" | { value: number; max: number;}; - [Type Alias: DialogContent](type-alias-dialogcontent.md): type DialogContent = | string | { title?: string; message: string | string[];}; - [Type Alias: DialogAction](type-alias-dialogaction.md): type DialogAction = object; - [Type Alias: DesignUnit](type-alias-designunit-2.md): type DesignUnit = typeof SceneDesignUnitValues[number]; - [Type Alias: DesignBlockTypeShorthand](type-alias-designblocktypeshorthand-2.md): type DesignBlockTypeShorthand = typeof DESIGN_BLOCK_TYPES[number]; - [Type Alias: DesignBlockTypeLonghand](type-alias-designblocktypelonghand-2.md): type DesignBlockTypeLonghand =`//ly.img.ubq/${DesignBlockTypeShorthand}`; - [Type Alias: DesignBlockType](type-alias-designblocktype-2.md): type DesignBlockType = | DesignBlockTypeShorthand | DesignBlockTypeLonghand; - [Type Alias: DesignBlockId](type-alias-designblockid-2.md): type DesignBlockId = number; - [Type Alias: DemoAssetSourceId](type-alias-demoassetsourceid-2.md): type DemoAssetSourceId = | "ly.img.template" | "ly.img.image.upload" | "ly.img.video.upload" | "ly.img.audio.uplo... - [Type Alias: DefaultAssetSourceId](type-alias-defaultassetsourceid-2.md): type DefaultAssetSourceId = | "ly.img.sticker" | "ly.img.vectorpath" | "ly.img.colors.defaultPalette" | "ly.img.f... - [Type Alias: CutoutType](type-alias-cutouttype-2.md): type CutoutType = typeof CutoutTypeValues[number]; - [Type Alias: CutoutOperation](type-alias-cutoutoperation-2.md): type CutoutOperation = "Difference" | "Intersection" | "Union" | "XOR"; - [Type Alias: CustomPanelMountFunction](type-alias-custompanelmountfunction.md): type CustomPanelMountFunction = (domElement) => PanelDisposer; - [Type Alias: CustomActionFunction](type-alias-customactionfunction.md): type CustomActionFunction = (...args) => any | Promise; - [Type Alias: CreateSceneOptions](type-alias-createsceneoptions-2.md): type CreateSceneOptions = object; - [Type Alias: CopyAction](type-alias-copyaction.md): type CopyAction = () => void | Promise; - [Type Alias: ContentFillMode](type-alias-contentfillmode-2.md): type ContentFillMode = typeof ContentFillModeValues[number]; - [Type Alias: Configuration](type-alias-configuration.md): type Configuration = Partial; - [Type Alias: ComponentId](type-alias-componentid.md): type ComponentId = | DockOrderComponentId | CanvasMenuComponentId | NavigationBarComponentId | CanvasBarComponent... - [Type Alias: ColorSpace](type-alias-colorspace-2.md): type ColorSpace = "sRGB" | "CMYK" | "SpotColor"; - [Type Alias: CMYK](type-alias-cmyk-2.md): type CMYK = [number, number, number, number]; - [Type Alias: ChildrenOrder](type-alias-childrenorder.md): type ChildrenOrder = ( | ComponentId | OrderComponent)[]; - [Type Alias: CanvasMenuOrderComponent](type-alias-canvasmenuordercomponent.md): type CanvasMenuOrderComponent = | CanvasMenuComponents| OrderComponentWithChildren void; - [Type Alias: BooleanOperation](type-alias-booleanoperation-2.md): type BooleanOperation = "Difference" | "Intersection" | "Union" | "XOR"; - [Type Alias: BlurTypeShorthand](type-alias-blurtypeshorthand-2.md): type BlurTypeShorthand = typeof BLUR_TYPES[number]; - [Type Alias: BlurTypeLonghand](type-alias-blurtypelonghand-2.md): type BlurTypeLonghand =`//ly.img.ubq/blur/${BlurTypeShorthand}`; - [Type Alias: BlurType](type-alias-blurtype-2.md): type BlurType = | BlurTypeShorthand | BlurTypeLonghand; - [Type Alias: BlockState](type-alias-blockstate-2.md): type BlockState = BlockStateError | BlockStatePending | BlockStateReady; - [Type Alias: BlendMode](type-alias-blendmode-2.md): type BlendMode = typeof BlendModeValues[number]; - [Type Alias: AudioMimeType](type-alias-audiomimetype-2.md): type AudioMimeType = Extract; - [Type Alias: AudioExportOptions](type-alias-audioexportoptions-2.md): type AudioExportOptions = object; - [Type Alias: AssetTransformPreset](type-alias-assettransformpreset-2.md): type AssetTransformPreset = | AssetFixedAspectRatio | AssetFreeAspectRatio | AssetFixedSize; - [Type Alias: AssetProperty](type-alias-assetproperty-2.md): type AssetProperty = | AssetBooleanProperty | AssetColorProperty | AssetEnumProperty | AssetNumberProperty | Ass... - [Type Alias: AssetMetaData](type-alias-assetmetadata-2.md): type AssetMetaData = object & Record; - [Type Alias: AssetLibraryPanelPayload](type-alias-assetlibrarypanelpayload.md): type AssetLibraryPanelPayload = object; - [Type Alias: AssetLibraryDockComponent](type-alias-assetlibrarydockcomponent.md): type AssetLibraryDockComponent = object; - [Type Alias: AssetGroups](type-alias-assetgroups-2.md): type AssetGroups = string[]; - [Type Alias: AssetEntryId](type-alias-assetentryid.md): type AssetEntryId = | "ly.img.colors" | "ly.img.typefaces" | "ly.img.pagePresets" | "ly.img.cropPresets" | "ly.i... - [Type Alias: AssetColor](type-alias-assetcolor-2.md): type AssetColor = | AssetRGBColor | AssetCMYKColor | AssetSpotColor; - [Type Alias: ApplicationMimeType](type-alias-applicationmimetype-2.md): type ApplicationMimeType = Extract; - [Type Alias: AnimationTypeShorthand](type-alias-animationtypeshorthand-2.md): type AnimationTypeShorthand = typeof ANIMATION_TYPES[number]; - [Type Alias: AnimationTypeLonghand](type-alias-animationtypelonghand-2.md): type AnimationTypeLonghand =`//ly.img.ubq/animation/${AnimationTypeShorthand}`; - [Type Alias: AnimationType](type-alias-animationtype-2.md): type AnimationType = | AnimationTypeShorthand | AnimationTypeLonghand; - [Type Alias: AnimationOptions](type-alias-animationoptions-2.md): type AnimationOptions = object; - [Type Alias: AnimationEntry](type-alias-animationentry-2.md): type AnimationEntry = object; - [Type Alias: AnimationEasing](type-alias-animationeasing-2.md): type AnimationEasing = typeof AnimationEasingValues[number]; - [Type Alias: AddImageOptions](type-alias-addimageoptions-2.md): type AddImageOptions = object; - [Type Alias: ActionId](type-alias-actionid.md): type ActionId = | keyof RegisteredActions | string & object; - [Type Alias: ActionFunction](type-alias-actionfunction.md): type ActionFunction = T extends keyof RegisteredActions ? RegisteredActions[T] : C; - [Namespace: UserInterfaceElements](namespace-userinterfaceelements.md): | Type Alias | Description | - [Namespace: ConfigTypes](namespace-configtypes.md): | Type Alias | Description | - [Namespace: ExperimentalUserInterfaceAPI](namespace-experimentaluserinterfaceapi.md): Provides experimental methods for controlling the UI of the Creative Editor SDK. - [Namespace: ExperimentalBuilder](namespace-experimentalbuilder.md): Namespace containing experimental features for the builder. These features are subject to change and may not be stabl... - [Namespace: CESDKConfiguration](namespace-cesdkconfiguration.md): Namespace for`CESDKConfiguration`to include deprecated keys. This namespace includes deprecated keys that are part ... - [Type Alias: UserInterfaceCustomActionIconName](type-alias-userinterfacecustomactioniconname.md): type UserInterfaceCustomActionIconName = "default" | "download" | "upload" | "save" | string & object; - [Type Alias: CustomIcon](type-alias-customicon.md): type CustomIcon = string | ({ theme, iconSize }) => string; - [Type Alias: ExportFormat](type-alias-exportformat.md): type ExportFormat = "image/png" | "video/mp4" | "application/pdf"; - [Type Alias: CustomCardSvgVectorPathBackground](type-alias-customcardsvgvectorpathbackground.md): type CustomCardSvgVectorPathBackground = object; - [Type Alias: CustomCardImageBackground](type-alias-customcardimagebackground.md): type CustomCardImageBackground = object; - [Type Alias: CustomCardBackground](type-alias-customcardbackground.md): type CustomCardBackground = | CustomCardImageBackground | CustomCardSvgVectorPathBackground; - [Type Alias: CardBackground](type-alias-cardbackground.md): type CardBackground = object; - [Type Alias: AssetLibraryEntries](type-alias-assetlibraryentries.md): type AssetLibraryEntries = | AssetLibraryEntry[] | (currentAssetLibraryEntries, context) => AssetLibraryEntry[]; - [Enum: NavigationPosition](enum-navigationposition.md): This enum is used to specify the position of the navigation bar within the user interface. - [Interface: UserInterfaceSettings](interface-userinterfacesettings.md): Interface representing the settings in the user interface. - [Interface: UserInterfaceInspectorBlockVideoFill](interface-userinterfaceinspectorblockvideofill.md): Interface representing a video fill block in the user interface inspector. - [Interface: UserInterfaceNavigation](interface-userinterfacenavigation.md): Interface representing the navigation in the user interface. - [Interface: UserInterfaceInspectorBlockText](interface-userinterfaceinspectorblocktext.md): Interface representing a text block in the user interface inspector. - [Interface: UserInterfaceInspectorBlockShape](interface-userinterfaceinspectorblockshape.md): Interface representing a shape block in the user interface inspector. - [Interface: UserInterfaceInspectorBlocks](interface-userinterfaceinspectorblocks.md): Interface representing the blocks in the user interface inspector. - [Interface: UserInterfaceInspectorBlockRectShape](interface-userinterfaceinspectorblockrectshape.md): Interface representing a rectangular shape block in the user interface inspector. - [Interface: UserInterfaceInspectorBlockPage](interface-userinterfaceinspectorblockpage.md): Interface representing a page block in the user interface inspector. - [Interface: UserInterfaceInspectorBlockImage](interface-userinterfaceinspectorblockimage.md): Interface representing an image block in the user interface inspector. - [Interface: UserInterfaceInspectorBlockGraphic](interface-userinterfaceinspectorblockgraphic.md): Interface representing a graphic block in the user interface inspector. - [Interface: UserInterfaceInspectorBlock](interface-userinterfaceinspectorblock.md): Interface representing a block in the user interface inspector. - [Interface: UserInterfaceInspector](interface-userinterfaceinspector.md): Interface representing the inspector in the user interface. - [Interface: UserInterfaceExportAction](interface-userinterfaceexportaction.md): Interface representing an export action in the user interface. - [Interface: UserInterfaceElements](interface-userinterfaceelements.md): Defines the configuration for user interface elements, including panels, dock, libraries, blocks, navigation, and ins... - [Interface: UserInterfaceElement](interface-userinterfaceelement.md): Interface representing an element in the user interface. - [Interface: UserInterfaceCustomAction](interface-userinterfacecustomaction.md): Interface representing a custom action in the user interface. - [Interface: UserInterfaceAssetLibrary](interface-userinterfaceassetlibrary.md): Interface representing the asset library in the user interface. - [Interface: DockGroup](interface-dockgroup.md): Please use the AssetLibraryEntry & Dock API to control what is shown in the Dock. - [Interface: AssetLibraryEntryView](interface-assetlibraryentryview.md): Interface representing the view configuration for an asset library entry. - [Interface: AssetLibraryEntryData](interface-assetlibraryentrydata.md): Interface representing the data configuration for an asset library entry. - [Interface: AssetEntrySourceIdsContext](interface-assetentrysourceidscontext.md): Context provided to the sourceIds callback function. - [Interface: UploadCallbackContext](interface-uploadcallbackcontext.md): Represents the context for the upload callback in the Creative Editor SDK. This interface defines the source ID and a... - [Interface: UIOptionsForSingleDesignUnit](interface-uioptionsforsingledesignunit.md): Represents the UI options for a single design unit type in the Creative Editor SDK. This interface defines the bleed ... - [Interface: UIOptionsPerDesignUnit](interface-uioptionsperdesignunit.md): Represents the UI options for different design units in the Creative Editor SDK. This interface defines the UI option... - [Interface: FontSizeOptions](interface-fontsizeoptions.md): Represents the font size configuration options in the Creative Editor SDK. This interface defines the dropdown option... - [Interface: BleedMarginOptions](interface-bleedmarginoptions.md): Represents the bleed margin configuration options for a single design unit type in the Creative Editor SDK. This inte... - [Type Alias: ThemeFn](type-alias-themefn.md): type ThemeFn = () => Theme; - [Type Alias: ThemeConfig](type-alias-themeconfig.md): type ThemeConfig = | Theme | ThemeFn | "system"; - [Type Alias: Theme](type-alias-theme.md): type Theme = "light" | "dark"; - [Type Alias: ScaleFn](type-alias-scalefn.md): type ScaleFn = ({ containerWidth, isTouch }) => Scale; - [Type Alias: ScaleConfig](type-alias-scaleconfig.md): type ScaleConfig = | Scale | ScaleFn; - [Type Alias: Scale](type-alias-scale.md): type Scale = "normal" | "large" | "modern"; - [Type Alias: OnUploadOptions](type-alias-onuploadoptions.md): type OnUploadOptions = object; - [Type Alias: OnUploadCallback](type-alias-onuploadcallback.md): type OnUploadCallback = (file, onProgress, context?) => Promise; - [Type Alias: I18n](type-alias-i18n.md): type I18n = Record>; - [Type Alias: CombinedConfiguration](type-alias-combinedconfiguration.md): type CombinedConfiguration = CESDKConfiguration & Omit & DeprecatedKeys; - [Type Alias: Callbacks](type-alias-callbacks.md): type Callbacks = object; - [Type Alias: A11y](type-alias-a11y.md): type A11y = object; - [Class: UserInterfaceAPI](class-userinterfaceapi-2.md): A public interface for controlling the UI of the Creative Editor SDK - [Type Alias: PreviewTypeImage](type-alias-previewtypeimage-2.md): type PreviewTypeImage = object; - [Type Alias: PreviewTypeColor](type-alias-previewtypecolor-2.md): type PreviewTypeColor = object; - [Type Alias: PreviewType](type-alias-previewtype-2.md): type PreviewType = | PreviewTypeImage | PreviewTypeColor; - [Type Alias: Placement](type-alias-placement.md): type Placement = | "top" | "bottom" | "right" | "left" | "auto" | "auto-start" | "auto-end" | "top-start" | ... - [Interface: PopoverOptions](interface-popoveroptions.md): | Property | Type | - [Interface: PopoverChildrenContext](interface-popoverchildrencontext.md): | Property | Type | - [Interface: MenuOptions](interface-menuoptions.md): | Property | Type | - [Interface: ButtonRowOptions](interface-buttonrowoptions.md): | Property | Type | - [Interface: MediaPreviewOptions](interface-mediapreviewoptions-2.md): | Property | Type | - [Interface: BuilderRenderContext](interface-builderrendercontext.md): | Property | Type | Description | - [Interface: Builder](interface-builder-2.md): Interface for all available builder. Depending on the context different implementation might be used. A “Button” in t... - [Type Alias: DeprecatedKeys](type-alias-deprecatedkeys.md): type DeprecatedKeys = object;