Class: BorderEffect

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

Extends

• ObjectBase

Accessors

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

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;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om

---

type

Get Signature

get type(): BorderEffectType;

Gets or sets the border effect type.

Returns

BorderEffectType

Set Signature

set type(value): void;

Gets or sets the border effect type.

Parameters

value

BorderEffectType

Returns

void

Methods

free()

free(): void;

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

Returns

void

Inherited from

ObjectBase.free

---

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