TPPDF is a simple-to-use PDF builder for iOS

I'm trying with the example target provided with this project

minimum code to reproduce the problem

let document = PDFDocument(format: .a4)
let section = PDFSection(columnWidths: [0.3, 0.7])
        section.columns[0].addText(.left, text: "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem")
        section.columns[1].addText(.left, text: "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.")
        
document.addSection(section)
        
document.addSection(section)

Help would be appreciated

Hi , i am using TPPDF 2.2.0 and integrating in a personal iOS app i am writing . a great library , thank you but i am trying to understand showHeadersOnEveryPage when showHeadersOnEveryPage is true, the header row overwrites the top row on the next page and ends up hiding it. i don't see any properties to add space after the header row. being new, i might have overlooked something

here are two screenshots.. without a header and with. the 20:12 entry is overwritten by the header row

thank you Sami

Is it possible to have content wrap to the next column instead of the next page? Or to get the height of each added object (text, table, etc) so I can manually wrap object to the next column in a section?

I am getting UIGraphicsGetCurrentContext() nil when the app is run in device, it works fine in simulator.

Here's the method where UIGraphicsGetCurrentContext() is nil:

    override func draw(generator: PDFGenerator, container: PDFContainer) throws {
        if attributedString == nil {
            throw PDFError.textObjectNotCalculated
        }

        // Get current graphics context
        let currentContext = UIGraphicsGetCurrentContext()!

        // Create a core text frame setter
        let framesetter = CTFramesetterCreateWithAttributedString(attributedString)

        // Save context pre manipulation
        currentContext.saveGState()

        // Reset text matrix, so no text scaling is affected
        currentContext.textMatrix = CGAffineTransform.identity

        // Create the frame and a rectangular path of the text frame
        let frameRect = CGRect(x: 0, y: 0, width: frame.width, height: frame.height)
        let framePath = UIBezierPath(rect: frameRect).cgPath

        // Create core text frame for the given attributed string
        // The whole text should fit the frame, as calculations were already done
        let frameRef = CTFramesetterCreateFrame(framesetter, CFRangeMake(0, attributedString.length), framePath, nil)

        // Translate by 100% graphics height up and reverse scale, as core text does draw from bottom up and not from top down
        currentContext.translateBy(x: 0, y: UIGraphicsGetPDFContextBounds().height)
        currentContext.scaleBy(x: 1.0, y: -1.0)

        // Translate context to actual position of text
        currentContext.translateBy(x: frame.minX, y: UIGraphicsGetPDFContextBounds().height - frame.maxY)

        // Draw text into context
        CTFrameDraw(frameRef, currentContext)

        // Restore context to pre manipulation
        currentContext.restoreGState()

        // If debugging is enabled, draw a outline around the text
        if generator.debug {
            PDFGraphics.drawRect(rect: self.frame, outline: PDFLineStyle(type: .dashed, color: .red, width: 1.0), fill: .clear)
        }
    }

Any help on this would be much appreciated. Thanks.

I am currently using the 'develop' branch in order to test adding external PDFs. While the functionality is running great I keep running into an issue were a blank page is added in the end after importing an external document.

Here is what I am using batchPagesv2.add(externalDocument: PDFExternalDocument(url: url, pages: pages[count]))

Whats interesting is that if I duplicate the batch job multiple times, only one extra blank page is added on the end. If I do not use external documents there is no blank page added either. So I am a bit lost as to where this page is coming from.

So either this can be flagged as a bug or a feature suggestion to maybe make a boolean to filter out blank pages upon generation.

I am using this library to generate a PDF of content added by the user. I am using: let pdfDocument = PDFDocument(format: .a4) and then adding text, table as required.

I wanted to know if there is a way to dynamically create a new page once content had reached the end of page one. Please advise.

At least on my end, Carthage can not build the framework for the latest release 1.5.3.

The first error that came up was the missing shared scheme as described in #98. Unchecking and checking the box for the TPPDF scheme as described in this comment did fix the issue.

However the framework still does not build due to a missing .plist file. Here's the error message when running carthage build --verbose --platform "iOS" --no-skip-current TPPDF:

