Class PageController

The PageController is responsible for all communication regarding Pages. Methods inside this controller can be called by window.SDK.page.{method-name}

Hierarchy

PageController

Index

Methods

getAll getById setHeight setWidth

Methods

getAll

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

Returns
list of all pages

Returns Promise<EditorResponse<Page[]>>
- Defined in controllers/PageController.ts:26

getById

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

Returns
page properties
Parameters
- id: string
  
  the id of a specific page
Returns Promise<EditorResponse<Page>>
- Defined in controllers/PageController.ts:36

setHeight

setHeight(id: string, height: string): Promise<EditorResponse<null>>
This method will set the height of the page to a specific value. This only works if the document is a project.

Returns
Parameters
- id: string
  
  the id of a specific page
- 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 controllers/PageController.ts:60

setWidth

setWidth(id: string, width: string): Promise<EditorResponse<null>>
This method will set the width of the page to a specific value. This only works if the document is a project.

Returns
Parameters
- id: string
  
  the id of a specific page
- 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 controllers/PageController.ts:48

Generated using TypeDoc