Class: PageLabelingRangeMap

The dictionary of page labeling ranges.

Extends

• PdfNumberMap<PageLabelingRange>

Accessors

count

Get Signature

get count(): number;

Gets the number of items in the map.

Returns

number

Overrides

PdfNumberMap.count

---

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

PdfNumberMap.id

---

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

PdfNumberMap.om

Methods

add()

add(key, item): void;

Adds the item with the specified key.

Parameters

key

number

The item key.

item

PageLabelingRange

The item to add.

Returns

void

Overrides

PdfNumberMap.add

---

clear()

clear(): void;

Clears the collection.

Returns

void

Overrides

PdfNumberMap.clear

---

contains()

contains(key): boolean;

Determines whether the specified key is in the collection.

Parameters

key

number

Returns

boolean

true if the key is in the collection, false otherwise.

Overrides

PdfNumberMap.contains

---

free()

free(): void;

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

Returns

void

Inherited from

PdfNumberMap.free

---

get()

get(key): PageLabelingRange;

Gets the item with the specified key.

Parameters

key

number

The key of the item.

Returns

PageLabelingRange

Overrides

PdfNumberMap.get

---

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

PdfNumberMap.rebind

---

remove()

remove(key): boolean;

Removes the item with specified key from the collection.

Parameters

key

number

The key to remove.

Returns

boolean

true if the item with specified key was actually removed, false otherwise.

Overrides

PdfNumberMap.remove

---

set()

set(key, item): void;

Sets the item with the specified key.

Parameters

key

number

The item key.

item

PageLabelingRange

The object to set.

Returns

void

Overrides

PdfNumberMap.set