Pages

Although the editor can manage a collection of pages with varying dimensions, our interfaces are presently designed to maintain a consistent dimension across all pages. Consequently, loading scenes with pages of different dimensions may lead to unexpected behavior, and the editor might adjust your scene accordingly.

Page Type#

A block representing a page within a scene.

This section describes the properties available for the Page Type (//ly.img.ubq/page) block type.

Property	Type	Default Value	Description
alwaysOnBottom	Bool	false	If true, this element’s global sorting order is automatically adjusted to be lower than all other siblings.
alwaysOnTop	Bool	false	If true, this element’s global sorting order is automatically adjusted to be higher than all other siblings.
blend/mode	Enum	"Normal"	The blend mode to use when compositing the block., Possible values: "PassThrough", "Normal", "Darken", "Multiply", "ColorBurn", "LinearBurn", "DarkenColor", "Lighten", "Screen", "ColorDodge", "LinearDodge", "LightenColor", "Overlay", "SoftLight", "HardLight", "VividLight", "LinearLight", "PinLight", "HardMix", "Difference", "Exclusion", "Subtract", "Divide", "Hue", "Saturation", "Color", "Luminosity"
blur/enabled	Bool	true	Whether the blur should be enabled or not.
clipped	Bool	false	This component is used to identify elements whose contents and children should be clipped to their bounds.
contentFill/mode	Enum	"Cover"	Defines how content should be resized to fit its container (e.g., Cover, Contain, Stretch)., Possible values: "Crop", "Cover", "Contain"
dropShadow/blurRadius/x	Float	1	The horizontal blur radius of the drop shadow.
dropShadow/blurRadius/y	Float	1	The vertical blur radius of the drop shadow.
dropShadow/clip	Bool	false	Whether the drop shadow should be clipped to the block’s bounds.
dropShadow/color	Color	{"r":0,"g":0,"b":0,"a":0.25}	The color of the drop shadow.
dropShadow/enabled	Bool	false	Whether the drop shadow is enabled.
dropShadow/offset/x	Float	1.76777	The horizontal offset of the drop shadow.
dropShadow/offset/y	Float	1.76777	The vertical offset of the drop shadow.
fill/enabled	Bool	true	Whether the fill should be rendered or not.
fill/solid/color	Color	"-"	The fill color.
flip/horizontal	Bool	"-"	Whether the block is flipped horizontally.
flip/vertical	Bool	"-"	Whether the block is flipped vertically.
globalBoundingBox/height	Float	"-"	The height of the block’s axis-aligned bounding box in world coordinates., (read-only)
globalBoundingBox/width	Float	"-"	The width of the block’s axis-aligned bounding box in world coordinates., (read-only)
globalBoundingBox/x	Float	"-"	The x-coordinate of the block’s axis-aligned bounding box in world coordinates., (read-only)
globalBoundingBox/y	Float	"-"	The y-coordinate of the block’s axis-aligned bounding box in world coordinates., (read-only)
height	Float	100	The height of the block’s frame.
height/mode	Enum	"Absolute"	A mode describing how the height dimension may be interpreted (Undefined, Exactly, AtMost)., Possible values: "Absolute", "Percent", "Auto"
highlightEnabled	Bool	true	Show highlighting when selected or hovered
lastFrame/height	Float	"-"	The height of the block’s frame from the previous layout pass., (read-only)
lastFrame/width	Float	"-"	The width of the block’s frame from the previous layout pass., (read-only)
lastFrame/x	Float	"-"	The x-coordinate of the block’s frame from the previous layout pass., (read-only)
lastFrame/y	Float	"-"	The y-coordinate of the block’s frame from the previous layout pass., (read-only)
page/margin/bottom	Float	10	The bottom page margin in local coordinates.
page/margin/left	Float	10	The left page margin in local coordinates.
page/margin/right	Float	10	The right page margin in local coordinates.
page/margin/top	Float	10	The top page margin in local coordinates.
page/marginEnabled	Bool	false	Whether the bleed margin should be applied.
page/titleTemplate	String	"Page {{ubq.page_index}}"	Page title label template. Can include custom text and template variables like {{ubq.page_index}}.
placeholder/enabled	Bool	false	Whether the placeholder behavior is enabled or not.
placeholderControls/showButton	Bool	false	Show the placeholder button.
placeholderControls/showOverlay	Bool	false	Show the overlay pattern.
playback/duration	Double	5	The duration in seconds for which this block should be visible.
playback/looping	Bool	true	Whether the medium should start from the beginning again or should stop.
playback/muted	Bool	false	Whether the audio is muted.
playback/playing	Bool	false	A tag that can be set on elements for their playback time to be progressed.
playback/soloPlaybackEnabled	Bool	false	A tag for blocks where playback should progress while the scene is paused.
playback/speed	Float	1	The playback speed multiplier.
playback/time	Double	0	The current playback time of the block contents in seconds.
playback/volume	Float	1	Audio volume with a range of [0, 1].
position/x	Float	0	The x-coordinate of the block’s origin.
position/x/mode	Enum	"Absolute"	A mode describing how the x-position may be interpreted., Possible values: "Absolute", "Percent", "Auto"
position/y	Float	0	The y-coordinate of the block’s origin.
position/y/mode	Enum	"Absolute"	A mode describing how the y-position may be interpreted., Possible values: "Absolute", "Percent", "Auto"
rotation	Float	0	The rotation of the block in degrees.
selected	Bool	false	Indicates if the block is currently selected.
selectionEnabled	Bool	true	Whether the block can be selected in the editor.
stroke/color	Color	{"r":0.67,"g":0.67,"b":0.67,"a":1}	The color of the stroke.
stroke/cornerGeometry	Enum	"Miter"	The geometry of the stroke at corners (e.g., Miter, Round, Bevel)., Possible values: "Bevel", "Miter", "Round"
stroke/enabled	Bool	false	Whether the stroke is enabled.
stroke/position	Enum	"Center"	The position of the stroke relative to the shape’s edge (Inside, Center, Outside)., Possible values: "Center", "Inner", "Outer"
stroke/style	Enum	"Solid"	The style of the stroke (e.g., Solid, Dotted, Dashed)., Possible values: "Dashed", "DashedRound", "Dotted", "LongDashed", "LongDashedRound", "Solid"
stroke/width	Float	9.44882	The width of the stroke.
transformLocked	Bool	false	DesignBlocks with this tag can’t be transformed (moved, rotated, scaled, cropped, or flipped).
visible	Bool	true	If the block is visible in the editor.
width	Float	100	The width of the block’s frame.
width/mode	Enum	"Absolute"	A mode describing how the width dimension may be interpreted (Undefined, Exactly, AtMost)., Possible values: "Absolute", "Percent", "Auto"