Class: Attr

Represents a base structure attribute.

Conceptually an Attr is a dictionary whose keys are PDF names and whose values are PDF objects. Use Attr#putValue and Attr#removeValue to manipulate the entries.

Extends

• ObjectBase

Constructors

Constructor

new Attr(): Attr;

Creates a new empty Attr object.

Returns

Attr

Overrides

ObjectBase.constructor

Constructor

new Attr(om): Attr;

Creates a new empty Attr object.

Parameters

om

ObjectManager

An object manager that controls the lifetime of the Attr object.

Returns

Attr

Overrides

ObjectBase.constructor

Accessors

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id

---

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om

Methods

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ObjectBase.free

---

putValue()

putValue(key, value): void;

Sets the value associated with the specified key.

Parameters

key

string

The entry key (a PDF name).

value

PdfValue

The value to set.

Returns

void

---

rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ObjectBase.rebind

---

removeValue()

removeValue(key): void;

Removes the value associated with the specified key.

Parameters

key

string

The entry key (a PDF name).

Returns

void