Type alias Page

Type declaration

• background: BackgroundPageListing

  The background property holds the background information for the page. This is an array with two entries. If no background is used the value will be null, otherwise a BackgroundItem. Single pages can only have the first array element set, double pages can have both elements set. Spread start or end pages can have only the respective element set.

• canDelete: boolean

  Flag to control if the page can be deleted fundamentaly. That is defined generally by the configuration of the product (e.g. the first or last spread page can not be deleted). Not to be confused with the notDeletable flag, which is a configurable setting. This flag is immutable.

• displayName: string

  The display name of the page. This can be controlled by the product setup or via scripting, but if empty, it will be autogenerated to provide a running count based on the page mode: "Page 1", "Page 2" for single pages or "1 + 2", "3 + 4" etc

• fieldCount: number

  The total number of fields currently on the page.

• id: string

  The unique id of the page (GUID).

• isCover: boolean

  Boolean flag to control if the page is a cover page.

• layout: LayoutPageListing

  The layouts used for the current page. This is an array with two entries. If no layout is used the value will be null, otherwise a LayoutItem. Single pages can only have the first array element set, double pages can have both elements set. Spread start or end pages can have only the respective element set.

• mode: PageMode

  The mode of the page. Note that the configuration of the product predetermines the page mode.

• name: string

  The name of the page.

• notDeletable: boolean

  Flag to control if the page can be deleted via the UI. If this is set to true, the end user will not be able to delete the page, despite the product configuration. Deleting via scripting would still be possible no matter the setting. This is essentially controlling only the user interface. Not to be confused with canDelete, which is controlled by the product configuration and is immutable.

• size: Size

  The final size of the page. See also the canvas configuration for further details.

• tags: string[]

  A list of tags set against the page. Tags can be used to store additional data against a page. This is available for scripting and can be via the product build process.

• visible: boolean

  Flag to control if the page is visible. Invisbile pages will not show up in the editor, however will still be available in the output (delete pages to remove them from the output).