[]
        
(Showing Draft Content)

Border

DsPdfJS API v9.1.0


DsPdfJS API / Border

Class: Border

Defines properties of the annotation's border.

Extends

Constructors

Constructor

new Border(om?): Border

Creates a new Border.

Parameters

om?

ObjectManager

ObjectManager that controls the lifetime of the Border.

Returns

Border

Overrides

ObjectBase.constructor

Constructor

new Border(): Border

Creates a new Border.

Returns

Border

Overrides

ObjectBase.constructor

Accessors

color

Get Signature

get color(): Color

Gets or sets the border color.

Returns

Color

Set Signature

set color(value): void

Gets or sets the border color.

Parameters
value

Color

Returns

void


dashPattern

Get Signature

get dashPattern(): number[] | null

Gets or sets the dash pattern, used if 'style' == 'BorderStyle.Dashed'.

Returns

number[] | null

Set Signature

set dashPattern(value): void

Gets or sets the dash pattern, used if 'style' == 'BorderStyle.Dashed'.

Parameters
value

number[] | null

Returns

void


id

Get Signature

get id(): number

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id


om

Get Signature

get om(): ObjectManager

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om


style

Get Signature

get style(): BorderStyle

Gets or sets the border style.

Returns

BorderStyle

Set Signature

set style(value): void

Gets or sets the border style.

Parameters
value

BorderStyle

Returns

void


width

Get Signature

get width(): number

Gets or sets the border's width in points (1/72 inch).

Returns

number

Set Signature

set width(value): void

Gets or sets the border's width in points (1/72 inch).

Parameters
value

number

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