Class LayoutController

The LayoutController is responsible for all communication regarding Layouts. Methods inside this controller can be called by window.SDK.layout.{method-name}

Hierarchy

LayoutController

Methods

create

create(parentId: string, presets?: LayoutPreset[]): Promise<EditorResponse<string>>
This method will create a new child layout (a new layout is always child of a root / parent)

Returns
id of new layout
Parameters
- parentId: string
  
  the id of a specific layout, being the parent
- Optional presets: LayoutPreset[]
Returns Promise<EditorResponse<string>>
- Defined in src/controllers/LayoutController.ts:86

duplicate

duplicate(id: string): Promise<EditorResponse<string>>
This method will duplicate a specific layout

Returns
id of specific layout
Parameters
- id: string
  
  the id of a specific layout
Returns Promise<EditorResponse<string>>
- Defined in src/controllers/LayoutController.ts:124

getAll

getAll(): Promise<EditorResponse<Layout[]>>
This method returns the list of layouts

Returns
list of all layouts

Returns Promise<EditorResponse<Layout[]>>
- Defined in src/controllers/LayoutController.ts:37

getById

getById(id: string): Promise<EditorResponse<Layout>>
This method returns a layout by its id

Returns
layout properties
Parameters
- id: string
  
  the id of a specific layout
Returns Promise<EditorResponse<Layout>>
- Defined in src/controllers/LayoutController.ts:47

getByName

getByName(name: string): Promise<EditorResponse<Layout>>
This method returns a layout by its name

Returns
layout properties
Parameters
- name: string
  
  the name of a specific layout
Returns Promise<EditorResponse<Layout>>
- Defined in src/controllers/LayoutController.ts:57

getSelected

getSelected(): Promise<EditorResponse<Layout>>
This method returns the selected layout

Returns
layout properties

Returns Promise<EditorResponse<Layout>>
- Defined in src/controllers/LayoutController.ts:66

getSelectedSnapshot

getSelectedSnapshot(): Promise<Uint8Array>
Deprecated
This method returns a UInt8Array containing a PNG encoded image of the currently selected layout. This method is deprecated, please use getSnapshot in the PageController

Returns
UInt8Array snapshot of the current layout

Returns Promise<Uint8Array>
- Defined in src/controllers/LayoutController.ts:209

remove

remove(id: string): Promise<EditorResponse<null>>
This method will remove a specific layout

Returns
Parameters
- id: string
  
  the id of a specific layout
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:76

rename

rename(id: string, name: string): Promise<EditorResponse<null>>
This method will update the name of a specific layout

Returns
Parameters
- id: string
  
  the id of a specific layout
- name: string
  
  the new name that the layout should receive
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:104

reset

reset(id: string): Promise<EditorResponse<null>>
This method will reset a specific layout to its original value

Returns
Parameters
- id: string
  
  the id of a specific layout
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:134

resetBleedValues

resetBleedValues(id: string): Promise<EditorResponse<null>>
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.
Parameters
- id: string
  
  The id of the (child) layout to reset the bleed values for
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:315

resetFillColor

resetFillColor(id: string): Promise<EditorResponse<null>>
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
Parameters
- id: string
  
  The id of the (child) layout to reset the fill color for
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:266

resetHeight

resetHeight(id: string): Promise<EditorResponse<null>>
This method will reset the height of a specific layout to its original value

Returns
Parameters
- id: string
  
  the id of a specific layout
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:178

resetIntent

resetIntent(id: string): Promise<EditorResponse<null>>
This method resets the intent of a specific layout to its original (inherited) value. Note: Calling this on the top layout is not valid
Parameters
- id: string
  
  The id of the (child) layout to reset the intent for
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:231

resetUnit

resetUnit(id: string): Promise<EditorResponse<null>>
This method will reset the unit of a specific layout to its original (inherited) value

Returns
Parameters
- id: string
  
  the id of a specific layout
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:198

resetWidth

resetWidth(id: string): Promise<EditorResponse<null>>
This method will reset the width of a specific layout to its original value