error: could not read data from '$(SRC_ROOT)/Carthage/Checkouts/TPPDF/Example/Pods/Target Support Files/TPPDF/TPPDF-Info.plist': The file “TPPDF-Info.plist” couldn’t be opened because there is no such file.

And indeed there is no such file; The actual directory contents are:

$ tree Target\ Support\ Files
                                                                                                                                                                                     
Target\ Support\ Files
├── Nimble
│   ├── Nimble-dummy.m
│   ├── Nimble-prefix.pch
│   ├── Nimble-umbrella.h
│   ├── Nimble.modulemap
│   └── Nimble.xcconfig
├── Pods-TPPDF_Example
│   ├── Pods-TPPDF_Example-acknowledgements.markdown
│   ├── Pods-TPPDF_Example-acknowledgements.plist
│   ├── Pods-TPPDF_Example-dummy.m
│   ├── Pods-TPPDF_Example-frameworks.sh
│   ├── Pods-TPPDF_Example-umbrella.h
│   ├── Pods-TPPDF_Example.debug.xcconfig
│   ├── Pods-TPPDF_Example.modulemap
│   └── Pods-TPPDF_Example.release.xcconfig
├── Pods-TPPDF_Tests
│   ├── Pods-TPPDF_Tests-acknowledgements.markdown
│   ├── Pods-TPPDF_Tests-acknowledgements.plist
│   ├── Pods-TPPDF_Tests-dummy.m
│   ├── Pods-TPPDF_Tests-frameworks.sh
│   ├── Pods-TPPDF_Tests-umbrella.h
│   ├── Pods-TPPDF_Tests.debug.xcconfig
│   ├── Pods-TPPDF_Tests.modulemap
│   └── Pods-TPPDF_Tests.release.xcconfig
├── Quick
│   ├── Quick-dummy.m
│   ├── Quick-prefix.pch
│   ├── Quick-umbrella.h
│   ├── Quick.modulemap
│   └── Quick.xcconfig
└── TPPDF
    ├── TPPDF-dummy.m
    ├── TPPDF-prefix.pch
    ├── TPPDF-umbrella.h
    ├── TPPDF.modulemap
    └── TPPDF.xcconfig

Edit: 1.4.1 fails with the same error message (missing .plist file). But the shared TPPDF scheme is present after checkout.

Hi

I'm new to this and i got an Error, which i think a had somewhen before. Could you please help me and fix this? ERROR: *** Skipped building TPPDF due to the error: Dependency "TPPDF" has no shared framework schemes for any of the platforms: iOS If you believe this to be an error, please file an issue with the maintainers at https://github.com/Techprimate/TPPDF/issues/new

THANX A LOT!!!!! Reinhard

Hey. I try to have an image attached into the NSAttributedString but the image gets lost.

        let pdf = PDFGenerator(format: .a4)
        
        let typeDetails = NSMutableAttributedString()
        let attachment = NSTextAttachment()
        attachment.image = Img.checked
        attachment.bounds = CGRect(x: 0, y: 0, width: 10, height: 10)
        let attachmentStr = NSAttributedString(attachment: attachment)
        
        typeDetails.append( NSAttributedString(string: ">>>>>") )
        typeDetails.append(attachmentStr)
        typeDetails.append( NSAttributedString(string: "<<<<<") )
        pdf.addAttributedText(text: typeDetails)

I have tried several approaches as well as several images.

idea?

Hello,

Thank you for this wonderful library. This is so helpful.

I just want to ask if would it be possible to control the image quality on the table? 'Cause right now it kinda blurry. I would like to remain the quality of the image as possible so it won't appear blurry. Thank you in advance for your help.

down vote favorite

I posted this on stackoverflow, but I couldn't find a TPPDF tag to tag it with.

I'm having a problem with a table cell being cut off at the bottom of the page when using the TPPDF cocoapod in a swift 4 app for i-pad. Only part of the cell shows with no text

I'm creating a series of tables in my document. Because the column widths are variable I'm adding a new table for each row.

Is there a way to either prevent this from happening or to determine when to add a page break?

ℹ Please fill out this template when filing an issue. All lines beginning with an ℹ symbol instruct you with what info we expect. You can delete those lines once you've filled in the info.

What did you do?

I added a banner image to the document's .headerLeft and a table in the .headerLeft. The table has an Image to the left and Text to the right of the image.

