Type alias PageInfo

PageInfo: {
    actualPageCount: number;
    bookLayout: boolean;
    editInsideCover: boolean;
    firstPageDimension: Size;
    hasCover: boolean;
    max: number;
    min: number;
    pageCount: number;
    separateCoverPages: boolean;
}

This informational item holds page information about the current job. It is fast to generate and should be used to get an overview of the pages instead of enumerating all pages.

Type declaration

  • actualPageCount: number

    The actual page count refers to the number of pages within the final output. This is without cover pages and sums up the spread pages correctly too.

  • bookLayout: boolean

    Flag if the current configuration is using a book layout / spreads.

  • editInsideCover: boolean

    Flag to control if the inside cover (if any) are editable

  • firstPageDimension: Size

    The dimensions of the first page. Note: based on the product configuration, all pages will have the same size, but it could also differ when covers or dynamic canvas sizes are used.

  • hasCover: boolean

    Flag to control if this configuration is using cover pages.

  • max: number

    The maximum number of pages based on the product configuration.

  • min: number

    The minimum number of pages based on the product configuration.

  • pageCount: number

    The page count is the number of page objects within the editor. Each page will have a mode depending on the setup (spread vs single pages).

  • separateCoverPages: boolean

    Flag to control if the covers are split in front and back or if a full spread is shown.

Settings

Member Visibility

Theme

Generated using TypeDoc