Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

PdfPage - Scoped, Global

Creates a PdfPage object representing a PDF page and its attributes; such as size, width, and color.

This API is part of the ServiceNow PDF Generation Utilities plugin (com.snc.apppdfgenerator) and is provided within the sn_pdfgeneratorutils namespace. The plugin is activated by default.

This API is a component used with the Document API to generate a PDF.

Parent Topic:Server API reference

PdfPage - PdfPage(String pageSize, String orientation)

Instantiates a new PdfPage object.

NameTypeDescription
pageSizeStringPDF page size.Valid values: - A4 – 595 x 842 points - EXECUTIVE – 522 x 756 points - LETTER – 612 x 792 points - LEDGER – 792 x 1224 points
orientationStringOptional. PDF page orientation.Valid values: - LANDSCAPE - PORTRAIT Default: PORTRAIT

The following example shows how to create a PdfPage object.

var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");

PdfPage – getBottom()

Gets the Y-coordinate of the lower edge of a PDF page.

NameTypeDescription
None  
TypeDescription
NumberDecimal value of the Y-coordinate at the lower edge of the PDF page.

The following example shows how to get the Y-coordinate of the lower edge of a PDF page.

var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
 var bottom = pdfpage.getBottom();

PdfPage – getLeft()

Gets the X-coordinate of the left edge of a PDF page.

NameTypeDescription
None  
TypeDescription
NumberDecimal value of the X-coordinate on the left edge of the page.

The following example shows how to get the X-coordinate of the left edge of a PDF page.

var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
 var left = pdfpage.getLeft();

PdfPage – getPdfPageSize()

Gets the size of a PDF page

NameTypeDescription
None  
TypeDescription
None 

The following example shows how to get the PDF page size.

var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
var size = pdfpage.getPdfPageSize();

PdfPage – getRight()

Gets the X-coordinate of the right edge of a PDF page.

NameTypeDescription
None  
TypeDescription
NumberDecimal value of the X-coordinate on the right edge of the page.

The following example shows how to get the X-coordinate of the right edge of a PDF page.

var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
 var right = pdfpage.getRight();

PdfPage – getTop()

Gets the Y-coordinate of the upper edge of a PDF page.

NameTypeDescription
None  
TypeDescription
NumberDecimal value of the Y-coordinate at the upper edge of the PDF page.

The following example shows how to get the Y-coordinate of the upper edge of a PDF page.

var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
 var top  = pdfpage.getTop();

PdfPage – getWidth()

Gets the width of a PDF page.

NameTypeDescription
None  
TypeDescription
NumberSize of the page width in points.

The following example shows how to retrieve the width of a PDF page.

var pdfpage = new sn_pdfgeneratorutils.PdfPage("A4", "LANDSCAPE");
var width = PdfPage.getWidth();