Class BorderEffect

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

Hierarchy (View Summary)

ObjectBase
- BorderEffect

Index

Accessors

id intensity om type

Methods

Accessors

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

intensity

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

Returns number
set intensity(value: number): 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 om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

type

get type(): BorderEffectType
Gets or sets the border effect type.

Returns BorderEffectType
set type(value: BorderEffectType): 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: ObjectManager): 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