happypdf / PDFWidgetAnnotation

Class: PDFWidgetAnnotation

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:11

Extends

• PDFAnnotation

Constructors

Constructor

protected new PDFWidgetAnnotation(dict): PDFWidgetAnnotation;

Defined in: src/core/annotation/PDFAnnotation.ts:13

Parameters

Parameter	Type
dict	PDFDict

Returns

PDFWidgetAnnotation

Inherited from

PDFAnnotation.constructor

Properties

dict

readonly dict: PDFDict;

Defined in: src/core/annotation/PDFAnnotation.ts:9

Inherited from

PDFAnnotation.dict

Methods

AP()

AP(): PDFDict | undefined;

Defined in: src/core/annotation/PDFAnnotation.ts:22

Returns

PDFDict | undefined

Inherited from

PDFAnnotation.AP

---

BS()

BS(): PDFDict | undefined;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:31

Returns

PDFDict | undefined

---

clearFlag()

clearFlag(flag): void;

Defined in: src/core/annotation/PDFAnnotation.ts:137

Parameters

Parameter	Type
flag	number

Returns

void

Inherited from

PDFAnnotation.clearFlag

---

create()

static create(context, parent): PDFWidgetAnnotation;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:15

Parameters

Parameter	Type
context	PDFContext
parent	PDFRef

Returns

PDFWidgetAnnotation

---

DA()

DA(): 
  | PDFHexString
  | PDFString
  | undefined;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:37

Returns

| PDFHexString | PDFString | undefined

---

ensureAP()

ensureAP(): PDFDict;

Defined in: src/core/annotation/PDFAnnotation.ts:56

Returns

PDFDict

Inherited from

PDFAnnotation.ensureAP

---

F()

F(): PDFNumber | undefined;

Defined in: src/core/annotation/PDFAnnotation.ts:26

Returns

PDFNumber | undefined

Inherited from

PDFAnnotation.F

---

fromDict()

static fromDict(dict): PDFWidgetAnnotation;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:12

Parameters

Parameter	Type
dict	PDFDict

Returns

PDFWidgetAnnotation

Overrides

PDFAnnotation.fromDict

---

getAppearanceCharacteristics()

getAppearanceCharacteristics(): AppearanceCharacteristics | undefined;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:67

Returns

AppearanceCharacteristics | undefined

---

getAppearances()

getAppearances(): 
  | {
  down?: PDFStream | PDFDict;
  normal: PDFStream | PDFDict;
  rollover?: PDFStream | PDFDict;
}
  | undefined;

Defined in: src/core/annotation/PDFAnnotation.ts:101

Returns

| { down?: PDFStream | PDFDict; normal: PDFStream | PDFDict; rollover?: PDFStream | PDFDict; } | undefined

Inherited from

PDFAnnotation.getAppearances

---

getAppearanceState()

getAppearanceState(): PDFName | undefined;

Defined in: src/core/annotation/PDFAnnotation.ts:42

Returns

PDFName | undefined

Inherited from

PDFAnnotation.getAppearanceState

---

getBorderStyle()

getBorderStyle(): BorderStyle | undefined;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:82

Returns

BorderStyle | undefined

---

getDefaultAppearance()

getDefaultAppearance(): string | undefined;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:57

Returns

string | undefined

---

getFlags()

getFlags(): number;

Defined in: src/core/annotation/PDFAnnotation.ts:119

Returns

number

Inherited from

PDFAnnotation.getFlags

---

getNormalAppearance()

getNormalAppearance(): PDFRef | PDFDict;

Defined in: src/core/annotation/PDFAnnotation.ts:65

Returns

PDFRef | PDFDict

Inherited from

PDFAnnotation.getNormalAppearance

---

getOnValue()

getOnValue(): PDFName | undefined;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:97

Returns

PDFName | undefined

---

getOrCreateAppearanceCharacteristics()

getOrCreateAppearanceCharacteristics(): AppearanceCharacteristics;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:73

Returns

AppearanceCharacteristics

---

getOrCreateBorderStyle()

getOrCreateBorderStyle(): BorderStyle;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:88

Returns

BorderStyle

---

getRectangle()

getRectangle(): {
  height: number;
  width: number;
  x: number;
  y: number;
};

