Class PdfXRefStream

Hierarchy (View Summary)

PdfStream
- PdfXRefStream

Constructors

constructor

new PdfXRefStream(
    options?: {
        header?: PdfDictionary<PdfDictionaryEntries>;
        isModified?: boolean;
        original?: string | ByteArray;
    },
): PdfXRefStream
Parameters
- Optionaloptions: {
      header?: PdfDictionary<PdfDictionaryEntries>;
      isModified?: boolean;
      original?: string | ByteArray;
  }
Returns PdfXRefStream
Overrides PdfStream.constructor
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:416

Properties

header: PdfDictionary

`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

original

original: ByteArray

`Optional`postStreamDataTokens

postStreamDataTokens?: PdfToken[]

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preStreamDataTokens

preStreamDataTokens?: PdfToken[]

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

Accessors

objectType

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

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

originalAsString

get originalAsString(): string
Returns string
Inherited from PdfStream.originalAsString
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:69

get prev(): PdfNumber | undefined
Returns PdfNumber | undefined
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:580

raw

get raw(): ByteArray
Returns ByteArray
Inherited from PdfStream.raw
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:56
set raw(data: ByteArray): void
Parameters
- data: ByteArray
Returns void
Inherited from PdfStream.raw
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:63

rawAsString

get rawAsString(): string
Returns string
Inherited from PdfStream.rawAsString
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:73

Methods

addEntry

addEntry(entry: PdfXRefStreamEntry): PdfXRefStream
Parameters
- entry: PdfXRefStreamEntry
Returns PdfXRefStream
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:539

addFilter

addFilter(
    filterName:
        | "FlateDecode"
        | "Fl"
        | "ASCIIHexDecode"
        | "ASCII85Decode"
        | "LZWDecode"
        | "RunLengthDecode"
        | "CCITTFaxDecode"
        | "DCTDecode"
        | "JPXDecode"
        | "Crypt",
): PdfXRefStream
Parameters
- filterName:
      | "FlateDecode"
      | "Fl"
      | "ASCIIHexDecode"
      | "ASCII85Decode"
      | "LZWDecode"
      | "RunLengthDecode"
      | "CCITTFaxDecode"
      | "DCTDecode"
      | "JPXDecode"
      | "Crypt"
Returns PdfXRefStream
Inherited from PdfStream.addFilter
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:95

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 PdfStream.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:65

clone

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

Returns this
Overrides PdfStream.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:681

decode

decode(): ByteArray
Returns ByteArray
Inherited from PdfStream.decode
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:187

equals

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

getEntries

getEntries(): PdfXRefStreamEntry[]
Returns PdfXRefStreamEntry[]
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:669

getEntryStream

getEntryStream(): Generator<PdfXRefStreamEntry>
Returns Generator<PdfXRefStreamEntry>
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:585

getFilters

getFilters(): (
    | "FlateDecode"
    | "Fl"
    | "ASCIIHexDecode"
    | "ASCII85Decode"
    | "LZWDecode"
    | "RunLengthDecode"
    | "CCITTFaxDecode"
    | "DCTDecode"
    | "JPXDecode"
    | "Crypt"
)[]
Returns (
    | "FlateDecode"
    | "Fl"
    | "ASCIIHexDecode"
    | "ASCII85Decode"
    | "LZWDecode"
    | "RunLengthDecode"
    | "CCITTFaxDecode"
    | "DCTDecode"
    | "JPXDecode"
    | "Crypt"
)[]
Inherited from PdfStream.getFilters
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:77

isModified

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

Returns boolean
Inherited from PdfStream.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:22

isType

isType(name: string): boolean
Parameters
- name: string
Returns boolean
Inherited from PdfStream.isType
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:238

parseAs

parseAs<T extends PdfStream<PdfDictionary<PdfDictionaryEntries>>>(
    Class: new (
        options: {
            header: PdfDictionary;
            isModified?: boolean;
            original: ByteArray;
        },
    ) => T,
): T
Type Parameters
- T extends PdfStream<PdfDictionary<PdfDictionaryEntries>>
Parameters
- Class: new (
      options: {
          header: PdfDictionary;
          isModified?: boolean;
          original: ByteArray;
      },
  ) => T
Returns T
Inherited from PdfStream.parseAs
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:207

removeAllFilters

removeAllFilters(): PdfXRefStream
Returns PdfXRefStream
Inherited from PdfStream.removeAllFilters
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:180

removeFilter

removeFilter(
    filterName:
        | "FlateDecode"
        | "Fl"
        | "ASCIIHexDecode"
        | "ASCII85Decode"
        | "LZWDecode"
        | "RunLengthDecode"
        | "CCITTFaxDecode"
        | "DCTDecode"
        | "JPXDecode"
        | "Crypt",
): PdfXRefStream
Parameters
- filterName:
      | "FlateDecode"
      | "Fl"
      | "ASCIIHexDecode"
      | "ASCII85Decode"
      | "LZWDecode"
      | "RunLengthDecode"
      | "CCITTFaxDecode"
      | "DCTDecode"
      | "JPXDecode"
      | "Crypt"
Returns PdfXRefStream
Inherited from PdfStream.removeFilter
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:142

removePredictor

removePredictor(): PdfXRefStream
Returns PdfXRefStream
Inherited from PdfStream.removePredictor
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:173

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 PdfStream.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:27

setPredictor

setPredictor(
    predictorParams: {
        BitsPerComponent?: number;
        Colors?: number;
        Columns?: number;
        Predictor?: number;
    },
): PdfXRefStream
Parameters
- predictorParams: {
      BitsPerComponent?: number;
      Colors?: number;
      Columns?: number;
      Predictor?: number;
  }
Returns PdfXRefStream
Inherited from PdfStream.setPredictor
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:116

toBytes

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

`Protected`tokenize

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

Returns PdfToken[]
Inherited from PdfStream.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:227

toString

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

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

toTokens

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

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

`Static`applyFilters

applyFilters(
    data: ByteArray,
    filters: (
        | "FlateDecode"
        | "Fl"
        | "ASCIIHexDecode"
        | "ASCII85Decode"
        | "LZWDecode"
        | "RunLengthDecode"
        | "CCITTFaxDecode"
        | "DCTDecode"
        | "JPXDecode"
        | "Crypt"
    )[],
): ByteArray
Parameters
- data: ByteArray
- filters: (
      | "FlateDecode"
      | "Fl"
      | "ASCIIHexDecode"
      | "ASCII85Decode"
      | "LZWDecode"
      | "RunLengthDecode"
      | "CCITTFaxDecode"
      | "DCTDecode"
      | "JPXDecode"
      | "Crypt"
  )[]
Returns ByteArray
Inherited from PdfStream.applyFilters
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:269

`Static`createNewHeader

createNewHeader(): PdfDictionary
Returns PdfDictionary
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:432

`Static`fromEntries

fromEntries(
entries: PdfXRefStreamEntry[],
headerDict?: PdfDictionary,
): PdfXRefStream
Parameters
- entries: PdfXRefStreamEntry[]
- headerDict: PdfDictionary = ...
Returns PdfXRefStream
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:448

`Static`getAllFilters

getAllFilters(): {
    ASCII85Decode: PdfFilter;
    ASCIIHexDecode: PdfFilter;
    CCITTFaxDecode: PdfFilter;
    Crypt: PdfFilter;
    DCTDecode: PdfFilter;
    Fl: PdfFilter;
    FlateDecode: PdfFilter;
    JPXDecode: PdfFilter;
    LZWDecode: PdfFilter;
    RunLengthDecode: PdfFilter;
}
Returns {
    ASCII85Decode: PdfFilter;
    ASCIIHexDecode: PdfFilter;
    CCITTFaxDecode: PdfFilter;
    Crypt: PdfFilter;
    DCTDecode: PdfFilter;
    Fl: PdfFilter;
    FlateDecode: PdfFilter;
    JPXDecode: PdfFilter;
    LZWDecode: PdfFilter;
    RunLengthDecode: PdfFilter;
}
Inherited from PdfStream.getAllFilters
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:252

`Static`getFilter

getFilter(
    name:
        | "FlateDecode"
        | "Fl"
        | "ASCIIHexDecode"
        | "ASCII85Decode"
        | "LZWDecode"
        | "RunLengthDecode"
        | "CCITTFaxDecode"
        | "DCTDecode"
        | "JPXDecode"
        | "Crypt",
): PdfFilter
Parameters
- name:
      | "FlateDecode"
      | "Fl"
      | "ASCIIHexDecode"
      | "ASCII85Decode"
      | "LZWDecode"
      | "RunLengthDecode"
      | "CCITTFaxDecode"
      | "DCTDecode"
      | "JPXDecode"
      | "Crypt"
Returns PdfFilter
Inherited from PdfStream.getFilter
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:243

Class PdfXRefStream

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfXRefStream

Properties

header

Protectedmodified

original

OptionalpostStreamDataTokens

OptionalpostTokens

OptionalpreStreamDataTokens

OptionalpreTokens

Accessors

objectType

Returns string

originalAsString

Returns string

prev

Returns PdfNumber | undefined

raw

Returns ByteArray

Parameters

Returns void

rawAsString

Returns string

Methods

addEntry

Parameters

Returns PdfXRefStream

addFilter

Parameters

Returns PdfXRefStream

as

Type Parameters

Parameters

Returns T

clone

Returns this

decode

Returns ByteArray

equals

Parameters

Returns boolean

getEntries

Returns PdfXRefStreamEntry[]

getEntryStream

Returns Generator<PdfXRefStreamEntry>

getFilters

Returns ( | "FlateDecode" | "Fl" | "ASCIIHexDecode" | "ASCII85Decode" | "LZWDecode" | "RunLengthDecode" | "CCITTFaxDecode" | "DCTDecode" | "JPXDecode" | "Crypt")[]

isModified

Returns boolean

isType

Parameters

Returns boolean

parseAs

Type Parameters

Parameters

Returns T

removeAllFilters

Returns PdfXRefStream

removeFilter

Parameters

Returns PdfXRefStream

removePredictor

Returns PdfXRefStream

setModified

Parameters

Returns void

setPredictor

Parameters

Returns PdfXRefStream

toBytes

Parameters

`Protected`modified

`Optional`postStreamDataTokens

`Optional`postTokens

`Optional`preStreamDataTokens

`Optional`preTokens

Returns (
| "FlateDecode"
| "Fl"
| "ASCIIHexDecode"
| "ASCII85Decode"
| "LZWDecode"
| "RunLengthDecode"
| "CCITTFaxDecode"
| "DCTDecode"
| "JPXDecode"
| "Crypt"
)[]

`Protected`tokenize

`Static`applyFilters

`Static`createNewHeader

`Static`fromEntries

`Static`getAllFilters

Returns {
ASCII85Decode: PdfFilter;
ASCIIHexDecode: PdfFilter;
CCITTFaxDecode: PdfFilter;
Crypt: PdfFilter;
DCTDecode: PdfFilter;
Fl: PdfFilter;
FlateDecode: PdfFilter;
JPXDecode: PdfFilter;
LZWDecode: PdfFilter;
RunLengthDecode: PdfFilter;
}

`Static`getFilter