Class PdfHexadecimal

Hierarchy (View Summary)

PdfObject
- PdfHexadecimal

Index

Constructors

Properties

modified postTokens? preTokens? raw

Accessors

bytes objectType

Methods

as clone equals isModified setModified toBytes toHexBytes toHexString tokenize toString toTokens toHexadecimal

Constructors

constructor

new PdfHexadecimal(
value: string | ByteArray,
format?: "hex" | "bytes",
): PdfHexadecimal
Parameters
- value: string | ByteArray
- format: "hex" | "bytes" = 'hex'
Returns PdfHexadecimal
Overrides PdfObject.constructor
- Defined in packages/pdf-lite/src/core/objects/pdf-hexadecimal.ts:16

Properties

`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

raw

The raw byte value represented by this hexadecimal object. NB: This is the hexadecimal representation, not the actual byte values.

Accessors

bytes

get bytes(): ByteArray
Returns ByteArray
- Defined in packages/pdf-lite/src/core/objects/pdf-hexadecimal.ts:35

objectType

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

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

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 PdfObject.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 PdfObject.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-hexadecimal.ts:51

equals

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

isModified

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

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

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

toBytes

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

toHexBytes

toHexBytes(): ByteArray
Returns ByteArray
- Defined in packages/pdf-lite/src/core/objects/pdf-hexadecimal.ts:39

toHexString

toHexString(): string
Returns string
- Defined in packages/pdf-lite/src/core/objects/pdf-hexadecimal.ts:43

`Protected`tokenize

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

Returns PdfHexadecimalToken[]
Overrides PdfObject.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-hexadecimal.ts:47

toString

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

Returns string
Inherited from PdfObject.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 PdfObject.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:32

`Static`toHexadecimal

toHexadecimal(data: string | ByteArray): PdfHexadecimal
Parameters
- data: string | ByteArray
Returns PdfHexadecimal
- Defined in packages/pdf-lite/src/core/objects/pdf-hexadecimal.ts:31