Defined in: src/core/annotation/PDFAnnotation.ts:31

Returns

{
  height: number;
  width: number;
  x: number;
  y: number;
}

height

height: number;

width

width: number;

x

x: number;

y

y: number;

Inherited from

PDFAnnotation.getRectangle

---

hasFlag()

hasFlag(flag): boolean;

Defined in: src/core/annotation/PDFAnnotation.ts:127

Parameters

Parameter	Type
flag	number

Returns

boolean

Inherited from

PDFAnnotation.hasFlag

---

MK()

MK(): PDFDict | undefined;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:25

Returns

PDFDict | undefined

---

P()

P(): PDFRef | undefined;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:43

Returns

PDFRef | undefined

---

Rect()

Rect(): PDFArray | undefined;

Defined in: src/core/annotation/PDFAnnotation.ts:18

Returns

PDFArray | undefined

Inherited from

PDFAnnotation.Rect

---

removeDownAppearance()

removeDownAppearance(): void;

Defined in: src/core/annotation/PDFAnnotation.ts:96

Returns

void

Inherited from

PDFAnnotation.removeDownAppearance

---

removeRolloverAppearance()

removeRolloverAppearance(): void;

Defined in: src/core/annotation/PDFAnnotation.ts:91

Returns

void

Inherited from

PDFAnnotation.removeRolloverAppearance

---

setAppearances()

setAppearances(appearances): void;

Defined in: src/core/annotation/PDFAnnotation.ts:52

Parameters

Parameter	Type
appearances	PDFDict

Returns

void

Inherited from

PDFAnnotation.setAppearances

---

setAppearanceState()

setAppearanceState(state): void;

Defined in: src/core/annotation/PDFAnnotation.ts:48

Parameters

Parameter	Type
state	PDFName

Returns

void

Inherited from

PDFAnnotation.setAppearanceState

---

setDefaultAppearance()

setDefaultAppearance(appearance): void;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:53

Parameters

Parameter	Type
appearance	string

Returns

void

---

setDownAppearance()

setDownAppearance(appearance): void;

Defined in: src/core/annotation/PDFAnnotation.ts:86

Parameters

Parameter	Type	Description
appearance	PDFRef | PDFDict	A PDFDict or PDFStream (direct or ref)

Returns

void

Inherited from

PDFAnnotation.setDownAppearance

---

setFlag()

setFlag(flag): void;

Defined in: src/core/annotation/PDFAnnotation.ts:132

Parameters

Parameter	Type
flag	number

Returns

void

Inherited from

PDFAnnotation.setFlag

---

setFlags()

setFlags(flags): void;

Defined in: src/core/annotation/PDFAnnotation.ts:123

Parameters

Parameter	Type
flags	number

Returns

void

Inherited from

PDFAnnotation.setFlags

---

setFlagTo()

setFlagTo(flag, enable): void;

Defined in: src/core/annotation/PDFAnnotation.ts:142

Parameters

Parameter	Type
flag	number
enable	boolean

Returns

void

Inherited from

PDFAnnotation.setFlagTo

---

setNormalAppearance()

setNormalAppearance(appearance): void;

Defined in: src/core/annotation/PDFAnnotation.ts:74

Parameters

Parameter	Type	Description
appearance	PDFRef | PDFDict	A PDFDict or PDFStream (direct or ref)

Returns

void

Inherited from

PDFAnnotation.setNormalAppearance

---

setP()

setP(page): void;

Defined in: src/core/annotation/PDFWidgetAnnotation.ts:49

Parameters

Parameter	Type
page	PDFRef

Returns

void

---

setRectangle()

setRectangle(rect): void;

Defined in: src/core/annotation/PDFAnnotation.ts:36

Parameters

Parameter	Type
rect	{ height: number; width: number; x: number; y: number; }
rect.height	number
rect.width	number
rect.x	number
rect.y	number

Returns

void

Inherited from

PDFAnnotation.setRectangle

---

setRolloverAppearance()

setRolloverAppearance(appearance): void;

Defined in: src/core/annotation/PDFAnnotation.ts:80

Parameters

Parameter	Type	Description
appearance	PDFRef | PDFDict	A PDFDict or PDFStream (direct or ref)

Returns

void

Inherited from

PDFAnnotation.setRolloverAppearance