PDFPagination

public struct PDFPagination
extension PDFPagination: Equatable

Used to define the pagination behaviour of a document.

  • Container where the pagination will be placed

    Declaration

    Swift

    public var container: PDFContainer
  • Style of the pagination

    Declaration

    Swift

    public var style: PDFPaginationStyle
  • Range of pages which will be paginated

    Declaration

    Swift

    public var range: (start: Int, end: Int)
  • Add a page number to this list to exclude it from the pagination. This will not skip the page but instead not render the pagination object

    Declaration

    Swift

    public var hiddenPages: [Int]
  • These text attribtues are used to create the attributed pagination string

    Declaration

    Swift

    public var textAttributes: [NSAttributedString.Key : Any]
  • Initializer

    Declaration

    Swift

    public init(container: PDFContainer = .none,
                style: PDFPaginationStyle = .default,
                range: (start: Int, end: Int) = (0, Int.max),
                hiddenPages: [Int] = [],
                textAttributes: [NSAttributedString.Key: Any] = [:])

    Parameters

    container

    Container where pagination is placed, defaults to PDFContainer.none, meaning it won’t be rendered

    style

    Style of pagination, defaults to PDFPaginationStyle.default

    range

    Start and end of pages which will be included

    hiddenPages

    List of numbers which are excluded from rendering

  • TODO: Documentation

    Declaration

    Swift

    public static func == (lhs: PDFPagination, rhs: PDFPagination) -> Bool