@cesdk/node 1.72.0-nightly.20260319 → 1.72.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -5591,7 +5591,6 @@ export declare class BlockAPI {
5591
5591
  /**
5592
5592
  * Adds a video block to the current scene page. The video will be positioned and sized
5593
5593
  * according to the provided parameters. Timeline and animation effects can be applied.
5594
- * Only works in Video mode, not in Design mode.
5595
5594
  *
5596
5595
  * @category Helper
5597
5596
  * @param url - URL or path to the video file
@@ -5599,7 +5598,7 @@ export declare class BlockAPI {
5599
5598
  * @param height - Height of the video in scene design units
5600
5599
  * @param options - Configuration options for the video
5601
5600
  * @returns Promise that resolves to the ID of the created video block
5602
- * @throws Error if called in Design mode or if no current page exists
5601
+ * @throws Error if no current page exists
5603
5602
  */
5604
5603
  addVideo(url: string, width: number, height: number, options?: AddVideoOptions): Promise<DesignBlockId>;
5605
5604
  /**
@@ -5620,23 +5619,20 @@ export declare class BlockAPI {
5620
5619
  applyDropShadow(block: DesignBlockId, options?: DropShadowOptions): void;
5621
5620
  /**
5622
5621
  * Generates a thumbnail image of the scene at a specific time.
5623
- * Only works in Video mode, not in Design mode.
5624
5622
  *
5625
5623
  * @category Helper
5626
5624
  * @param height - Height of the thumbnail in scene design units (maximum 512)
5627
5625
  * @param time - Time position in seconds to capture the thumbnail
5628
5626
  * @returns Promise that resolves to a Blob containing the PNG thumbnail image
5629
- * @throws Error if no page exists, if called in Design mode, or if height exceeds 512 pixels
5627
+ * @throws Error if no page exists or if height exceeds 512 pixels
5630
5628
  */
5631
5629
  generateThumbnailAtTimeOffset(height: number, time: number): Promise<Blob>;
5632
5630
  /**
5633
5631
  * Gets the background track of the current scene.
5634
5632
  * The background track is the track that determines the page duration.
5635
- * Only works in Video mode, not in Design mode.
5636
5633
  *
5637
5634
  * @category Helper
5638
5635
  * @returns The ID of the background track, or null if none exists
5639
- * @throws Error if called in Design mode
5640
5636
  */
5641
5637
  getBackgroundTrack(): DesignBlockId | null;
5642
5638
  /**
@@ -6264,7 +6260,7 @@ export declare type DropShadowOptions = {
6264
6260
  *
6265
6261
  * @public
6266
6262
  */
6267
- export declare type EditMode = 'Transform' | 'Crop' | 'Text' | 'Playback' | 'Trim' | (string & {});
6263
+ export declare type EditMode = 'Transform' | 'Crop' | 'Text' | 'Playback' | 'Trim' | 'Vector' | (string & {});
6268
6264
 
6269
6265
  /**
6270
6266
  * @public Control the design editor's behavior and settings.
@@ -6326,7 +6322,7 @@ export declare class EditorAPI {
6326
6322
  * ```
6327
6323
  *
6328
6324
  * @category Edit Mode Management
6329
- * @param mode - "Transform", "Crop", "Text", "Playback", "Trim" or a custom value.
6325
+ * @param mode - "Transform", "Crop", "Text", "Playback", "Trim", "Vector" or a custom value.
6330
6326
  * @param baseMode - Optional base mode from which the custom mode will inherit the settings.
6331
6327
  */
6332
6328
  setEditMode(mode: EditMode, baseMode?: string): void;
@@ -6336,7 +6332,7 @@ export declare class EditorAPI {
6336
6332
  * Edit modes represent different tools or interaction states within the editor. Common ones, are "Crop" while the crop tool is shown or "Text" when inline-editing text.
6337
6333
  *
6338
6334
  * @category Edit Mode Management
6339
- * @returns "Transform", "Crop", "Text", "Playback", "Trim" or a custom value.
6335
+ * @returns "Transform", "Crop", "Text", "Playback", "Trim", "Vector" or a custom value.
6340
6336
  */
6341
6337
  getEditMode(): EditMode;
6342
6338
  /**
@@ -6349,13 +6345,110 @@ export declare class EditorAPI {
6349
6345
  * @experimental This API is experimental and may change or be removed in future versions.
6350
6346
  */
6351
6347
  unstable_isInteractionHappening(): boolean;
6348
+ /**
6349
+ * Check whether a vector anchor node is currently selected in vector edit mode.
6350
+ *
6351
+ * @category Vector Edit
6352
+ * @returns True if a vector anchor node is selected.
6353
+ */
6354
+ hasSelectedVectorNode(): boolean;
6355
+ /**
6356
+ * Add a new vertex by splitting the segment after the currently selected vector node.
6357
+ *
6358
+ * @category Vector Edit
6359
+ */
6360
+ addVectorNode(): void;
6361
+ /**
6362
+ * Delete the currently selected vector node from the path.
6363
+ *
6364
+ * @category Vector Edit
6365
+ */
6366
+ deleteVectorNode(): void;
6367
+ /**
6368
+ * Toggle the currently selected vector node between smooth (bezier handles)
6369
+ * and corner (no handles).
6370
+ *
6371
+ * @category Vector Edit
6372
+ */
6373
+ toggleSelectedVectorNodeSmooth(): void;
6374
+ /**
6375
+ * Enable or disable bend mode for vector editing.
6376
+ *
6377
+ * When bend mode is active, clicking an anchor node automatically toggles
6378
+ * it between smooth (bezier handles) and corner (no handles).
6379
+ *
6380
+ * @param active - true to enable bend mode, false to return to normal move mode.
6381
+ * @category Vector Edit
6382
+ */
6383
+ setVectorEditBendMode(active: boolean): void;
6384
+ /**
6385
+ * Check whether vector edit bend mode is currently active.
6386
+ *
6387
+ * @returns true if bend mode is active.
6388
+ * @category Vector Edit
6389
+ */
6390
+ getVectorEditBendMode(): boolean;
6391
+ /**
6392
+ * Enable or disable add mode for vector editing.
6393
+ *
6394
+ * When add mode is active, clicking on a path segment inserts a new anchor
6395
+ * point at the click position. Mutually exclusive with bend and delete modes.
6396
+ *
6397
+ * @param active - true to enable add mode, false to return to normal move mode.
6398
+ * @category Vector Edit
6399
+ */
6400
+ setVectorEditAddMode(active: boolean): void;
6401
+ /**
6402
+ * Check whether vector edit add mode is currently active.
6403
+ *
6404
+ * @returns true if add mode is active.
6405
+ * @category Vector Edit
6406
+ */
6407
+ getVectorEditAddMode(): boolean;
6408
+ /**
6409
+ * Enable or disable delete mode for vector editing.
6410
+ *
6411
+ * When delete mode is active, clicking an anchor node instantly deletes it
6412
+ * from the path. Mutually exclusive with bend and add modes.
6413
+ *
6414
+ * @param active - true to enable delete mode, false to return to normal move mode.
6415
+ * @category Vector Edit
6416
+ */
6417
+ setVectorEditDeleteMode(active: boolean): void;
6418
+ /**
6419
+ * Check whether vector edit delete mode is currently active.
6420
+ *
6421
+ * @returns true if delete mode is active.
6422
+ * @category Vector Edit
6423
+ */
6424
+ getVectorEditDeleteMode(): boolean;
6425
+ /**
6426
+ * Set the bezier handle mirror mode for the currently selected vector node.
6427
+ *
6428
+ * Mirror modes control how the opposite handle behaves when one handle is dragged:
6429
+ * - 0 (None): handles move independently
6430
+ * - 1 (AngleAndLength): the opposite handle mirrors both angle and length
6431
+ * - 2 (AngleOnly): the opposite handle mirrors the angle but keeps its own length
6432
+ *
6433
+ * @param mode - The mirror mode (0, 1, or 2).
6434
+ * @category Vector Edit
6435
+ */
6436
+ setSelectedVectorNodeMirrorMode(mode: number): void;
6437
+ /**
6438
+ * Get the bezier handle mirror mode of the currently selected vector node.
6439
+ *
6440
+ * @returns The mirror mode as a number (0 = None, 1 = AngleAndLength, 2 = AngleOnly).
6441
+ * @throws Error if no node is selected or no vector path is being edited.
6442
+ * @category Vector Edit
6443
+ */
6444
+ getSelectedVectorNodeMirrorMode(): number;
6352
6445
  /**
6353
6446
  * Get the cursor type that should be displayed.
6354
6447
  *
6355
6448
  * @category Edit Mode Management
6356
6449
  * @returns The cursor type.
6357
6450
  */
6358
- getCursorType(): 'Arrow' | 'Move' | 'MoveNotPermitted' | 'Resize' | 'Rotate' | 'Text';
6451
+ getCursorType(): 'Arrow' | 'Move' | 'MoveNotPermitted' | 'Resize' | 'Rotate' | 'Text' | 'Cell';
6359
6452
  /**
6360
6453
  * Get the cursor rotation angle.
6361
6454
  *
@@ -7452,7 +7545,7 @@ declare interface Flip {
7452
7545
  }
7453
7546
 
7454
7547
  /** @public */
7455
- export declare type FloatPropertyName = 'globalBoundingBox/height' | 'globalBoundingBox/width' | 'globalBoundingBox/x' | 'globalBoundingBox/y' | 'height' | 'lastFrame/height' | 'lastFrame/width' | 'lastFrame/x' | 'lastFrame/y' | 'position/x' | 'position/y' | 'rotation' | 'scene/dpi' | 'scene/pageDimensions/height' | 'scene/pageDimensions/width' | 'scene/pixelScaleFactor' | 'width' | 'camera/pixelRatio' | 'camera/resolution/height' | 'camera/resolution/width' | 'camera/zoomLevel' | 'dropShadow/blurRadius/x' | 'dropShadow/blurRadius/y' | 'dropShadow/offset/x' | 'dropShadow/offset/y' | 'page/margin/bottom' | 'page/margin/left' | 'page/margin/right' | 'page/margin/top' | 'playback/speed' | 'playback/volume' | 'stroke/width' | 'opacity' | 'backgroundColor/cornerRadius' | 'backgroundColor/paddingBottom' | 'backgroundColor/paddingLeft' | 'backgroundColor/paddingRight' | 'backgroundColor/paddingTop' | 'text/fontSize' | 'text/letterSpacing' | 'text/lineHeight' | 'text/maxAutomaticFontSize' | 'text/minAutomaticFontSize' | 'text/paragraphSpacing' | 'cutout/offset' | 'cutout/smoothing' | 'caption/fontSize' | 'caption/letterSpacing' | 'caption/lineHeight' | 'caption/maxAutomaticFontSize' | 'caption/minAutomaticFontSize' | 'caption/paragraphSpacing' | 'animation/slide/direction' | 'textAnimationOverlap' | 'animation/pan/direction' | 'animation/pan/distance' | 'animation/blur/intensity' | 'animation/grow/scaleFactor' | 'animation/crop_zoom/scale' | 'animation/spin/intensity' | 'animation/blur_loop/intensity' | 'animation/pulsating_loop/intensity' | 'animation/breathing_loop/intensity' | 'animation/jump_loop/intensity' | 'animation/sway_loop/intensity' | 'animation/scale_loop/startScale' | 'animation/scale_loop/endScale' | 'animation/spread_text/intensity' | 'animation/merge_text/intensity' | 'animation/ken_burns/travelDistanceRatio' | 'animation/ken_burns/zoomIntensity' | 'blur/uniform/intensity' | 'blur/linear/blurRadius' | 'blur/linear/x1' | 'blur/linear/x2' | 'blur/linear/y1' | 'blur/linear/y2' | 'blur/mirrored/blurRadius' | 'blur/mirrored/gradientSize' | 'blur/mirrored/size' | 'blur/mirrored/x1' | 'blur/mirrored/x2' | 'blur/mirrored/y1' | 'blur/mirrored/y2' | 'blur/radial/blurRadius' | 'blur/radial/gradientRadius' | 'blur/radial/radius' | 'blur/radial/x' | 'blur/radial/y' | 'effect/adjustments/blacks' | 'effect/adjustments/brightness' | 'effect/adjustments/clarity' | 'effect/adjustments/contrast' | 'effect/adjustments/exposure' | 'effect/adjustments/gamma' | 'effect/adjustments/highlights' | 'effect/adjustments/saturation' | 'effect/adjustments/shadows' | 'effect/adjustments/sharpness' | 'effect/adjustments/temperature' | 'effect/adjustments/whites' | 'effect/cross_cut/offset' | 'effect/cross_cut/slices' | 'effect/cross_cut/speedV' | 'effect/cross_cut/time' | 'effect/dot_pattern/blur' | 'effect/dot_pattern/dots' | 'effect/dot_pattern/size' | 'effect/duotone_filter/intensity' | 'effect/extrude_blur/amount' | 'effect/glow/amount' | 'effect/glow/darkness' | 'effect/glow/size' | 'effect/green_screen/colorMatch' | 'effect/green_screen/smoothness' | 'effect/green_screen/spill' | 'effect/half_tone/angle' | 'effect/half_tone/scale' | 'effect/linocut/scale' | 'effect/liquid/amount' | 'effect/liquid/scale' | 'effect/liquid/time' | 'effect/lut_filter/intensity' | 'effect/outliner/amount' | 'effect/outliner/passthrough' | 'effect/posterize/levels' | 'effect/radial_pixel/radius' | 'effect/radial_pixel/segments' | 'effect/recolor/brightnessMatch' | 'effect/recolor/colorMatch' | 'effect/recolor/smoothness' | 'effect/shifter/amount' | 'effect/shifter/angle' | 'effect/tilt_shift/amount' | 'effect/tilt_shift/position' | 'effect/tv_glitch/distortion' | 'effect/tv_glitch/distortion2' | 'effect/tv_glitch/rollSpeed' | 'effect/tv_glitch/speed' | 'effect/vignette/darkness' | 'effect/vignette/offset' | 'fill/gradient/linear/endPointX' | 'fill/gradient/linear/endPointY' | 'fill/gradient/linear/startPointX' | 'fill/gradient/linear/startPointY' | 'fill/gradient/radial/centerPointX' | 'fill/gradient/radial/centerPointY' | 'fill/gradient/radial/radius' | 'fill/gradient/conical/centerPointX' | 'fill/gradient/conical/centerPointY' | 'shape/rect/cornerRadiusBL' | 'shape/rect/cornerRadiusBR' | 'shape/rect/cornerRadiusTL' | 'shape/rect/cornerRadiusTR' | 'shape/polygon/cornerRadius' | 'shape/star/innerDiameter' | 'shape/vector_path/height' | 'shape/vector_path/width' | (string & {});
7548
+ export declare type FloatPropertyName = 'globalBoundingBox/height' | 'globalBoundingBox/width' | 'globalBoundingBox/x' | 'globalBoundingBox/y' | 'height' | 'lastFrame/height' | 'lastFrame/width' | 'lastFrame/x' | 'lastFrame/y' | 'position/x' | 'position/y' | 'rotation' | 'scene/dpi' | 'scene/pageDimensions/height' | 'scene/pageDimensions/width' | 'scene/pixelScaleFactor' | 'width' | 'camera/pixelRatio' | 'camera/resolution/height' | 'camera/resolution/width' | 'camera/zoomLevel' | 'dropShadow/blurRadius/x' | 'dropShadow/blurRadius/y' | 'dropShadow/offset/x' | 'dropShadow/offset/y' | 'page/margin/bottom' | 'page/margin/left' | 'page/margin/right' | 'page/margin/top' | 'playback/speed' | 'playback/volume' | 'stroke/width' | 'opacity' | 'backgroundColor/cornerRadius' | 'backgroundColor/paddingBottom' | 'backgroundColor/paddingLeft' | 'backgroundColor/paddingRight' | 'backgroundColor/paddingTop' | 'text/fontSize' | 'text/letterSpacing' | 'text/lineHeight' | 'text/maxAutomaticFontSize' | 'text/minAutomaticFontSize' | 'text/paragraphSpacing' | 'cutout/offset' | 'cutout/smoothing' | 'caption/fontSize' | 'caption/letterSpacing' | 'caption/lineHeight' | 'caption/maxAutomaticFontSize' | 'caption/minAutomaticFontSize' | 'caption/paragraphSpacing' | 'animation/slide/direction' | 'textAnimationOverlap' | 'animation/pan/direction' | 'animation/pan/distance' | 'animation/blur/intensity' | 'animation/grow/scaleFactor' | 'animation/crop_zoom/scale' | 'animation/spin/intensity' | 'animation/blur_loop/intensity' | 'animation/pulsating_loop/intensity' | 'animation/breathing_loop/intensity' | 'animation/jump_loop/intensity' | 'animation/sway_loop/intensity' | 'animation/scale_loop/startScale' | 'animation/scale_loop/endScale' | 'animation/spread_text/intensity' | 'animation/merge_text/intensity' | 'animation/ken_burns/travelDistanceRatio' | 'animation/ken_burns/zoomIntensity' | 'blur/uniform/intensity' | 'blur/linear/blurRadius' | 'blur/linear/x1' | 'blur/linear/x2' | 'blur/linear/y1' | 'blur/linear/y2' | 'blur/mirrored/blurRadius' | 'blur/mirrored/gradientSize' | 'blur/mirrored/size' | 'blur/mirrored/x1' | 'blur/mirrored/x2' | 'blur/mirrored/y1' | 'blur/mirrored/y2' | 'blur/radial/blurRadius' | 'blur/radial/gradientRadius' | 'blur/radial/radius' | 'blur/radial/x' | 'blur/radial/y' | 'effect/adjustments/blacks' | 'effect/adjustments/brightness' | 'effect/adjustments/clarity' | 'effect/adjustments/contrast' | 'effect/adjustments/exposure' | 'effect/adjustments/gamma' | 'effect/adjustments/highlights' | 'effect/adjustments/saturation' | 'effect/adjustments/shadows' | 'effect/adjustments/sharpness' | 'effect/adjustments/temperature' | 'effect/adjustments/whites' | 'effect/cross_cut/offset' | 'effect/cross_cut/slices' | 'effect/cross_cut/speedV' | 'effect/cross_cut/time' | 'effect/dot_pattern/blur' | 'effect/dot_pattern/dots' | 'effect/dot_pattern/size' | 'effect/duotone_filter/intensity' | 'effect/extrude_blur/amount' | 'effect/glow/amount' | 'effect/glow/darkness' | 'effect/glow/size' | 'effect/green_screen/colorMatch' | 'effect/green_screen/smoothness' | 'effect/green_screen/spill' | 'effect/half_tone/angle' | 'effect/half_tone/scale' | 'effect/linocut/scale' | 'effect/liquid/amount' | 'effect/liquid/scale' | 'effect/liquid/time' | 'effect/lut_filter/intensity' | 'effect/outliner/amount' | 'effect/outliner/passthrough' | 'effect/posterize/levels' | 'effect/radial_pixel/radius' | 'effect/radial_pixel/segments' | 'effect/recolor/brightnessMatch' | 'effect/recolor/colorMatch' | 'effect/recolor/smoothness' | 'effect/shifter/amount' | 'effect/shifter/angle' | 'effect/tilt_shift/amount' | 'effect/tilt_shift/position' | 'effect/tv_glitch/distortion' | 'effect/tv_glitch/distortion2' | 'effect/tv_glitch/rollSpeed' | 'effect/tv_glitch/speed' | 'effect/vignette/darkness' | 'effect/vignette/offset' | 'fill/gradient/linear/endPointX' | 'fill/gradient/linear/endPointY' | 'fill/gradient/linear/startPointX' | 'fill/gradient/linear/startPointY' | 'fill/gradient/radial/centerPointX' | 'fill/gradient/radial/centerPointY' | 'fill/gradient/radial/radius' | 'fill/gradient/conical/centerPointX' | 'fill/gradient/conical/centerPointY' | 'shape/rect/cornerRadiusBL' | 'shape/rect/cornerRadiusBR' | 'shape/rect/cornerRadiusTL' | 'shape/rect/cornerRadiusTR' | 'shape/polygon/cornerRadius' | 'shape/star/innerDiameter' | 'shape/vector_path/cornerRadius' | 'shape/vector_path/height' | 'shape/vector_path/width' | (string & {});
7456
7549
 
7457
7550
  /**
7458
7551
  * Represents a font.
@@ -8082,6 +8175,8 @@ export declare class SceneAPI {
8082
8175
  /**
8083
8176
  * Create a new scene in video mode, along with its own camera.
8084
8177
  *
8178
+ * @deprecated Scene mode no longer affects engine behavior. Use `create()` followed by `setMode('Video')` instead.
8179
+ *
8085
8180
  * ```javascript
8086
8181
  * const scene = engine.scene.createVideo();
8087
8182
  * ```
@@ -8172,19 +8267,20 @@ export declare class SceneAPI {
8172
8267
  /**
8173
8268
  * Get the current scene mode.
8174
8269
  *
8270
+ * @deprecated Scene mode no longer affects engine behavior. All features work regardless of mode.
8271
+ *
8175
8272
  * ```javascript
8176
8273
  * const mode = scene.getMode();
8177
8274
  * ```
8178
8275
  *
8179
8276
  * @category Scene Properties
8180
- * @returns The current mode of the scene.
8277
+ * @returns The current mode of the scene, or null if no mode has been set.
8181
8278
  */
8182
- getMode(): SceneMode;
8279
+ getMode(): SceneMode | null;
8183
8280
  /**
8184
8281
  * Set the mode of the scene.
8185
- * Changing the scene mode affects how the engine processes and renders the scene:
8186
- * - Video mode enables timeline-based playback, animations, and audio processing.
8187
- * - Design mode disables playback-related features and uses different color space settings.
8282
+ *
8283
+ * @deprecated Scene mode no longer affects engine behavior. All features work regardless of mode.
8188
8284
  *
8189
8285
  * ```javascript
8190
8286
  * engine.scene.setMode('Video');
@@ -8567,10 +8663,10 @@ export declare type SceneLayout = (typeof SceneLayoutValues)[number];
8567
8663
  /** @public */
8568
8664
  export declare const SceneLayoutValues: readonly ["Free", "VerticalStack", "HorizontalStack", "DepthStack"];
8569
8665
 
8570
- /** @public */
8666
+ /** @public @deprecated Since v1.72. Scene mode no longer affects engine behavior. */
8571
8667
  export declare type SceneMode = (typeof SceneModeValues)[number];
8572
8668
 
8573
- /** @public */
8669
+ /** @public @deprecated Since v1.72. Scene mode no longer affects engine behavior. */
8574
8670
  export declare const SceneModeValues: readonly ["Design", "Video"];
8575
8671
 
8576
8672
  /**
@@ -8591,10 +8687,10 @@ export declare const SceneModeValues: readonly ["Design", "Video"];
8591
8687
  export declare type Scope = 'text/edit' | 'text/character' | 'fill/change' | 'fill/changeType' | 'stroke/change' | 'shape/change' | 'layer/move' | 'layer/resize' | 'layer/rotate' | 'layer/flip' | 'layer/crop' | 'layer/opacity' | 'layer/blendMode' | 'layer/visibility' | 'layer/clipping' | 'appearance/adjustments' | 'appearance/filter' | 'appearance/effect' | 'appearance/blur' | 'appearance/shadow' | 'appearance/animation' | 'lifecycle/destroy' | 'lifecycle/duplicate' | 'editor/add' | 'editor/select';
8592
8688
 
8593
8689
  /** @public */
8594
- export declare type SettingBoolPropertyName = 'alwaysHighlightPlaceholders' | 'doubleClickToCropEnabled' | 'showBuildVersion' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'renderTextCursorAndSelectionInEngine' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'mouse/enableZoom' | 'mouse/enableScroll' | 'controlGizmo/showCropHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showScaleHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showCropScaleHandles' | 'page/title/canEdit' | 'page/title/show' | 'page/title/showPageTitleTemplate' | 'page/title/appendPageName' | 'page/title/showOnSinglePage' | 'page/dimOutOfPageAreas' | 'page/allowCropInteraction' | 'page/allowResizeInteraction' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/allowRotateInteraction' | 'page/allowMoveInteraction' | 'page/moveChildrenWhenCroppingFill' | 'page/selectWhenNoBlocksSelected' | 'page/highlightWhenCropping' | 'page/highlightDropTarget' | 'page/reparentBlocksToSceneWhenOutOfPage' | 'page/clipped' | 'colorMaskingSettings/secondPass' | 'clampThumbnailTextureSizes' | 'useSystemFontFallback' | 'forceSystemEmojis' | 'features/textEditModeTransformHandlesEnabled' | 'features/videoStreamingEnabled' | 'features/enableAutomaticEnumerations' | (string & {});
8690
+ export declare type SettingBoolPropertyName = 'alwaysHighlightPlaceholders' | 'doubleClickToCropEnabled' | 'showBuildVersion' | 'placeholderControls/showButton' | 'placeholderControls/showOverlay' | 'blockAnimations/enabled' | 'renderTextCursorAndSelectionInEngine' | 'touch/dragStartCanSelect' | 'touch/singlePointPanning' | 'mouse/enableZoom' | 'mouse/enableScroll' | 'controlGizmo/showCropHandles' | 'controlGizmo/showMoveHandles' | 'controlGizmo/showResizeHandles' | 'controlGizmo/showScaleHandles' | 'controlGizmo/showRotateHandles' | 'controlGizmo/showCropScaleHandles' | 'page/title/canEdit' | 'page/title/show' | 'page/title/showPageTitleTemplate' | 'page/title/appendPageName' | 'page/title/showOnSinglePage' | 'page/dimOutOfPageAreas' | 'page/allowCropInteraction' | 'page/allowResizeInteraction' | 'page/restrictResizeInteractionToFixedAspectRatio' | 'page/allowRotateInteraction' | 'page/allowMoveInteraction' | 'page/moveChildrenWhenCroppingFill' | 'page/selectWhenNoBlocksSelected' | 'page/highlightWhenCropping' | 'page/highlightDropTarget' | 'page/reparentBlocksToSceneWhenOutOfPage' | 'colorMaskingSettings/secondPass' | 'clampThumbnailTextureSizes' | 'useSystemFontFallback' | 'forceSystemEmojis' | 'features/textEditModeTransformHandlesEnabled' | 'features/videoStreamingEnabled' | 'grid/enabled' | 'grid/snapEnabled' | 'features/enableAutomaticEnumerations' | (string & {});
8595
8691
 
8596
8692
  /** @public */
8597
- export declare type SettingColorPropertyName = 'clearColor' | 'handleFillColor' | 'highlightColor' | 'pageHighlightColor' | 'placeholderHighlightColor' | 'snappingGuideColor' | 'rotationSnappingGuideColor' | 'cropOverlayColor' | 'textVariableHighlightColor' | 'borderOutlineColor' | 'progressColor' | 'errorStateColor' | 'page/title/color' | 'page/marginFillColor' | 'page/marginFrameColor' | 'page/innerBorderColor' | 'page/outerBorderColor' | 'colorMaskingSettings/maskColor' | (string & {});
8693
+ export declare type SettingColorPropertyName = 'clearColor' | 'handleFillColor' | 'highlightColor' | 'pageHighlightColor' | 'placeholderHighlightColor' | 'snappingGuideColor' | 'rotationSnappingGuideColor' | 'cropOverlayColor' | 'textVariableHighlightColor' | 'borderOutlineColor' | 'progressColor' | 'errorStateColor' | 'page/title/color' | 'page/marginFillColor' | 'page/marginFrameColor' | 'page/innerBorderColor' | 'page/outerBorderColor' | 'colorMaskingSettings/maskColor' | 'grid/color' | (string & {});
8598
8694
 
8599
8695
  /** @public */
8600
8696
  export declare type SettingEnumPropertyName = 'touch/pinchAction' | 'touch/rotateAction' | 'camera/clamping/overshootMode' | 'doubleClickSelectionMode' | 'colorPicker/colorMode' | 'timeline/trackVisibility' | (string & {});
@@ -8613,7 +8709,7 @@ export declare type SettingEnumType = {
8613
8709
  export declare type SettingEnumValues = TouchPinchAction | TouchRotateAction | CameraClampingOvershootMode | DoubleClickSelectionMode | ColorPickerColorMode | TimelineTrackVisibility | (string & {});
8614
8710
 
8615
8711
  /** @public */
8616
- export declare type SettingFloatPropertyName = 'positionSnappingThreshold' | 'rotationSnappingThreshold' | 'controlGizmo/blockScaleDownLimit' | 'listIndentPerLevel' | (string & {});
8712
+ export declare type SettingFloatPropertyName = 'positionSnappingThreshold' | 'rotationSnappingThreshold' | 'controlGizmo/blockScaleDownLimit' | 'listIndentPerLevel' | 'grid/spacingX' | 'grid/spacingY' | (string & {});
8617
8713
 
8618
8714
  /** @public */
8619
8715
  export declare type SettingIntPropertyName = 'maxImageSize' | 'maxPreviewResolution' | (string & {});
@@ -8699,6 +8795,10 @@ export declare interface Settings {
8699
8795
  'placeholderControls/showOverlay': boolean;
8700
8796
  /** Whether animations should be enabled or not. */
8701
8797
  'blockAnimations/enabled': boolean;
8798
+ /** Whether the background grid is shown on pages. */
8799
+ 'grid/enabled': boolean;
8800
+ /** Whether elements should snap to grid lines when dragged. */
8801
+ 'grid/snapEnabled': boolean;
8702
8802
  /** Whether to display the build version in the UI. */
8703
8803
  showBuildVersion: boolean;
8704
8804
  /** Whether drag start can select elements. */
@@ -8718,9 +8818,6 @@ export declare interface Settings {
8718
8818
  /** Whether blocks should be reparented to the scene when dragged outside all pages,
8719
8819
  * and reparented back to a page when dragged over one. */
8720
8820
  'page/reparentBlocksToSceneWhenOutOfPage': boolean;
8721
- /** Whether pages should clip their contents to their bounds.
8722
- * Applies to newly created pages and, when changed, immediately updates all existing pages. */
8723
- 'page/clipped': boolean;
8724
8821
  /** Clamp thumbnail texture sizes to the platform's GPU texture limit. */
8725
8822
  clampThumbnailTextureSizes: boolean;
8726
8823
  /** Toggle the dock components visibility */
@@ -8759,6 +8856,10 @@ export declare interface Settings {
8759
8856
  positionSnappingThreshold: number;
8760
8857
  /** The threshold angle in degrees for rotation snapping. */
8761
8858
  rotationSnappingThreshold: number;
8859
+ /** Horizontal spacing between vertical grid lines in design units. */
8860
+ 'grid/spacingX': number;
8861
+ /** Vertical spacing between horizontal grid lines in design units. */
8862
+ 'grid/spacingY': number;
8762
8863
  /** The maximum size (width or height) in pixels for images. */
8763
8864
  maxImageSize: number;
8764
8865
  /** The maximum dimension (width or height) in physical pixels for preview rendering.
@@ -8803,6 +8904,8 @@ export declare interface Settings {
8803
8904
  textVariableHighlightColor: Color;
8804
8905
  /** The fill color for handles. */
8805
8906
  handleFillColor: Color;
8907
+ /** Color of the grid lines. */
8908
+ 'grid/color': Color;
8806
8909
  /** The selection mode for double-click: Direct selects the clicked element, Hierarchical traverses the hierarchy. */
8807
8910
  doubleClickSelectionMode: 'Direct' | 'Hierarchical';
8808
8911
  /** The action performed for pinch gestures: None, Zoom, Scale, or Auto. */