Class Border

Defines properties of the annotation's border.

Hierarchy (View Summary)

ObjectBase
- Border

Index

Constructors

Accessors

color dashPattern id om style width

Methods

Constructors

constructor

new Border(om?: ObjectManager): Border
Creates a new Border.
Parameters
- Optionalom: ObjectManager
  ObjectManager that controls the lifetime of the Border.
Returns Border
Overrides ObjectBase.constructor
new Border(): Border
Creates a new Border.

Returns Border
Overrides ObjectBase.constructor

Accessors

color

get color(): Color
Gets or sets the border color.

Returns Color
set color(value: Color): void
Gets or sets the border color.
Parameters
- value: Color
Returns void

dashPattern

get dashPattern(): number[] | null
Gets or sets the dash pattern, used if 'style' == 'BorderStyle.Dashed'.

Returns number[] | null
set dashPattern(value: number[] | null): void
Gets or sets the dash pattern, used if 'style' == 'BorderStyle.Dashed'.
Parameters
- value: number[] | null
Returns void

id

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

Returns number
Inherited from ObjectBase.id

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

style

get style(): BorderStyle
Gets or sets the border style.

Returns BorderStyle
set style(value: BorderStyle): void
Gets or sets the border style.
Parameters
- value: BorderStyle
Returns void

width

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

Returns number
set width(value: number): 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: 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