document.add(.headerLeft, image: bannerPDFImage)

document.add(.headerLeft, table: headerTable)

What did you expect to happen?

I expected to see the full image and text beneath the banner image. Instead, there's a gap between the banner image and table below, with the top of the table cut off.

What happened instead?

TPPDF Environment

TPPDF version: 2.5.3 Xcode version: 14.2 Swift version: 5.7

Demo Code / Project

From the TableExampleFactory.swift file:

//
//  TableExampleFactory.swift
//  TPPDF_Example
//
//  Created by Philip Niedertscheider on 16.12.19.
//  Copyright © 2022 techprimate GmbH. All rights reserved.
//

#if os(iOS)
import UIKit
#elseif os(macOS)
import AppKit
#endif

import TPPDF

class TableExampleFactory: ExampleFactory {

    func generateDocument() -> [PDFDocument] {
        let document = PDFDocument(format: .a4)

		let headerStyle = PDFTableStyleDefaults.none

		let headerTable = PDFTable(rows: 1, columns: 2)
		headerTable.widths = [0.1, 0.9]
		headerTable.style = headerStyle
		
		var tableContent : [[PDFTableContentable]] = [[PDFTableContentable]]()
		var rowContent : [PDFTableContentable] = [PDFTableContentable]()
		
		if #available(macOS 12.0, *) {

			let bannerImage = Image(named: "Business Logo Banner.jpg")
			if let bannerImage = bannerImage {
				let bannerPDFImage = PDFImage(image: bannerImage)
				document.add(.headerLeft, image: bannerPDFImage)
			}
			
			var formIcon = Image(systemSymbolName: "doc.plaintext", accessibilityDescription: "")
			formIcon?.resizingMode = .tile
			var config = NSImage.SymbolConfiguration(textStyle: .largeTitle,
													 scale: .large)
			config = config.applying(NSImage.SymbolConfiguration.preferringMulticolor())
			formIcon = formIcon?.withSymbolConfiguration(config)
			if let formIcon = formIcon {
				rowContent.append(formIcon)
			} else {
				rowContent.append("")
			}
			
			headerStyle.contentStyle = PDFTableCellStyle(
				
				borders: PDFTableCellBorders(left: PDFLineStyle(type: .none),
											 top: PDFLineStyle(type: .none),
											 right: PDFLineStyle(type: .none),
											 bottom: PDFLineStyle(type: .none)),
				
				font: Font.systemFont(ofSize: 28, weight: .light)
			)
			
			rowContent.append("Test Header Text Content")
			
			tableContent.append(rowContent)
			headerTable.content = tableContent
			headerTable.rows.allCellsAlignment = .left
			document.add(.headerLeft, table: headerTable)
			
		} else {
			// Fallback on earlier versions
		}

		
        // Create a table
        var table = PDFTable(rows: 34, columns: 4)

