When converting webpages or HTML snippets straight to PDF GrabzIt's Ruby API provides the following features that help integrate GrabzIt into your system as easily as possible. However before you start remember that after calling the set_pdf_options method the save or save_to method must be called to take the PDF screenshot.
Basic Options
A PDF capture converts the entire web page into a PDF document of potentially many pages. Only one parameter is required in order to convert a web page into a PDF document or to convert HTML to PDF as shown in the below examples.
grabzItClient.url_to_pdf("https://www.tesla.com")
# Then call the save or save_to method
grabzItClient.html_to_pdf("<html><body><h1>Hello World!</h1></body></html>")
# Then call the save or save_to method
grabzItClient.file_to_pdf("example.html")
# Then call the save or save_to method
Custom Identifier
You can pass a custom identifier to the PDF methods as shown below, this value is then returned to your GrabzIt Ruby handler. For instance this custom identifier could be a database identifier, allowing a screenshot to be associated with a particular database record.
grabzItClient = GrabzIt::Client.new("Sign in to view your Application Key", "Sign in to view your Application Secret")
options = GrabzIt::PDFOptions.new()
options.customId = "123456"
grabzItClient.url_to_pdf("https://www.tesla.com", options)
# Then call the save method
grabzItClient.save("http://www.example.com/handler/index")
grabzItClient = GrabzIt::Client.new("Sign in to view your Application Key", "Sign in to view your Application Secret")
options = GrabzIt::PDFOptions.new()
options.customId = "123456"
grabzItClient.html_to_pdf("<html><body><h1>Hello World!</h1></body></html>", options)
# Then call the save method
grabzItClient.save("http://www.example.com/handler/index")
grabzItClient = GrabzIt::Client.new("Sign in to view your Application Key", "Sign in to view your Application Secret")
options = GrabzIt::PDFOptions.new()
options.customId = "123456"
grabzItClient.file_to_pdf("example.html", options)
# Then call the save method
grabzItClient.save("http://www.example.com/handler/index")
Headers and Footers
When you create a PDF screenshot you can request that you want to apply a particular template to the generated PDF. This template must be saved in advance and will specify the contents of the header and footer along with any special variables. In the example code below the user is using their template called "my template".
If there is not a large enough top or bottom margin for the header or footer respectively, it will not appear in the PDF. In the below example we have set the top and bottom margins to 20 to provide plenty of space.
grabzItClient = GrabzIt::Client.new("Sign in to view your Application Key", "Sign in to view your Application Secret")
options = GrabzIt::PDFOptions.new()
options.marginTop = 20
options.marginBottom = 20
options.templateId = "my template"
grabzItClient.url_to_pdf("https://www.tesla.com", options)
# Then call the save or save_to method
grabzItClient.save_to("result.pdf")
grabzItClient = GrabzIt::Client.new("Sign in to view your Application Key", "Sign in to view your Application Secret")
options = GrabzIt::PDFOptions.new()
options.marginTop = 20
options.marginBottom = 20
options.templateId = "my template"
grabzItClient.html_to_pdf("<html><body><h1>Hello World!</h1></body></html>", options)
# Then call the save or save_to method
grabzItClient.save_to("result.pdf")
grabzItClient = GrabzIt::Client.new("Sign in to view your Application Key", "Sign in to view your Application Secret")
options = GrabzIt::PDFOptions.new()
options.marginTop = 20
options.marginBottom = 20
options.templateId = "my template"
grabzItClient.file_to_pdf("example.html", options)
# Then call the save or save_to method
grabzItClient.save_to("result.pdf")
Convert HTML element to PDF
If you want to just convert a HTML element such as a div or span directly into a PDF document you can with GrabzIt's Ruby Gem. You must pass the CSS selector of the HTML element you wish to convert to the targetElement method.
... <span id="Article"> <p>This is the content I am interested in.</p> <img src="myimage.jpg"> </span> ...
In this example, we wish to capture all the content in the span which has the id of Article, therefore we pass this to GrabzIt as shown below.
grabzItClient = GrabzIt::Client.new("Sign in to view your Application Key", "Sign in to view your Application Secret")
options = GrabzIt::PDFOptions.new()
options.targetElement = "#Article"
grabzItClient.url_to_pdf("http://www.bbc.co.uk/news", options)
# Then call the save or save_to method
grabzItClient.save_to("result.pdf")
How a PDF is cropped when targeting a HTML element can be controlled using these techniques.