Search Docs
Loading...
Skip to content

Interface: Settings

Map of all available settings with their types. This provides type-safe access to all editor settings.

The settings are organized by type:

  • Boolean settings control various on/off features in the editor
  • String settings configure paths and textual values
  • Float settings define numerical thresholds and limits
  • Integer settings specify whole number limits
  • Color settings control the visual appearance
  • Enum settings provide predefined choice options

Properties#

Property Type Description
clip/defaultDurationValue number Initial duration of new text and graphic blocks and empty groups in seconds. Must be finite and positive. Defaults to 5.
clip/initialDurationMode "default" "followParent"
controlGizmo/showCropHandles boolean Whether to show handles for adjusting the crop area during crop mode.
controlGizmo/showCropScaleHandles boolean Whether to display the outer handles that scale the full image during crop.
controlGizmo/showMoveHandles boolean Deprecated Use controlGizmo/moveHandleVisibility. false hides the move handle.
controlGizmo/dynamicMoveHandleVisibility boolean Deprecated Use controlGizmo/moveHandleVisibility. false shows the move handle at any block size.
controlGizmo/showResizeHandles boolean Deprecated Use controlGizmo/resizeHandlesVisibility. false hides the edge (resize) handles.
controlGizmo/showRotateHandles boolean Deprecated Use controlGizmo/rotateHandlesVisibility. false hides the rotation handle.
controlGizmo/showScaleHandles boolean Deprecated Use controlGizmo/scaleHandlesVisibility. false hides the corner (scale) handles.
doubleClickToCropEnabled boolean Enable double-click to enter crop mode.
dragToSwapFills/enabled boolean Whether pressing and holding an image element lifts its image into a drag. Releasing it over another image element exchanges the two images.
features/singlePageModeEnabled boolean Show only the current pages (see scene.setCurrentPages) in the interactive view. A saved scene keeps every page, and an export of a scene holds every page, except pages hidden with block.setVisible. If the mode is on when a scene loads, it also controls the pages that the scene saved as hidden. It shows them like other pages, and the next save stores them as visible.
features/fileSystemUsageEnabled boolean Enable file system usage, that allows the engine to use the file system to store files for local uploads.
features/pageCarouselEnabled boolean Enable the page carousel for navigating between pages.
features/transformEditsRetainCoverMode boolean Whether transform edits should retain the cover mode of the content.
features/clampTextBlockWidthToPageDimensionsDuringEditing boolean Whether auto-sized text blocks should be clamped to page boundaries during editing.
features/equalDistanceSnappingEnabled boolean Whether a dragged block snaps to equal spacing with its siblings and shows the size of each gap. Defaults to false.
features/transformLockedClickThroughEnabled boolean Whether the canvas skips a block whose transform is locked, and every block inside a locked block other than its page. Clicks, taps, hover and marquee selection pass through it to the block below. block.setSelected still selects it, for example from a layer list. A locked page still takes clicks, and the blocks on it stay reachable. Use page/restrictPageSelectionToBorderAndTitle for the clicks on a page. Dragging a fill or an asset still reaches the block, because a lock holds only the transform. Defaults to false.
features/previewMotionBlurEnabled boolean Experimental Whether the preview draws the motion blur of blocks with motionBlur/enabled, as the video export does. While the preview plays or changes, it may draw fewer samples to keep up. The export ignores this setting. Defaults to true. Experimental: this API may change in a minor release.
features/fontLineGapEnabled boolean Whether the line height of text includes the line gap that a font declares, as most text engines do. Set it to false for the line heights of engine versions before 1.73, which ignored the line gap. Defaults to true.
features/historyEnabled boolean Whether the engine records undo steps. Each loaded scene then keeps a compressed copy of each block for undo. Set it to false for an engine that never undoes, such as one that only exports. It then keeps no copy and no steps. addUndoStep, undo and redo change nothing, and canUndo and canRedo return false. Turning it off discards the undo steps at once. The histories stay, and setActiveHistory still returns each one to its scene. Turning it on starts a new history at the next undo step. A saved scene does not keep it. Defaults to true.
mouse/enableScroll boolean Whether the engine processes mouse scroll events.
mouse/enableZoom boolean Whether the engine processes mouse zoom events.
page/allowCropInteraction boolean Whether crop interaction (by handles and gestures) should be possible.
page/allowMoveInteraction boolean Whether move interaction should be possible when page layout is not controlled by the scene.
page/marqueeSelectOnBodyDrag boolean When enabled, a click+drag that starts on the page body performs a marquee selection of the blocks inside the page instead of moving the page. The page can still be moved by dragging its title (when visible in free layout) or by holding the command key (macOS) / control key (Windows/Linux) while clicking and dragging on the page body. Has no effect when the page is not movable (see page/allowMoveInteraction and scene layout constraints).
page/restrictPageSelectionToBorderAndTitle boolean When enabled, the page can only be selected by clicking on its title (when shown in free layout) or near its border. Clicks inside the page body no longer select the page; the click falls through to whatever block sits underneath. Independent of page/marqueeSelectOnBodyDrag.
page/allowResizeInteraction boolean Whether resize interaction (by handles and gestures) should be possible.
page/allowRotateInteraction boolean Whether rotation interaction should be possible when page layout is not controlled by the scene.
page/allowShapeChange boolean Whether pages support non-rectangular shapes. When false, supportsShape returns false for pages.
page/dimOutOfPageAreas boolean Whether the opacity of the region outside of all pages should be reduced.
page/restrictResizeInteractionToFixedAspectRatio boolean Whether resize interaction should be restricted to fixed aspect ratio.
page/moveChildrenWhenCroppingFill boolean Whether children of the page should be transformed to match their old position when cropping.
page/imageFillCoversBleed boolean Whether an image or video fill of a page covers the bleed too. When disabled, the bleed stays empty.
page/title/appendPageName boolean Whether to append the page name to the title even if not specified in the template.
page/title/canEdit boolean Whether double-clicking a page title enters text edit mode to rename the page.
page/title/show boolean Whether to show titles above each page.
page/title/showOnSinglePage boolean Whether to hide the page title when only a single page exists.
page/title/showPageTitleTemplate boolean Whether to include the default page title from page.titleTemplate.
page/safetyRevealDuringTransform boolean Whether the safety inset appears only while a drag, a nudge or a keyboard resize is in it or comes near it.
placeholderControls/showButton boolean Whether to show the placeholder button.
placeholderControls/showOverlay boolean Whether to show the overlay pattern for placeholders.
blockAnimations/enabled boolean Whether animations should be enabled or not.
playback/showAllBlocks boolean When enabled, every block stays visible regardless of the current playback time, instead of being culled outside its time offset/duration. No effect on export.
grid/enabled boolean Whether the background grid is shown on pages.
grid/snapEnabled boolean Whether elements should snap to grid lines when dragged.
showBuildVersion boolean Whether to display the build version in the UI.
touch/dragStartCanSelect boolean Whether drag start can select elements.
touch/singlePointPanning boolean Whether single-point panning is enabled for touch interactions.
useSystemFontFallback boolean Whether to use system font as fallback for missing glyphs.
forceSystemEmojis boolean Whether to force the use of system emojis instead of custom emoji fonts.
page/selectWhenNoBlocksSelected boolean Whether to select the page when a block is deselected and no other blocks are selected.
page/highlightWhenCropping boolean Whether highlighting should be automatically enabled on the current page when entering crop mode.
page/highlightDropTarget boolean Whether to highlight the page under a dragged element as a drop target.
page/reparentBlocksToSceneWhenOutOfPage boolean Whether blocks should be reparented to the scene when dragged outside all pages, and reparented back to a page when dragged over one.
clampThumbnailTextureSizes boolean Clamp thumbnail texture sizes to the platform’s GPU texture limit.
dock/hideLabels boolean Toggle the dock components visibility
basePath string The root directory for resolving relative paths and bundle:// URIs. Also used as the base URL for loading font fallback files and the default emoji font (when self-hosting assets). If empty, defaults to https://cdn.img.ly/assets/v4 for font/emoji assets.
defaultEmojiFontFileUri string The URI for the default emoji font file.
defaultFontFileUri string The URI for the default font file.
license string The license key for the SDK.
page/title/fontFileUri string The font file URI for page titles.
page/title/separator string The separator between page number and page name in titles.
fallbackFontUri string The URI for the fallback font used when glyphs are missing.
fallbackCMYKProfileUri string The URI of the ICC profile that previews CMYK colors when the document defines no CMYK profile. Empty means the bundled default profile.
upload/supportedMimeTypes string The supported MIME types for file uploads.
web/fetchCredentials "omit" "same-origin"
controlGizmo/blockScaleDownLimit number Scale-down limit for blocks in screen pixels when scaling with gizmos or touch gestures.
listIndentPerLevel number The width of each list indentation level, in EM units.
tabStopInterval number The distance between text tab stops, as a multiple of the base font size. A value of 0 or less makes tab characters advance no width.
positionSnappingThreshold number The threshold distance in pixels for position snapping.
rotationSnappingThreshold number The threshold angle in degrees for rotation snapping.
grid/spacingX number Horizontal spacing between vertical grid lines in design units.
grid/spacingY number Vertical spacing between horizontal grid lines in design units.
dragToSwapFills/longPressDurationMs number How long the pointer must stay pressed and still before the image lifts, in milliseconds. 0 lifts on the first update, so every drag swaps instead of moves.
exportPendingTimeoutSeconds number The longest time, in seconds, that an export waits for blocks whose resources make no loading progress. The export then fails with an error that names the blocks. A block set to pending with setState does not count toward this limit. 0 or less waits without limit. Defaults to 60.
maxImageSize number The maximum size (width or height) in pixels for images.
maxPreviewResolution number The maximum dimension (width or height) in physical pixels for preview rendering. When greater than 0, the scene is rendered at reduced resolution and upscaled for improved performance. Does not affect exports. Set to -1 to disable (default).
maxConcurrentRequestsPerHost number The most downloads, such as images, fonts and videos, that one engine runs at the same time to one host. A host is the scheme, the name and the port of a URL. A further download waits until one of them ends. In the browser and in @cesdk/node, a video that streams in parts counts only until its first parts load. 0 or less sets no limit in the engine. Defaults to 0.
borderOutlineColor Color The color of the border outline for selected elements.
clearColor Color The background clear color.
colorMaskingSettings/maskColor Color The color used for color masking effects.
cropOverlayColor Color The color of the crop overlay.
errorStateColor Color The color indicating an error state.
highlightColor Color The highlight color for selected or active elements.
page/exclusionAreaFillColor Color The color washed over an exclusion area.
page/exclusionAreaFrameColor Color The color of the frame around an exclusion area.
page/innerBorderColor Color The color of the inner frame around the page.
page/marginFillColor Color The color filled into the bleed margins of pages.
page/marginFrameColor Color The color of the frame around the bleed margin area.
page/outerBorderColor Color The color of the outer frame around the page.
page/safetyFillColor Color The color filled into the safety inset band of pages.
page/safetyFrameColor Color The color of the frame around the safety inset of the pages.
page/title/color Color The color of page titles visible in preview mode.
pageHighlightColor Color Color of the outline of each page
placeholderHighlightColor Color The highlight color for placeholder elements.
progressColor Color The color indicating progress or loading states.
rotationSnappingGuideColor Color The color of rotation snapping guide lines.
ruleOfThirdsLineColor Color The color of rule of thirds guide lines.
snappingGuideColor Color The color of snapping guide lines.
textVariableHighlightColor Color The highlight color for text variables.
handleFillColor Color The fill color for handles.
grid/color Color Color of the grid lines.
controlGizmo/moveHandleVisibility "auto" "always"
controlGizmo/resizeHandlesVisibility "auto" "always"
controlGizmo/scaleHandlesVisibility "auto" "always"
controlGizmo/rotateHandlesVisibility "auto" "always"
doubleClickSelectionMode "Direct" "Hierarchical"
touch/pinchAction "Auto" "None"
touch/rotateAction "None" "Rotate"
camera/clamping/overshootMode "Center" "Reverse"
dock/iconSize "normal" "large"
colorPicker/colorMode "CMYK" "RGB"
timeline/trackVisibility "all" "active"
timeline/transitionControlVisibility "always" "hover"
features/textEditModeTransformHandlesEnabled boolean Whether a text block keeps its resize, scale and rotate handles while its text is being edited, so it can be resized and rotated without leaving text edit mode. It does not make the block movable. Off by default.
features/automaticSourceSetsEnabled boolean Whether the engine makes the smaller source set entries of an image fill by itself, in an update that draws a frame. On by default. A browser engine draws a frame on each animation frame, also when its canvas is not on the page, so set it to false in an engine that only exports. The entries use the buffer scheme, so saveToString leaves them out unless onDisallowedResourceScheme stores them.