API reference / Common / Engine types / PortableTextEndpoint

Interface: PortableTextEndpoint

One end of a flowing DocumentText selection — a text boundary addressed fully across the document: which page, which form use on it when the text is a form's, and the [TextPosition] — its text object and the boundary in it. (ObjectText needs only bare [TextPosition]s because its page is fixed and it edits none of a form's text.)

Properties

Property	Description
page string	The page the end sits on.
form string | null	The form use the text is drawn through, when it is in a form's body — every use of a form shares the body, so the text object's id alone can't say which drawing of it the end is on. None for the page's own text.
pos TextPosition	The boundary — on the page, top-level or inside a group, or in form's body.