| 1 | # Text Coordinates Schema
|
| 2 |
|
| 3 | ```txt
|
| 4 | https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/start
|
| 5 | ```
|
| 6 |
|
| 7 | A position in a text document
|
| 8 |
|
| 9 |
|
| 10 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
| 11 | | :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------- |
|
| 12 | | Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [position.schema.json\*](position.schema.json "open original schema") |
|
| 13 |
|
| 14 | ## start Type
|
| 15 |
|
| 16 | `object` ([Text Coordinates](position-properties-text-coordinates.md))
|
| 17 |
|
| 18 | # Text Coordinates Properties
|
| 19 |
|
| 20 | | Property | Type | Required | Nullable | Defined by |
|
| 21 | | :---------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------- |
|
| 22 | | [line](#line) | `number` | Optional | cannot be null | [Text Coordinates](textcoordinates-properties-line.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/line") |
|
| 23 | | [column](#column) | `number` | Optional | cannot be null | [Text Coordinates](textcoordinates-properties-column.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/column") |
|
| 24 | | [offset](#offset) | `number` | Optional | cannot be null | [Text Coordinates](textcoordinates-properties-offset.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/offset") |
|
| 25 |
|
| 26 | ## line
|
| 27 |
|
| 28 | Line number
|
| 29 |
|
| 30 |
|
| 31 | `line`
|
| 32 |
|
| 33 | - is optional
|
| 34 | - Type: `number`
|
| 35 | - cannot be null
|
| 36 | - defined in: [Text Coordinates](textcoordinates-properties-line.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/line")
|
| 37 |
|
| 38 | ### line Type
|
| 39 |
|
| 40 | `number`
|
| 41 |
|
| 42 | ## column
|
| 43 |
|
| 44 | Column number
|
| 45 |
|
| 46 |
|
| 47 | `column`
|
| 48 |
|
| 49 | - is optional
|
| 50 | - Type: `number`
|
| 51 | - cannot be null
|
| 52 | - defined in: [Text Coordinates](textcoordinates-properties-column.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/column")
|
| 53 |
|
| 54 | ### column Type
|
| 55 |
|
| 56 | `number`
|
| 57 |
|
| 58 | ## offset
|
| 59 |
|
| 60 | Character in the entire document
|
| 61 |
|
| 62 |
|
| 63 | `offset`
|
| 64 |
|
| 65 | - is optional
|
| 66 | - Type: `number`
|
| 67 | - cannot be null
|
| 68 | - defined in: [Text Coordinates](textcoordinates-properties-offset.md "https://ns.adobe.com/helix/pipeline/textcoordinates#/properties/offset")
|
| 69 |
|
| 70 | ### offset Type
|
| 71 |
|
| 72 | `number`
|