Class PdfAppearanceStream

Base class for PDF appearance streams (Form XObjects). Wraps a PdfStream as a PdfIndirectObject so it can be added directly to a document.

Hierarchy (View Summary)

PdfIndirectObject<PdfStream>
- PdfAppearanceStream

Constructors

constructor

new PdfAppearanceStream(
    options: {
        contentStream?: string;
        height?: number;
        resources?: PdfDictionary<PdfDictionaryEntries>;
        width?: number;
        x?: number;
        y?: number;
    },
): PdfAppearanceStream
Parameters
- options: {
      contentStream?: string;
      height?: number;
      resources?: PdfDictionary<PdfDictionaryEntries>;
      width?: number;
      x?: number;
      y?: number;
  }
Returns PdfAppearanceStream
Overrides PdfIndirectObject.constructor
- Defined in packages/pdf-lite/src/acroform/appearance/pdf-appearance-stream.ts:14

Properties

content

content: PdfStream

`Optional`encryptable

encryptable?: boolean

generationNumber

generationNumber: number

`Protected`immutable

immutable: boolean = false

Indicates whether the object is immutable (cannot be modified)

`Protected`modified

modified: boolean = true

Indicates whether the object has been modified. By default, assume it has been modified because it's a new object

objectNumber

objectNumber: number

offset

offset: Ref<number>

`Optional`orderIndex

orderIndex?: number

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Static` `Readonly`MAX_ORDER_INDEX

MAX_ORDER_INDEX: 2147483647

Accessors

contentStream

get contentStream(): string
Returns string
- Defined in packages/pdf-lite/src/acroform/appearance/pdf-appearance-stream.ts:48
set contentStream(newContent: string): void
Parameters
- newContent: string
Returns void
- Defined in packages/pdf-lite/src/acroform/appearance/pdf-appearance-stream.ts:52

graphics

set graphics(g: PdfGraphics): void
Parameters
- g: PdfGraphics
Returns void
- Defined in packages/pdf-lite/src/acroform/appearance/pdf-appearance-stream.ts:56

objectType

get objectType(): string
The type of this PDF object

Returns string
Inherited from PdfIndirectObject.objectType
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:19

reference

get reference(): PdfObjectReference
Returns PdfObjectReference
Inherited from PdfIndirectObject.reference
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:56

Methods

as

as<T extends PdfObject>(ctor: new (...args: any[]) => T): T
Attempts to cast the object to a specific PdfObject subclass
Type Parameters
- T extends PdfObject
Parameters
- ctor: new (...args: any[]) => T
Returns T
Inherited from PdfIndirectObject.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:77

clone

clone(): this
Creates a deep clone of the object

Returns this
Inherited from PdfIndirectObject.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:91

cloneImpl

cloneImpl(): this
Creates a deep clone of the object. Override this method in subclasses to ensure all properties are cloned correctly

Returns this
Inherited from PdfIndirectObject.cloneImpl
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:133

copyFrom

copyFrom(other: PdfIndirectObject): void
Parameters
- other: PdfIndirectObject
Returns void
Inherited from PdfIndirectObject.copyFrom
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:125

equals

equals(other?: PdfObject): boolean
Compares this object to another for equality based on their token representations
Parameters
- Optionalother: PdfObject
Returns boolean
Inherited from PdfIndirectObject.equals
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:98

inPdf

inPdf(): boolean
Returns boolean
Inherited from PdfIndirectObject.inPdf
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:100

isEncryptable

isEncryptable(): boolean
Returns boolean
Inherited from PdfIndirectObject.isEncryptable
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:74

isImmutable

isImmutable(): boolean
Indicates whether the object is immutable (cannot be modified)

Returns boolean
Inherited from PdfIndirectObject.isImmutable
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:34

isModified

isModified(): boolean
Indicates whether the object has been modified. Override this method if the modified state is determined differently

Returns boolean
Inherited from PdfIndirectObject.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:146

matchesReference

matchesReference(ref?: PdfObjectReference): boolean
Parameters
- Optionalref: PdfObjectReference
Returns boolean
Inherited from PdfIndirectObject.matchesReference
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:104

order

order(): number
Returns number
Inherited from PdfIndirectObject.order
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:142

setImmutable

setImmutable(immutable?: boolean): void
Sets the immutable state of the object
Parameters
- Optionalimmutable: boolean
Returns void
Inherited from PdfIndirectObject.setImmutable
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:154

setModified

setModified(modified?: boolean): void
Sets the modified state of the object. Override this method if the modified state is determined differently
Parameters
- modified: boolean = true
Returns void
Inherited from PdfIndirectObject.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:29

toBytes

toBytes(padTo?: number): ByteArray
Converts the object to a ByteArray, optionally padding to a specified length
Parameters
- OptionalpadTo: number
Returns ByteArray
Inherited from PdfIndirectObject.toBytes
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:53

`Protected`tokenize

tokenize(): PdfToken[]
Tokenizes the object into an array of PdfTokens

Returns PdfToken[]
Inherited from PdfIndirectObject.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:114

toString

toString(): string
Converts the object to a string representation

Returns string
Inherited from PdfIndirectObject.toString
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:68

toTokens

toTokens(): PdfToken[]
Converts the object to an array of PdfTokens, including any pre or post tokens

Returns PdfToken[]
Inherited from PdfIndirectObject.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:44

`Static`createPlaceholder

createPlaceholder<T extends PdfObject>(
    objectNumber?: number,
    generationNumber?: number,
    content?: T,
): PdfIndirectObject<T extends unknown ? PdfNull : T>
Type Parameters
- T extends PdfObject
Parameters
- OptionalobjectNumber: number
- OptionalgenerationNumber: number
- Optionalcontent: T
Returns PdfIndirectObject<T extends unknown ? PdfNull : T>
Inherited from PdfIndirectObject.createPlaceholder
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:87

Class PdfAppearanceStream

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfAppearanceStream

Properties

content

Optionalencryptable

generationNumber

Protectedimmutable

Protectedmodified

objectNumber

offset

OptionalorderIndex

OptionalpostTokens

OptionalpreTokens

Static ReadonlyMAX_ORDER_INDEX

Accessors

contentStream

Returns string

Parameters

Returns void

graphics

Parameters

Returns void

objectType

Returns string

reference

Returns PdfObjectReference

Methods

as

Type Parameters

Parameters

Returns T

clone

Returns this

cloneImpl

Returns this

copyFrom

Parameters

Returns void

equals

Parameters

Returns boolean

inPdf

Returns boolean

isEncryptable

Returns boolean

isImmutable

Returns boolean

isModified

Returns boolean

matchesReference

Parameters

Returns boolean

order

Returns number

setImmutable

Parameters

Returns void

setModified

Parameters

Returns void

toBytes

Parameters

Returns ByteArray

Protectedtokenize

Returns PdfToken[]

toString

Returns string

toTokens

Returns PdfToken[]

StaticcreatePlaceholder

Type Parameters

`Optional`encryptable

`Protected`immutable

`Protected`modified

`Optional`orderIndex

`Optional`postTokens

`Optional`preTokens

`Static` `Readonly`MAX_ORDER_INDEX

`Protected`tokenize

`Static`createPlaceholder