        // Tables can contain Strings, Numbers, Images or nil, in case you need an empty cell.
        // If you add a unknown content type, an assertion will be thrown and the rendering will stop.
        table.content = [
            [nil, "Name",      "Image",                        "Description"],
            [1,   "Waterfall", Image(named: "Image-1.jpg")!, "Water flowing down stones."],
            [2,   "Forrest",   Image(named: "Image-2.jpg")!, "Sunlight shining through the leafs."],
            [3,   "Fireworks", Image(named: "Image-3.jpg")!, "Fireworks exploding into 100.000 stars"],
            [4,   "Fields",    Image(named: "Image-4.jpg")!, "Crops growing big and providing food."],
            [1,   "Waterfall", Image(named: "Image-1.jpg")!, "Water flowing down stones."],
            [2,   "Forrest",   Image(named: "Image-2.jpg")!, "Sunlight shining through the leafs."],
            [3,   "Fireworks", Image(named: "Image-3.jpg")!, "Fireworks exploding into 100.000 stars"],
            [4,   "Fields",    Image(named: "Image-4.jpg")!, "Crops growing big and providing food."],
			[1,   "Waterfall", Image(named: "Image-1.jpg")!, "Water flowing down stones."],
			[2,   "Forrest",   Image(named: "Image-2.jpg")!, "Sunlight shining through the leafs."],
			[3,   "Fireworks", Image(named: "Image-3.jpg")!, "Fireworks exploding into 100.000 stars"],
			[4,   "Fields",    Image(named: "Image-4.jpg")!, "Crops growing big and providing food."],
			[1,   "Waterfall", Image(named: "Image-1.jpg")!, "Water flowing down stones."],
			[2,   "Forrest",   Image(named: "Image-2.jpg")!, "Sunlight shining through the leafs."],
			[3,   "Fireworks", Image(named: "Image-3.jpg")!, "Fireworks exploding into 100.000 stars"],
			[4,   "Fields",    Image(named: "Image-4.jpg")!, "Crops growing big and providing food."],
			[1,   "Waterfall", Image(named: "Image-1.jpg")!, "Water flowing down stones."],
			[2,   "Forrest",   Image(named: "Image-2.jpg")!, "Sunlight shining through the leafs."],
			[3,   "Fireworks", Image(named: "Image-3.jpg")!, "Fireworks exploding into 100.000 stars"],
			[4,   "Fields",    Image(named: "Image-4.jpg")!, "Crops growing big and providing food."],
			[1,   "Waterfall", Image(named: "Image-1.jpg")!, "Water flowing down stones."],
			[2,   "Forrest",   Image(named: "Image-2.jpg")!, "Sunlight shining through the leafs."],
			[3,   "Fireworks", Image(named: "Image-3.jpg")!, "Fireworks exploding into 100.000 stars"],
			[4,   "Fields",    Image(named: "Image-4.jpg")!, "Crops growing big and providing food."],
			[1,   "Waterfall", Image(named: "Image-1.jpg")!, "Water flowing down stones."],
			[2,   "Forrest",   Image(named: "Image-2.jpg")!, "Sunlight shining through the leafs."],
			[3,   "Fireworks", Image(named: "Image-3.jpg")!, "Fireworks exploding into 100.000 stars"],
			[4,   "Fields",    Image(named: "Image-4.jpg")!, "Crops growing big and providing food."],
			[1,   "Waterfall", Image(named: "Image-1.jpg")!, "Water flowing down stones."],
			[2,   "Forrest",   Image(named: "Image-2.jpg")!, "Sunlight shining through the leafs."],
			[3,   "Fireworks", Image(named: "Image-3.jpg")!, "Fireworks exploding into 100.000 stars"],
			[4,   "Fields",    Image(named: "Image-4.jpg")!, "Crops growing big and providing food."],

            [nil, nil,         nil,                            "Many beautiful places"]
        ]
        table.rows.allRowsAlignment = [.center, .left, .center, .right]

        // The widths of each column is proportional to the total width, set by a value between 0.0 and 1.0, representing percentage.

        table.widths = [
            0.1, 0.25, 0.35, 0.3
        ]

        // To speed up table styling, use a default and change it

        let style = PDFTableStyleDefaults.simple

        // Change standardized styles
        style.footerStyle = PDFTableCellStyle(
            colors: (
                fill: Color(red: 0.171875,
                              green: 0.2421875,
                              blue: 0.3125,
                              alpha: 1.0),
                text: Color.white
            ),
            borders: PDFTableCellBorders(left: PDFLineStyle(type: .full),
                                         top: PDFLineStyle(type: .full),
                                         right: PDFLineStyle(type: .full),
                                         bottom: PDFLineStyle(type: .full)),

            font: Font.systemFont(ofSize: 10)
        )

        // Simply set the amount of footer and header rows

        style.columnHeaderCount = 1
        style.footerCount = 1

        table.style = style

        // Style each cell individually
        table[1,1].style = PDFTableCellStyle(colors: (fill: Color.yellow, text: Color.black))

        // Set table padding and margin
        table.padding = 5.0
        table.margin = 10.0

        // In case of a linebreak during rendering we want to have table headers on each page.

        table.showHeadersOnEveryPage = true

        document.add(table: table)

        // Another table:

        table = PDFTable(rows: 50, columns: 4)
        table.widths = [0.1, 0.3, 0.3, 0.3]
        table.margin = 10
        table.padding = 10
        table.showHeadersOnEveryPage = false
        table.style.columnHeaderCount = 3

