CESDK/CE.SDK/Engine/API Reference/Block

Types

Get to know all available block types and their properties

The following tables document the currently available blocks and their properties.

Block properties#

`animation/baseline`#

Member	Type	Default	Description
Member direction	Type `BaselineAnimationDirection`	Default `Right`	Description The direction of the wipe animation.

`animation/blur`#

Member	Type	Default	Description
Member intensity	Type `float`	Default `1.`	Description The maximum intensity of the blur.

`animation/blur_loop`#

Member	Type	Default	Description
Member intensity	Type `float`	Default `1.0`	Description The maximum blur intensity of this effect.

`animation/breathing_loop`#

Member	Type	Default	Description
Member intensity	Type `float`	Default `0.0`	Description Controls the intensity of the scaling. A value of 0 results in a maximum scale of 1.25. A value of 1 results in a maximum scale of 2.5.

`animation/crop_zoom`#

Member	Type	Default	Description
Member scale	Type `float`	Default `1.25`	Description The maximum crop scale value.

`animation/fade`#

No block-specific properties.

`animation/fade_loop`#

No block-specific properties.

`animation/grow`#

Member	Type	Default	Description
Member direction	Type `GrowAnimationDirection`	Default `All`	Description Whether the grow animation should be applied to the width or height or both.

`animation/jump_loop`#

Member	Type	Default	Description
Member direction	Type `JumpLoopAnimationDirection`	Default `Up`	Description The direction of the jump animation.
Member intensity	Type `float`	Default `0.5`	Description Controls how far the block should move. The value is a percentage of the block's width or height (depending on the movement direction).

`animation/pan`#

Member	Type	Default	Description
Member direction	Type `float`	Default `0.0`	Description The movement direction of the animation in radians.
Member distance	Type `float`	Default `0.1`	Description The movement distance relative to the longer side of the page.
Member fade	Type `bool`	Default `true`	Description Whether an opacity fade animation should be applied during the pan animation.

`animation/pop`#

No block-specific properties.

`animation/pulsating_loop`#

Member	Type	Default	Description
Member intensity	Type `float`	Default `0.0`	Description Controls the intensity of the pulsating effect. A value of 0 results in a maximum scale of 1.25. A value of 1 results in a maximum scale of 2.5.

`animation/slide`#

Member	Type	Default	Description
Member direction	Type `float`	Default `0.0`	Description The movement direction angle of the slide animation in radians.

`animation/spin`#

Member	Type	Default	Description
Member direction	Type `SpinAnimationDirection`	Default `Clockwise`	Description The direction of the spin animation.
Member fade	Type `bool`	Default `true`	Description Whether an opacity fade animation should be applied during the pan animation.
Member intensity	Type `float`	Default `1.0`	Description How far the animation should spin the block. 1.0 is a full rotation (360°).

`animation/spin_loop`#

Member	Type	Default	Description
Member direction	Type `SpinAnimationDirection`	Default `Clockwise`	Description The direction of the spin animation.

`animation/squeeze_loop`#

No block-specific properties.

`animation/sway_loop`#

Member	Type	Default	Description
Member intensity	Type `float`	Default `1.0`	Description The intensity of the animation. Defines the maximum sway angle between 15° and 45°.

`animation/wipe`#

Member	Type	Default	Description
Member direction	Type `WipeAnimationDirection`	Default `Right`	Description The direction of the wipe animation.

`animation/zoom`#

Member	Type	Default	Description
Member fade	Type `bool`	Default `true`	Description Whether an opacity fade animation should be applied during the pan animation.

`audio`#

Member	Type	Default	Description
Member fileURI	Type `string`	Default `""`	Description A URI referencing an audio file.

`cutout`#

Member	Type	Default	Description
Member offset	Type `float`	Default `0.0`	Description The offset from path at which to draw the cutout line.
Member path	Type `string`	Default `""`	Description The path string, accepts a subset of SVG path strings.
Member smoothing	Type `float`	Default `0.0`	Description Pixel threshold by which to round out the path's corners.
Member type	Type `CutoutType`	Default `Default`	Description The type of cutout line.

`graphic`#

No block-specific properties.

`group`#

No block-specific properties.

`metrics`#

No block-specific properties.

`page`#

Member	Type	Default	Description
Member margin	Type `OuterMargin2D(float left, float top, float right, float bottom)`	Default `OuterMargin2D(10.0)`	Description Left, up, right, down page margins in local coordinates.
Member marginEnabled	Type `bool`	Default `false`	Description Whether the bleed margin should be applied.
Member titleTemplate	Type `string`	Default `string("Page {{ubq.page_index}}")`	Description Page title label template. Can include custom text and/or these template variables: `{{ubq.page_index}}`, `{{ubq.separator}}`, and `{{ubq.name}}`. The separator is automatically extended with spaces.

`stack`#

