# BorderEffect

## Content

[**DsPdfJS API v9.1.3**](../README)

***

[DsPdfJS API](../globals) / BorderEffect

# Class: BorderEffect

Represents an effect to be applied to the border of an annotation.

## Extends

- [`ObjectBase`](ObjectBase)

## Accessors

### id

#### Get Signature

> **get** **id**(): `number`

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

[`ObjectBase`](ObjectBase).[`id`](ObjectBase#id)

***

### intensity

#### Get Signature

> **get** **intensity**(): `number`

Gets or sets a number describing the intensity of the effect. Suggested values range from 0 to 2.

##### Returns

`number`

#### Set Signature

> **set** **intensity**(`value`): `void`

Gets or sets a number describing the intensity of the effect. Suggested values range from 0 to 2.

##### Parameters

###### value

`number`

##### Returns

`void`

***

### om

#### Get Signature

> **get** **om**(): [`ObjectManager`](ObjectManager)

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

[`ObjectBase`](ObjectBase).[`om`](ObjectBase#om)

***

### type

#### Get Signature

> **get** **type**(): [`BorderEffectType`](../enumerations/BorderEffectType)

Gets or sets the border effect type.

##### Returns

[`BorderEffectType`](../enumerations/BorderEffectType)

#### Set Signature

> **set** **type**(`value`): `void`

Gets or sets the border effect type.

##### Parameters

###### value

[`BorderEffectType`](../enumerations/BorderEffectType)

##### Returns

`void`

## Methods

### free()

> **free**(): `void`

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

#### Returns

`void`

#### Inherited from

[`ObjectBase`](ObjectBase).[`free`](ObjectBase#free)

***

### rebind()

> **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

[`ObjectBase`](ObjectBase).[`rebind`](ObjectBase#rebind)