UNPKG

@syncfusion/ej2-pdf

Version:

Feature-rich JavaScript PDF library with built-in support for loading and manipulating PDF document.

89 lines (88 loc) 3.23 kB
import { PdfXmpSchema } from './pdf-xmp-schema'; import { PdfXmpSchemaType } from '../enumerator'; import { PdfXmpMetadata } from './pdf-xmp-metadata'; /** * Represents metadata for print job and production instructions. * * ```typescript * // Load an existing PDF document * let document: PdfDocument = new PdfDocument(data, password); * // Access the document properties * let documentProperties: PdfDocumentInformation = document.getDocumentInformation(false); * // Gets XMP metadata * let xmpMetadata: PdfXmpMetadata = documentProperties.xmpMetadata; * // Sets job references * xmpMetadata.basicJobTicketSchema.jobRef = ['JobA', 'JobB']; * // Save the document * document.save('output.pdf'); * // Destroy the document * document.destroy(); * ``` */ export declare class PdfBasicJobTicketSchema extends PdfXmpSchema { private _jobRef; /** * Initializes a new `PdfBasicJobTicketSchema` instance. * * @private * @param {PdfXmpMetadata} xmp Optional parent PdfXmpMetadata reference. */ constructor(xmp?: PdfXmpMetadata); /** * Gets the schema type. * * @returns {PdfXmpSchemaType} The schema type. * * ```typescript * // Load an existing PDF document * let document: PdfDocument = new PdfDocument(data, password); * // Access the document properties * let documentProperties: PdfDocumentInformation = document.getDocumentInformation(false); * // Gets XMP metadata * let xmpMetadata: PdfXmpMetadata = documentProperties.xmpMetadata; * // Access schema type from basic job ticket schema * let type: PdfXmpSchemaType = xmpMetadata.basicJobTicketSchema.schemaType; * // Destroy the document * document.destroy(); * ``` */ readonly schemaType: PdfXmpSchemaType; /** * Gets the list of job references (rdf:Bag). * * @returns {string[]} The job references. * * ```typescript * // Load an existing PDF document * let document: PdfDocument = new PdfDocument(data, password); * // Access the document properties * let documentProperties: PdfDocumentInformation = document.getDocumentInformation(false); * // Gets XMP metadata * let xmpMetadata: PdfXmpMetadata = documentProperties.xmpMetadata; * // Access job references from basic job ticket schema * let jobRef: string[] = xmpMetadata.basicJobTicketSchema.jobRef; * // Destroy the document * document.destroy(); * ``` */ /** * Sets the list of job references (rdf:Bag). * * @param {string[]} value The job references to set. * ```typescript * // Load an existing PDF document * let document: PdfDocument = new PdfDocument(data, password); * // Access the document properties * let documentProperties: PdfDocumentInformation = document.getDocumentInformation(false); * // Gets XMP metadata * let xmpMetadata: PdfXmpMetadata = documentProperties.xmpMetadata; * // Sets job references * xmpMetadata.basicJobTicketSchema.jobRef = ['JobA', 'JobB']; * // Save the document * document.save('output.pdf'); * // Destroy the document * document.destroy(); * ``` */ jobRef: string[]; }