A convenience block, that overrides its childrens position and sorting order to bring them all in a single line along its axis. An optional spacing allows evenly spacing the items via additional elements. The stack relies on our layouting defaults: flex wrap: no wrap, align content: flex start, and align items: stretch

Member	Type	Default	Description
Member axis	Type `uint enum : {'Horizontal', 'Vertical', 'Depth'}`	Default `Horizontal`	Description The direction of the main stack axis, either horizontal or vertical.
Member spacing	Type `float`	Default `0.`	Description Adds an explicit spacing between the stacks children. This is only added between the "inner" children & doesn't add spacing towards the stacks outer edges. Negative spacing is not supported.
Member spacingInScreenspace	Type `bool`	Default `true`	Description Whether to interpret the spacing value as pixels in screen space instead of design units. During export, the spacing is always interpreted in design units.

`text`#

Member	Type	Default	Description
Member automaticFontSizeEnabled	Type `bool`	Default `false`	Description Whether the font size should be automatically determined to fit the entire text within the block's frame.
Member clipLinesOutsideOfFrame	Type `bool`	Default `true`	Description Whether or not to display lines outside the frame.
Member externalReference	Type `string`	Default `""`	Description An external reference that may hint at the source that was used to populate `fontFileURI`
Member fontFileUri	Type `string`	Default `{}`	Description The URI of a font file.
Member fontSize	Type `float`	Default `10.`	Description The font size in points.
Member horizontalAlignment	Type `uint enum : {'Left', 'Right', 'Center'}`	Default `Left`	Description The horizontal text alignment.
Member letterSpacing	Type `float`	Default `0.0`	Description Relative to the original spacing.
Member lineHeight	Type `float`	Default `1.0`	Description The line height relative to the font size.
Member maxAutomaticFontSize	Type `float`	Default `-1`	Description The upper font size limit if the font size is automatically calculated.
Member minAutomaticFontSize	Type `float`	Default `-1`	Description The lower font size limit if the font size is automatically calculated.
Member paragraphSpacing	Type `float`	Default `0.0`	Description The additional spacing between paragraphs relative to the font size.
Member text	Type `string`	Default `""`	Description The text content.
Member typeface	Type `string`	Default `""`	Description The typeface of the font.
Member verticalAlignment	Type `uint enum : {'Top', 'Bottom', 'Center'}`	Default `Top`	Description The vertical text alignment.

`track`#

Member	Type	Default	Description
Member automaticallyManageBlockOffsets	Type `bool`	Default `true`	Description Whether the track should automatically remove gaps between its child blocks.

`scene`#

Member	Type	Default	Description
Member aspectRatioLock	Type `bool`	Default `true`	Description Wether the ratio of the pageDimensions' width and height should remain constant when changing either dimension. Example: A page of 400x300 with aspect ratio lock ON should be resized to 800x600 when the user sets its width to 800, to maintain the aspect ratio of 4/3.
Member designUnit	Type `DesignUnit`	Default `Pixel`	Description The unit type in which the page values (size, distances, etc.) are defined.
Member dpi	Type `float`	Default `300.`	Description The DPI value to use when exporting and when converting between pixels and inches or millimeter units. For all of our purposes, this is synonymous with PPI.
Member layout	Type `SceneLayout`	Default `Free`	Description A value describing how the scenes children are laid out.
Member mode	Type `SceneMode`	Default `Design`	Description The mode of this scene and all elements inside of it.
Member pageDimensions	Type `Size2(float width, float height)`	Default `Size2(1, 1)`	Description The dimension of all pages in this scene.
Member pageFormatId	Type `string`	Default `""`	Description The identifier of the page format configuration that was most recently selected for the pages in this scene.
Member pixelScaleFactor	Type `float`	Default `1.`	Description A scale factor that is applied to the final export resolution if the design unit is Pixel.

Types

Block properties#

animation/baseline#

animation/blur#

animation/blur_loop#

animation/breathing_loop#

animation/crop_zoom#

animation/fade#

animation/fade_loop#

animation/grow#

animation/jump_loop#

animation/pan#

animation/pop#

animation/pulsating_loop#

animation/slide#

animation/spin#

animation/spin_loop#

animation/squeeze_loop#

animation/sway_loop#

animation/wipe#

animation/zoom#

audio#

cutout#

graphic#

group#

metrics#

page#

stack#

text#

track#

scene#

`animation/baseline`#

`animation/blur`#

`animation/blur_loop`#

`animation/breathing_loop`#

`animation/crop_zoom`#

`animation/fade`#

`animation/fade_loop`#

`animation/grow`#

`animation/jump_loop`#

`animation/pan`#

`animation/pop`#

`animation/pulsating_loop`#

`animation/slide`#

`animation/spin`#

`animation/spin_loop`#

`animation/squeeze_loop`#

`animation/sway_loop`#

`animation/wipe`#

`animation/zoom`#

`audio`#

`cutout`#

`graphic`#

`group`#

`metrics`#

`page`#

`stack`#

`text`#

`track`#

`scene`#