Class PdfAnnotationFlags

Provides annotation flag (F field) accessors for PDF annotations. These are generic to all annotation types per the PDF spec.

Hierarchy (View Summary)

PdfNumber
- PdfAnnotationFlags

Index

Constructors

constructor

new PdfAnnotationFlags(value?: number): PdfAnnotationFlags
Parameters
- value: number = 0
Returns PdfAnnotationFlags
Overrides PdfNumber.constructor
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:8

Properties

decimalPlaces

decimalPlaces: number

`Protected`immutable

immutable: boolean = false

Indicates whether the object is immutable (cannot be modified)

isByteOffset

isByteOffset: boolean = false

`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

padTo

padTo: 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

Accessors

annotationFlags

get annotationFlags(): number
Returns number
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:12
set annotationFlags(flags: number): void
Parameters
- flags: number
Returns void
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:16

hidden

get hidden(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:32
set hidden(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:36

invisible

get invisible(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:20
set invisible(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:24

locked

get locked(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:92
set locked(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:96

noRotate

get noRotate(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:68
set noRotate(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:72

noView

get noView(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:80
set noView(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:84

noZoom

get noZoom(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:56
set noZoom(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:60

objectType

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

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

print

get print(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:44
set print(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-flags.ts:48

ref

get ref(): Ref<number>
Returns Ref<number>
Inherited from PdfNumber.ref
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:54

value

get value(): number
Returns number
Inherited from PdfNumber.value
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:58
set value(value: number): void
Parameters
- value: number
Returns void
Inherited from PdfNumber.value
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:62

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 PdfNumber.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 PdfNumber.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 PdfNumber.cloneImpl
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:86

equals

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

isImmutable

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

Returns boolean
Inherited from PdfNumber.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 PdfNumber.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:95

onChange

onChange(callback: (value: number) => void): void
Parameters
- callback: (value: number) => void
Returns void
Inherited from PdfNumber.onChange
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:69

setImmutable

setImmutable(immutable?: boolean): void
Sets the immutable state of the object
Parameters
- immutable: boolean = true
Returns void
Inherited from PdfNumber.setImmutable
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:39

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 PdfNumber.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 PdfNumber.toBytes
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:53

`Protected`tokenize

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

Returns PdfNumberToken[]
Inherited from PdfNumber.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:82

toString

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

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

toToken

toToken(): PdfNumberToken
Returns PdfNumberToken
Inherited from PdfNumber.toToken
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:73

toTokens

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

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

Class PdfAnnotationFlags

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfAnnotationFlags

Properties

decimalPlaces

Protectedimmutable

isByteOffset

Protectedmodified

padTo

OptionalpostTokens

OptionalpreTokens

Accessors

annotationFlags

Returns number

Parameters

Returns void

hidden

Returns boolean

Parameters

Returns void

invisible

Returns boolean

Parameters

Returns void

locked

Returns boolean

Parameters

Returns void

noRotate

Returns boolean

Parameters

Returns void

noView

Returns boolean

Parameters

Returns void

noZoom

Returns boolean

Parameters

Returns void

objectType

Returns string

print

Returns boolean

Parameters

Returns void

ref

Returns Ref<number>

value

Returns number

Parameters

Returns void

Methods

as

Type Parameters

Parameters

Returns T

clone

Returns this

cloneImpl

Returns this

equals

Parameters

Returns boolean

isImmutable

Returns boolean

isModified

Returns boolean

onChange

Parameters

Returns void

setImmutable

`Protected`immutable

`Protected`modified

`Optional`postTokens

`Optional`preTokens

`Protected`tokenize