API Documentation for XObject

• API Documentation for XObject
  • NoPoDoFo XObject
  • Constructors
  • Properties
    • contents
    • contentsForAppending
    • resources
    • pageMediaBox
    • reference
  • Methods

NoPoDoFo XObject

An XObject is an object which can hold a set of instructions, these instructions are typically draw operations. XObject are reusable, and can be applied to an Object by setting the xobject as the value of an appearance stream. Creating an xobject is done via BaseDocument.createXObject

class XObject {
    readonly contents: Object
    readonly contentsForAppending: Object
    readonly resources: Object
    readonly pageMediaBox: Rect
    readonly reference: Ref
}

Constructors

Properties

contents

Readonly property. Get the contents of the XObject as an Object

contentsForAppending

Readonly property.

resources

Readonly property. Get the XObjects resources dictionary.

pageMediaBox

Readonly property. Get the XObject's media box. See Page for a diagram of page boxes.

reference

Readonly property. Get the XObject's Ref

Methods