---
title: "TextWhizzPosition | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/TextWhizzPosition/"
---

# TextWhizzPosition

> - [`IPositionInText`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#ipositionintext)

## Classes

### TextWhizzPosition

#### Implements

#### Constructors

##### Constructor

```ts
new TextWhizzPosition(position): TextWhizzPosition;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `position` | `TextPosition` |

###### Returns

[`TextWhizzPosition`](#textwhizzposition)

#### Methods

##### getEntry()

```ts
getEntry(): TextPosition;
```

###### Returns

`TextPosition`

##### getLineIndex()

```ts
getLineIndex(): number;
```

Returns the line index of the position in the text.

###### Returns

`number`

###### Implementation of

[`IPositionInText`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#ipositionintext).[`getLineIndex`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#getlineindex)

##### getOffset()

```ts
getOffset(): number;
```

Returns the line offset of the position in the text.

###### Returns

`number`

###### Implementation of

[`IPositionInText`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#ipositionintext).[`getOffset`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#getoffset)

##### getParagraphIndex()

```ts
getParagraphIndex(): number;
```

Returns the paragraph index of the position in the text.

###### Returns

`number`

###### Implementation of

[`IPositionInText`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#ipositionintext).[`getParagraphIndex`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#getparagraphindex)

##### isEqualTo()

```ts
isEqualTo(anotherPosition): boolean;
```

Compares the current position in text with another.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `anotherPosition` | [`IPositionInText`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#ipositionintext) | another position in text. |

###### Returns

`boolean`

true if the positions match, false otherwise.

###### Implementation of

[`IPositionInText`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#ipositionintext).[`isEqualTo`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IPositionInText.md#isequalto)