<!-- Public documentation export; not library implementation source. -->
# IPositionLineAdapter

[Integration guide](https://docs.lumencharts.com/charting-library/drawings#host-trading-overlays) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

## remove {#remove}

```ts
remove(): void;
```

Use the type signature above and the integration guide for the owning capability.

## onClose {#onclose}

```ts
onClose(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onClose (overload 2) {#onclose-1}

```ts
onClose<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## onModify {#onmodify}

```ts
onModify(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onModify (overload 2) {#onmodify-1}

```ts
onModify<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## onReverse {#onreverse}

```ts
onReverse(callback: () => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `callback` | `() => void` | Yes |

## onReverse (overload 2) {#onreverse-1}

```ts
onReverse<T>(data: T, callback: (data: T) => void): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `data` | `T` | Yes |
| `callback` | `(data: T) => void` | Yes |

## getPrice {#getprice}

```ts
getPrice(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setPrice {#setprice}

```ts
setPrice(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getText {#gettext}

```ts
getText(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setText {#settext}

```ts
setText(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getTooltip {#gettooltip}

```ts
getTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setTooltip {#settooltip}

```ts
setTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getProtectTooltip {#getprotecttooltip}

```ts
getProtectTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setProtectTooltip {#setprotecttooltip}

```ts
setProtectTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCloseTooltip {#getclosetooltip}

```ts
getCloseTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCloseTooltip {#setclosetooltip}

```ts
setCloseTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getReverseTooltip {#getreversetooltip}

```ts
getReverseTooltip(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setReverseTooltip {#setreversetooltip}

```ts
setReverseTooltip(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantity {#getquantity}

```ts
getQuantity(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantity {#setquantity}

```ts
setQuantity(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getExtendLeft {#getextendleft}

```ts
getExtendLeft(): boolean;
```

Use the type signature above and the integration guide for the owning capability.

## setExtendLeft {#setextendleft}

```ts
setExtendLeft(value: boolean): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `boolean` | Yes |

## getLineLengthUnit {#getlinelengthunit}

```ts
getLineLengthUnit(): PositionLineLengthUnit;
```

Use the type signature above and the integration guide for the owning capability.

## getLineLength {#getlinelength}

```ts
getLineLength(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setLineLength {#setlinelength}

```ts
setLineLength(value: number, unit?: PositionLineLengthUnit): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |
| `unit` | `PositionLineLengthUnit` | No |

## getLineStyle {#getlinestyle}

```ts
getLineStyle(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setLineStyle {#setlinestyle}

```ts
setLineStyle(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getLineWidth {#getlinewidth}

```ts
getLineWidth(): number;
```

Use the type signature above and the integration guide for the owning capability.

## setLineWidth {#setlinewidth}

```ts
setLineWidth(value: number): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `number` | Yes |

## getBodyFont {#getbodyfont}

```ts
getBodyFont(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyFont {#setbodyfont}

```ts
setBodyFont(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityFont {#getquantityfont}

```ts
getQuantityFont(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityFont {#setquantityfont}

```ts
setQuantityFont(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getLineColor {#getlinecolor}

```ts
getLineColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setLineColor {#setlinecolor}

```ts
setLineColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getBodyBorderColor {#getbodybordercolor}

```ts
getBodyBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyBorderColor {#setbodybordercolor}

```ts
setBodyBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getBodyBackgroundColor {#getbodybackgroundcolor}

```ts
getBodyBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyBackgroundColor {#setbodybackgroundcolor}

```ts
setBodyBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getBodyTextColor {#getbodytextcolor}

```ts
getBodyTextColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setBodyTextColor {#setbodytextcolor}

```ts
setBodyTextColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityBorderColor {#getquantitybordercolor}

```ts
getQuantityBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityBorderColor {#setquantitybordercolor}

```ts
setQuantityBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityBackgroundColor {#getquantitybackgroundcolor}

```ts
getQuantityBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityBackgroundColor {#setquantitybackgroundcolor}

```ts
setQuantityBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getQuantityTextColor {#getquantitytextcolor}

```ts
getQuantityTextColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setQuantityTextColor {#setquantitytextcolor}

```ts
setQuantityTextColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getReverseButtonBorderColor {#getreversebuttonbordercolor}

```ts
getReverseButtonBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setReverseButtonBorderColor {#setreversebuttonbordercolor}

```ts
setReverseButtonBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getReverseButtonBackgroundColor {#getreversebuttonbackgroundcolor}

```ts
getReverseButtonBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setReverseButtonBackgroundColor {#setreversebuttonbackgroundcolor}

```ts
setReverseButtonBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getReverseButtonIconColor {#getreversebuttoniconcolor}

```ts
getReverseButtonIconColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setReverseButtonIconColor {#setreversebuttoniconcolor}

```ts
setReverseButtonIconColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCloseButtonBorderColor {#getclosebuttonbordercolor}

```ts
getCloseButtonBorderColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCloseButtonBorderColor {#setclosebuttonbordercolor}

```ts
setCloseButtonBorderColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCloseButtonBackgroundColor {#getclosebuttonbackgroundcolor}

```ts
getCloseButtonBackgroundColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCloseButtonBackgroundColor {#setclosebuttonbackgroundcolor}

```ts
setCloseButtonBackgroundColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## getCloseButtonIconColor {#getclosebuttoniconcolor}

```ts
getCloseButtonIconColor(): string;
```

Use the type signature above and the integration guide for the owning capability.

## setCloseButtonIconColor {#setclosebuttoniconcolor}

```ts
setCloseButtonIconColor(value: string): this;
```

Use the type signature above and the integration guide for the owning capability.

| Parameter | Type | Required |
| --- | --- | --- |
| `value` | `string` | Yes |

## Related types

- [PositionLineLengthUnit](https://docs.lumencharts.com/charting-library/api/PositionLineLengthUnit)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/IPositionLineAdapter