This method will create a new child layout (a new layout is always child of a root / parent)
id of new layout
the id of a specific layout, being the parent
This method will duplicate a specific layout
id of specific layout
the id of a specific layout
This method returns the list of layouts
list of all layouts
This method returns a layout by its id
layout properties
the id of a specific layout
This method returns a layout by its name
layout properties
the name of a specific layout
This method returns the selected layout
layout properties
This method will remove a specific layout
the id of a specific layout
This method will update the name of a specific layout
the id of a specific layout
the new name that the layout should receive
This method will reset a specific layout to its original value
the id of a specific layout
This method will reset the bleed values on the specified layout to its original (inherited) value. Note: Calling this on the top layout is not valid.
The id of the (child) layout to reset the bleed values for
This method resets the fill color of a specific layout to its original (inherited) value. Note: Calling this on the top layout is not valid
The id of the (child) layout to reset the fill color for
This method will reset the height of a specific layout to its original value
the id of a specific layout
This method resets the intent of a specific layout to its original (inherited) value. Note: Calling this on the top layout is not valid
The id of the (child) layout to reset the intent for
This method will reset the unit of a specific layout to its original (inherited) value
the id of a specific layout
This method will reset the width of a specific layout to its original value
the id of a specific layout
This method will select a specific layout
the id of a specific layout
This method sets the combined state of the bleed values. Note: this is only valid on a print layout
The id of the specific layout
Whether the bleed values are combined
This method sets the bleed value of a specific layout. Note: this is only valid on a print layout
The id of the specific layout
The bleed value
Optional position: PositionEnumWhen defined will update the bleed value of a single position,
otherwise will set all positions to the same value. Depending on this parameter
being defined, the areBleedValuesCombined will also be updated.
This method sets the fill color of a specific layout. Note: Depending on the layout intent, some colors might not be valid (eg opacity for digitalAnimated, any color for print)
the id of a specific layout
the color that will be used for the layout
This is a convenience method to enable or disable the fill color of a specific layout. Note: Depending on the layout intent, disabling might not be valid (eg disabling for digitalAnimated)
the id of a specific layout
whether the fill color should be enabled or disabled
This method will set the height of the layout to a specific value
the id of a specific layout
the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
This method sets the intent of a specific layout. Note that setting the intent for a layout can have side-effects such as updating the measurement unit
the id of a specific layout
the intent that will be used for the layout
This method will set the unit of the layout to a specific value
The id of a specific layout
the unit that will be used for the layout. All values in this layout will now be reported in this unit
This method will set the width of the layout to a specific value
the id of a specific layout
the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
Generated using TypeDoc
The LayoutController is responsible for all communication regarding Layouts. Methods inside this controller can be called by
window.SDK.layout.{method-name}