Class Position

Позиция

Ссылка на местоположение на вкладке документа относительно конкретного элемента. Курсор пользователя, помимо прочего, отображается как « Position . Скрипты могут получить доступ к курсору только того пользователя, который запускает скрипт, и только если скрипт привязан к документу.

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Методы

Метод Тип возвращаемого значения Краткое описание
get Element() Element Получает элемент, содержащий этот Position .
get Offset() Integer Получает относительное местоположение Position внутри содержащего его элемента.
get Surrounding Text() Text Создает искусственный Text элемент, представляющий текст и форматирование Paragraph или List Item , содержащего Position , либо напрямую, либо через цепочку дочерних элементов.
get Surrounding Text Offset() Integer Получает смещение этой Position внутри Text элемента, возвращаемого функцией get Surrounding Text() .
insert Bookmark() Bookmark Создает и вставляет новую Bookmark в указанное Position .
insert Inline Image(image) Inline Image |null Создает и вставляет новое Inline Image в указанную Position из заданного блока изображений.
insert Text(text) Text |null Вставляет указанный текст в эту Position .

Подробная документация

getElement()

Получает элемент, содержащий указанную Position . Это может быть либо Text элемент, либо элемент-контейнер, например, Paragraph . В любом случае, относительное положение внутри элемента можно определить с помощью getOffset() .

Возвращаться

Element — контейнер или Text элемент, в котором расположен объект Position

getOffset()

Получает относительное положение элемента Position внутри содержащего его элемента. Если элемент является Text элементом, смещение равно количеству символов перед Position (то есть индексу символа после этого Position ); для любого другого элемента смещение равно количеству дочерних элементов перед этим Position внутри того же элемента-контейнера (то есть индексу дочернего элемента после Position ).

Возвращаться

Integer — для Text элементов количество символов перед этой Position ; для других элементов количество дочерних элементов перед этой Position в пределах того же контейнерного элемента.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSurroundingText()

Создает искусственный элемент Text , представляющий текст и форматирование элемента Paragraph или ListItem , содержащего Position , либо напрямую, либо через цепочку дочерних элементов. Чтобы определить смещение элемента Position в возвращаемом элементе Text , используйте getSurroundingTextOffset() .

Возвращаться

Text — элемент, эквивалентный результату вызова editAsText() для Paragraph или ListItem , содержащего Position , либо напрямую, либо через цепочку дочерних элементов.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSurroundingTextOffset()

Получает смещение этой Position внутри Text элемента, возвращаемого функцией getSurroundingText() . Смещение — это количество символов перед Position (то есть индекс символа после этой Position ).

Возвращаться

Integer — количество символов перед этим Position в Paragraph или ListItem , содержащем этот Position , либо напрямую, либо через цепочку дочерних элементов.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertBookmark()

Создает и вставляет новую Bookmark в указанное Position .

Возвращаться

Bookmark — новая закладка

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertInlineImage(image)

Создает и вставляет новый InlineImage в указанную Position из заданного блока изображений.

Параметры

Имя Тип Описание
image Blob Source Данные изображения для вставки в это Position

Возвращаться

InlineImage |null — новый элемент изображения, или null если элемент, в котором находится этот Position не позволяет вставлять изображения.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertText(text)

Вставляет указанный текст в эту Position . Этот метод создает новый Text элемент, даже если строка вставлена ​​в существующий Text элемент, что упрощает стилизацию нового элемента.

Параметры

Имя Тип Описание
text String строка для вставки в эту Position

Возвращаться

Text |null — новый текстовый элемент, или null если элемент, в котором находится этот Position не позволяет вставлять текст.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents