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

Hierarchy

  • PageController

Methods

  • This method returns a UInt8Array containing a PNG encoded image of the page.

    Returns

    UInt8Array snapshot of the given page

    Parameters

    • pageId: string

      the id of a specific page

    Returns Promise<Uint8Array>

  • This method changes the order of pages.

    Returns

    Parameters

    • order: number

      the index in the list to move to

    • ids: string[]

      An array of all IDs you want to move to the given index

    Returns 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>>

  • This method will set the width of the page to a specific value. This only works if the document is a project.

    Returns

    Parameters

    • pageId: 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>>

Generated using TypeDoc