# PageLabelingRangeMap

## Content

# Class: PageLabelingRangeMap

The dictionary of page labeling ranges.

## Extends

- `PdfNumberMap`<[`PageLabelingRange`](PageLabelingRange)>

## Accessors

### count

#### Get Signature

```ts
get count(): number;
```

Gets the number of items in the map.

##### Returns

`number`

#### Overrides

```ts
PdfNumberMap.count
```

***

### id

#### Get Signature

```ts
get id(): number;
```

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

```ts
PdfNumberMap.id
```

***

### om

#### Get Signature

```ts
get om(): ObjectManager;
```

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

```ts
PdfNumberMap.om
```

## Methods

### add()

```ts
add(key, item): void;
```

Adds the item with the specified key.

#### Parameters

##### key

`number`

The item key.

##### item

[`PageLabelingRange`](PageLabelingRange)

The item to add.

#### Returns

`void`

#### Overrides

```ts
PdfNumberMap.add
```

***

### clear()

```ts
clear(): void;
```

Clears the collection.

#### Returns

`void`

#### Overrides

```ts
PdfNumberMap.clear
```

***

### contains()

```ts
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

```ts
PdfNumberMap.contains
```

***

### free()

```ts
free(): void;
```

Detaches the object from the [ObjectManager](ObjectManager) and deallocates its memory, if possible.

#### Returns

`void`

#### Inherited from

```ts
PdfNumberMap.free
```

***

### get()

```ts
get(key): PageLabelingRange;
```

Gets the item with the specified key.

#### Parameters

##### key

`number`

The key of the item.

#### Returns

[`PageLabelingRange`](PageLabelingRange)

#### Overrides

```ts
PdfNumberMap.get
```

***

### rebind()

```ts
rebind(omTo): void;
```

Rebinds the object from the current [ObjectManager](ObjectManager) to the specified one.

#### Parameters

##### omTo

[`ObjectManager`](ObjectManager)

The new [ObjectManager](ObjectManager) for the object.

#### Returns

`void`

#### Inherited from

```ts
PdfNumberMap.rebind
```

***

### remove()

```ts
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

```ts
PdfNumberMap.remove
```

***

### set()

```ts
set(key, item): void;
```

Sets the item with the specified key.

#### Parameters

##### key

`number`

The item key.

##### item

[`PageLabelingRange`](PageLabelingRange)

The object to set.

#### Returns

`void`

#### Overrides

```ts
PdfNumberMap.set
```