Returns
Parameters
- id: string
  
  the id of a specific layout
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:188

select

select(id: string): Promise<EditorResponse<null>>
This method will select a specific layout

Returns
Parameters
- id: string
  
  the id of a specific layout
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:114

setAreBleedValuesCombined

setAreBleedValuesCombined(id: string, value: boolean): Promise<EditorResponse<null>>
This method sets the combined state of the bleed values. Note: this is only valid on a print layout
Parameters
- id: string
  
  The id of the specific layout
- value: boolean
  
  Whether the bleed values are combined
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:302

setBleedValue

setBleedValue(id: string, value: string, position?: PositionEnum): Promise<EditorResponse<null>>
This method sets the bleed value of a specific layout. Note: this is only valid on a print layout
Parameters
- id: string
  
  The id of the specific layout
- value: string
  
  The bleed value
- Optional position: PositionEnum
  
  When 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.
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:281

setFillColor

setFillColor(id: string, color: ColorUsage): Promise<EditorResponse<null>>
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)
Parameters
- id: string
  
  the id of a specific layout
- color: ColorUsage
  
  the color that will be used for the layout
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:243

setFillColorEnabled

setFillColorEnabled(id: string, enabled: boolean): Promise<EditorResponse<null>>
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)
Parameters
- id: string
  
  the id of a specific layout
- enabled: boolean
  
  whether the fill color should be enabled or disabled
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:255

setHeight

setHeight(id: string, height: string): Promise<EditorResponse<null>>
This method will set the height of the layout to a specific value

Returns
Parameters
- id: string
  
  the id of a specific layout
- height: string
  
  the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:145

setIntent

setIntent(id: string, intent: LayoutIntent): Promise<EditorResponse<null>>
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
Parameters
- id: string
  
  the id of a specific layout
- intent: LayoutIntent
  
  the intent that will be used for the layout
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:220

setUnit

setUnit(id: string, unit: MeasurementUnit): Promise<EditorResponse<null>>
This method will set the unit of the layout to a specific value

Returns
Parameters
- id: string
  
  The id of a specific layout
- unit: MeasurementUnit
  
  the unit that will be used for the layout. All values in this layout will now be reported in this unit
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:168

setWidth

setWidth(id: string, width: string): Promise<EditorResponse<null>>
This method will set the width of the layout to a specific value

Returns
Parameters
- id: string
  
  the id of a specific layout
- width: string
  
  the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/LayoutController.ts:156

Class LayoutController

Hierarchy

Index

Methods

Methods

create

Returns

Parameters

parentId: string

Optional presets: LayoutPreset[]

Returns Promise<EditorResponse<string>>

duplicate

Returns

Parameters

id: string

Returns Promise<EditorResponse<string>>

getAll

Returns

Returns Promise<EditorResponse<Layout[]>>

getById

Returns

Parameters

id: string

Returns Promise<EditorResponse<Layout>>

getByName

Returns

Parameters

name: string

Returns Promise<EditorResponse<Layout>>

getSelected

Returns

Returns Promise<EditorResponse<Layout>>

getSelectedSnapshot

Deprecated

Returns

Returns Promise<Uint8Array>

remove

Returns

Parameters

id: string

Returns Promise<EditorResponse<null>>

rename

Returns

Parameters

id: string

name: string

Returns Promise<EditorResponse<null>>

reset

Returns

Parameters

id: string

Returns Promise<EditorResponse<null>>

resetBleedValues

Parameters

id: string

Returns Promise<EditorResponse<null>>

resetFillColor

Parameters

id: string

Returns Promise<EditorResponse<null>>

resetHeight

Returns

Parameters

id: string

Returns Promise<EditorResponse<null>>

resetIntent

Parameters

id: string

Returns Promise<EditorResponse<null>>

resetUnit

Returns

Parameters

id: string

Returns Promise<EditorResponse<null>>

resetWidth

Returns

Parameters

id: string

Returns Promise<EditorResponse<null>>

select

`Optional` presets: LayoutPreset[]

`Optional` position: PositionEnum