        for row in 0..<table.size.rows {
            table[row, 0].content = "\(row)".asTableContent
            for column in 1..<table.size.columns {
                table[row, column].content = "\(row),\(column)".asTableContent
            }
        }

        for i in stride(from: 3, to: 48, by: 3) {
            table[rows: i...(i + 2), column: 1].merge(with: PDFTableCell(content: Array(repeating: "\(i),1", count: 3).joined(separator: "\n").asTableContent,
                                                           alignment: .center))
        }
        for i in stride(from: 4, to: 47, by: 3) {
            table[rows: i...(i + 2), column: 2].merge(with: PDFTableCell(content: Array(repeating: "\(i),2", count: 3).joined(separator: "\n").asTableContent,
                                                           alignment: .center))
        }
        for i in stride(from: 5, to: 48, by: 3) {
            table[rows: i...(i + 2), column: 3].merge(with: PDFTableCell(content: Array(repeating: "\(i),3", count: 3).joined(separator: "\n").asTableContent,
                                                           alignment: .center))
        }

        table[rows: 0..<2, column: 2].merge()
        table[rows: 1..<3, column: 3].merge()

        document.add(table: table)

        return [document]
    }
}

and here's the banner image I added to the project for testing purposes.

What's the best way to get a header image to use up. the entire space of the header part of the page, ignoring the margins, while some text and a line separator in the header respects the margins?

It seems to work for the first page, but subsequent pages the image I'm adding is being indented.

I'm using the following code to set the margins to 0 and the indentation to whatever the user has specified.

let pdfImage = PDFImage(image: image)
document.add(headerPosition, image: pdfImage)
document.add(headerPosition, space: 20)
document.layout.margin = EdgeInsets(top: 0, left: 0, bottom: reportSettings.marginBottom, right: 0)
document.set(indent: reportSettings.marginLeft, left: true)
document.set(indent: reportSettings.marginRight, left: false)
document.set(.headerLeft, indent: reportSettings.marginLeft, left: true)
document.set(.headerLeft, indent: reportSettings.marginRight, left: false)
document.set(.footerLeft, indent: reportSettings.marginLeft, left: true)
document.set(.footerLeft, indent: reportSettings.marginRight, left: false)

ℹ Please fill out this template when filing an issue. All lines beginning with an ℹ symbol instruct you with what info we expect. You can delete those lines once you've filled in the info.

What did you do?

I was generating a report that had no table rows other than the header row.

What did you expect to happen?

I expected the main header and header row of the table to get generated.

What happened instead?

I encountered a crash at the following code in PDFTableObject of the calculate method.

var rowIdx = 0
while cells[rowIdx].allSatisfy({ $0.type == .rowHeader || $0.type == .header }) && rowIdx < table.size.rows {
          headerCells += cells[rowIdx]
          rowIdx += 1
 }

TPPDF Environment

TPPDF version: 2.3.5 (master branch commit: 0dbe543c517c94d0bebacdaf1c0894a9a28c4a78) Xcode version: 14.1 Swift version: 5.7

Demo Code / Project

I think the solution to the crash is to short circuit the while loop by checking the rowIdx first:

var rowIdx = 0
while  rowIdx < table.size.rows && cells[rowIdx].allSatisfy({ $0.type == .rowHeader || $0.type == .header }) {
          headerCells += cells[rowIdx]
          rowIdx += 1
 }

That way the cells[rowIdx] expression won't get executed and won't crash

I want to put a separator line at the top of the footer before the body of the footer. but the divider is not at the top, but at the bottom. How should I do this? Looking forward to your reply, thanks.

my code. let line = PDFLineStyle.init(type: .full, color: .blue, width: 1.0) document.addLineSeparator(.footerLeft, style: line) document.add(.footerLeft, textObject: PDFSimpleText(text: "Footer Left"))

TPPDF Environment

TPPDF version: 2.3.5 Xcode version: 14.1 Swift version: 5.2

How should the feature work?

Is it possible to get total amount of page and display in certain place (not only in footer, header, center etc.)?

What should it look like?

I am trying to add this amount of page above signature place, to be sure that user had signed the document with this page count. Here is a screenshot.

What happened instead?

I can only add page numeration in foster, header etc.

TPPDF Environment

TPPDF version: 2.3.5 Xcode version: 13.3.1 Swift version: 5