Class PdfStreamPredictor

Hierarchy (View Summary)

PdfDictionary<
    {
        BitsPerComponent?: PdfNumber;
        Colors?: PdfNumber;
        Columns?: PdfNumber;
        Predictor?: PdfNumber;
    },
>
- PdfStreamPredictor

Constructors

constructor

new PdfStreamPredictor(
    entries?:
        | PdfDictionaryMap
        | {
            BitsPerComponent?: PdfNumber;
            Colors?: PdfNumber;
            Columns?: PdfNumber;
            Predictor?: PdfNumber;
        },
): PdfStreamPredictor
Parameters
- Optionalentries:
      | PdfDictionaryMap
      | {
          BitsPerComponent?: PdfNumber;
          Colors?: PdfNumber;
          Columns?: PdfNumber;
          Predictor?: PdfNumber;
      }
Returns PdfStreamPredictor
Inherited from PdfDictionary.constructor
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:19

Properties

`Protected` `Optional`cachedTokens

cachedTokens?: PdfToken[]

Cached byte representation of the object, if available

`Protected`immutable

immutable: boolean = false

Indicates whether the object is immutable (cannot be modified)

innerTokens

innerTokens: PdfToken[] = []

`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

`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`NONE

NONE: PdfStreamPredictor = ...

`Static`PNG_AVERAGE

PNG_AVERAGE: PdfStreamPredictor = ...

`Static`PNG_NONE

PNG_NONE: PdfStreamPredictor = ...

`Static`PNG_OPTIMUM

PNG_OPTIMUM: PdfStreamPredictor = ...

`Static`XREF_STREAM

XREF_STREAM: PdfStreamPredictor = ...

Accessors

bitsPerComponent

get bitsPerComponent(): number
Returns number
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:71
set bitsPerComponent(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:75

colors

get colors(): number
Returns number
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:63
set colors(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:67

columns

get columns(): number
Returns number
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:55
set columns(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:59

isTrailingDelimited

get isTrailingDelimited(): boolean
Returns true if this object's serialized form ends with a self-delimiting character (e.g., ), >, ], >>). Such objects do not require trailing whitespace before the next token.

Returns boolean
Inherited from PdfDictionary.isTrailingDelimited
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:120

objectType

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

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

predictor

get predictor(): number
Returns number
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:47
set predictor(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:51

values

get values(): { readonly [K in string]: T[K] }
Returns { readonly [K in string]: T[K] }
Inherited from PdfDictionary.values
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:95

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

clone

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

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

cloneImpl

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

Returns this
Overrides PdfDictionary.cloneImpl
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:92

copyFrom

copyFrom(other: PdfDictionary<any>): void
Parameters
- other: PdfDictionary<any>
Returns void
Inherited from PdfDictionary.copyFrom
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:171

decode

decode(data: ByteArray): ByteArray
Parameters
- data: ByteArray
Returns ByteArray
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:149

delete

delete<K extends "Predictor" | "Columns" | "Colors" | "BitsPerComponent">(
key: K | PdfName<K>,
): void
Type Parameters
- K extends "Predictor" | "Columns" | "Colors" | "BitsPerComponent"
Parameters
- key: K | PdfName<K>
Returns void
Inherited from PdfDictionary.delete
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:64

encode

encode(data: ByteArray, filterType?: number): ByteArray
Parameters
- data: ByteArray
- filterType: number = 0
Returns ByteArray
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:132

entries

entries(): IterableIterator<[string, PdfObject | undefined]>
Returns an iterator for the dictionary entries. Each entry is a tuple of [key string, value].

Returns IterableIterator<[string, PdfObject | undefined]>
Inherited from PdfDictionary.entries
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:112

equals

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

get

get<K extends "Predictor" | "Columns" | "Colors" | "BitsPerComponent">(
    key: K | PdfName<K>,
):
    | {
        BitsPerComponent?: PdfNumber;
        Colors?: PdfNumber;
        Columns?: PdfNumber;
        Predictor?: PdfNumber;
    }[K]
    | undefined
Type Parameters
- K extends "Predictor" | "Columns" | "Colors" | "BitsPerComponent"
Parameters
- key: K | PdfName<K>
Returns
    | {
        BitsPerComponent?: PdfNumber;
        Colors?: PdfNumber;
        Columns?: PdfNumber;
        Predictor?: PdfNumber;
    }[K]
    | undefined
Inherited from PdfDictionary.get
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:30

has

has<K extends "Predictor" | "Columns" | "Colors" | "BitsPerComponent">(
key: K | PdfName<K>,
): boolean
Type Parameters
- K extends "Predictor" | "Columns" | "Colors" | "BitsPerComponent"
Parameters
- key: K | PdfName<K>
Returns boolean
Inherited from PdfDictionary.has
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:82

isImmutable

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

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

isModified

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

Returns boolean
Inherited from PdfDictionary.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:194

set

set<K extends "Predictor" | "Columns" | "Colors" | "BitsPerComponent">(
    key: K | PdfName<K>,
    value: {
        BitsPerComponent?: PdfNumber;
        Colors?: PdfNumber;
        Columns?: PdfNumber;
        Predictor?: PdfNumber;
    }[K],
): void
Type Parameters
- K extends "Predictor" | "Columns" | "Colors" | "BitsPerComponent"
Parameters
- key: K | PdfName<K>
- value: {
      BitsPerComponent?: PdfNumber;
      Colors?: PdfNumber;
      Columns?: PdfNumber;
      Predictor?: PdfNumber;
  }[K]
Returns void
Inherited from PdfDictionary.set
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:44

setImmutable

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

setModified

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

toBase64

toBase64(): string
Serializes the document to a Base64-encoded string.

Returns string
A promise that resolves to the PDF document as a Base64 string
Inherited from PdfDictionary.toBase64
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:156

toBytes

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

toDecodeParms

toDecodeParms(): DecodeParms
Returns DecodeParms
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:79

`Protected`tokenize

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

Returns PdfToken[]
Inherited from PdfDictionary.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:124

toString

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

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

toTokens

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

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

`Static`fromDecodeParms

fromDecodeParms(params: DecodeParms): PdfStreamPredictor
Parameters
- params: DecodeParms
Returns PdfStreamPredictor
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:96

`Static`fromDictionary

fromDictionary(
dict?: PdfDictionary<PdfDictionaryEntries>,
): PdfStreamPredictor | undefined
Parameters
- Optionaldict: PdfDictionary<PdfDictionaryEntries>
Returns PdfStreamPredictor | undefined
- Defined in packages/pdf-lite/src/core/objects/pdf-stream.ts:113

Class PdfStreamPredictor

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfStreamPredictor

Properties

Protected OptionalcachedTokens

Protectedimmutable

innerTokens

Protectedmodified

OptionalpostTokens

OptionalpreTokens

StaticNONE

StaticPNG_AVERAGE

StaticPNG_NONE

StaticPNG_OPTIMUM

StaticPNG_PAETH

StaticPNG_SUB

StaticPNG_UP

StaticTIFF

StaticXREF_STREAM

Accessors

bitsPerComponent

Returns number

Parameters

Returns void

colors

Returns number

Parameters

Returns void

columns

Returns number

Parameters

Returns void

isTrailingDelimited

Returns boolean

objectType

Returns string

predictor

Returns number

Parameters

Returns void

values

Returns { readonly [K in string]: T[K] }

Methods

as

Type Parameters

Parameters

Returns T

clone

Returns this

cloneImpl

Returns this

copyFrom

Parameters

Returns void

decode

Parameters

Returns ByteArray

delete

Type Parameters

Parameters

Returns void

encode

Parameters

Returns ByteArray

entries

Returns IterableIterator<[string, PdfObject | undefined]>

equals

Parameters

Returns boolean

get

Type Parameters

Parameters

`Protected` `Optional`cachedTokens

`Protected`immutable

`Protected`modified

`Optional`postTokens

`Optional`preTokens

`Static`NONE

`Static`PNG_AVERAGE

`Static`PNG_NONE

`Static`PNG_OPTIMUM

`Static`PNG_PAETH

`Static`PNG_SUB

`Static`PNG_UP

`Static`TIFF

`Static`XREF_STREAM

Returns
| {
BitsPerComponent?: PdfNumber;
Colors?: PdfNumber;
Columns?: PdfNumber;
Predictor?: PdfNumber;
}[K]
| undefined

`Protected`tokenize

`Static`fromDecodeParms

`Static`fromDictionary