happypdf / AppearanceCharacteristics

Class: AppearanceCharacteristics

Defined in: src/core/annotation/AppearanceCharacteristics.ts:8

Constructors

Constructor

protected new AppearanceCharacteristics(dict): AppearanceCharacteristics;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:14

Parameters

Parameter	Type
dict	PDFDict

Returns

AppearanceCharacteristics

Properties

dict

readonly dict: PDFDict;

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

Methods

AC()

AC(): 
  | PDFHexString
  | PDFString
  | undefined;

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

Returns

| PDFHexString | PDFString | undefined

---

BC()

BC(): PDFArray | undefined;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:24

Returns

PDFArray | undefined

---

BG()

BG(): PDFArray | undefined;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:30

Returns

PDFArray | undefined

---

CA()

CA(): 
  | PDFHexString
  | PDFString
  | undefined;

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

Returns

| PDFHexString | PDFString | undefined

---

fromDict()

static fromDict(dict): AppearanceCharacteristics;

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

Parameters

Parameter	Type
dict	PDFDict

Returns

AppearanceCharacteristics

---

getBackgroundColor()

getBackgroundColor(): number[] | undefined;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:72

Returns

number[] | undefined

---

getBorderColor()

getBorderColor(): number[] | undefined;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:58

Returns

number[] | undefined

---

getCaptions()

getCaptions(): {
  down?: string;
  normal?: string;
  rollover?: string;
};

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

Returns

{
  down?: string;
  normal?: string;
  rollover?: string;
}

down?

optional down?: string;

normal?

optional normal?: string;

rollover?

optional rollover?: string;

---

getRotation()

getRotation(): number | undefined;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:54

Returns

number | undefined

---

R()

R(): PDFNumber | undefined;

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

Returns

PDFNumber | undefined

---

RC()

RC(): 
  | PDFHexString
  | PDFString
  | undefined;

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

Returns

| PDFHexString | PDFString | undefined

---

setBackgroundColor()

setBackgroundColor(color): void;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:108

Parameters

Parameter	Type
color	number[]

Returns

void

---

setBorderColor()

setBorderColor(color): void;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:103

Parameters

Parameter	Type
color	number[]

Returns

void

---

setCaptions()

setCaptions(captions): void;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:113

Parameters

Parameter	Type
captions	{ down?: string; normal: string; rollover?: string; }
captions.down?	string
captions.normal	string
captions.rollover?	string

Returns

void

---

setRotation()

setRotation(rotation): void;

Defined in: src/core/annotation/AppearanceCharacteristics.ts:98

Parameters

Parameter	Type
rotation	number

Returns

void