# Border

## Content

# Class: Border

Defines properties of the annotation's border.

## Extends

- [`ObjectBase`](ObjectBase)

## Constructors

### Constructor

```ts
new Border(om?): Border;
```

Creates a new Border.

#### Parameters

##### om?

[`ObjectManager`](ObjectManager)

[ObjectManager](ObjectManager) that controls the lifetime of the Border.

#### Returns

`Border`

#### Overrides

```ts
ObjectBase.constructor
```

### Constructor

```ts
new Border(): Border;
```

Creates a new Border.

#### Returns

`Border`

#### Overrides

```ts
ObjectBase.constructor
```

## Accessors

### color

#### Get Signature

```ts
get color(): Color;
```

Gets or sets the border color.

##### Returns

[`Color`](../type-aliases/Color)

#### Set Signature

```ts
set color(value): void;
```

Gets or sets the border color.

##### Parameters

###### value

[`Color`](../type-aliases/Color)

##### Returns

`void`

***

### dashPattern

#### Get Signature

```ts
get dashPattern(): number[];
```

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

##### Returns

`number`[]

#### Set Signature

```ts
set dashPattern(value): void;
```

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

##### Parameters

###### value

`number`[]

##### Returns

`void`

***

### id

#### Get Signature

```ts
get id(): number;
```

Gets the reference to the object.

##### Returns

`number`

#### Inherited from

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

***

### om

#### Get Signature

```ts
get om(): ObjectManager;
```

Gets the owner [ObjectManager](ObjectManager) instance.

##### Returns

[`ObjectManager`](ObjectManager)

#### Inherited from

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

***

### style

#### Get Signature

```ts
get style(): BorderStyle;
```

Gets or sets the border style.

##### Returns

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

#### Set Signature

```ts
set style(value): void;
```

Gets or sets the border style.

##### Parameters

###### value

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

##### Returns

`void`

***

### width

#### Get Signature

```ts
get width(): number;
```

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

##### Returns

`number`

#### Set Signature

```ts
set width(value): void;
```

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

##### Parameters

###### value

`number`

##### Returns

`void`

## Methods

### free()

```ts
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()

```ts
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)