Class Position

Posisi

Referensi ke lokasi di tab dokumen, relatif terhadap elemen tertentu. Kursor pengguna direpresentasikan sebagai Position, di antara penggunaan lainnya. Skrip hanya dapat mengakses kursor pengguna yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen. 

// 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.');
}

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getElement()ElementMendapatkan elemen yang berisi Position ini.
getOffset()IntegerMendapatkan lokasi relatif Position ini dalam elemen yang berisinya.
getSurroundingText()TextMembuat elemen Text buatan yang mewakili teks dan pemformatan Paragraph atau ListItem yang berisi Position, baik secara langsung maupun melalui rantai elemen turunan.
getSurroundingTextOffset()IntegerMendapatkan offset Position ini dalam elemen Text yang ditampilkan oleh getSurroundingText().
insertBookmark()BookmarkMembuat dan menyisipkan Bookmark baru di Position ini.
insertInlineImage(image)InlineImageMembuat dan menyisipkan InlineImage baru di Position ini dari blob gambar yang ditentukan.
insertText(text)TextMenyisipkan teks yang ditentukan di Position ini.

Dokumentasi mendetail

getElement()

Mendapatkan elemen yang berisi Position ini. Ini akan berupa elemen Text atau elemen penampung seperti Paragraph. Dalam kedua kasus tersebut, posisi relatif dalam elemen dapat ditentukan dengan getOffset().

Pulang pergi

Element — penampung atau elemen Text tempat objek Position ini berada

getOffset()

Mendapatkan lokasi relatif Position ini dalam elemen yang berisinya. Jika elemen adalah elemen Text, offset adalah jumlah karakter sebelum Position (yaitu, indeks karakter setelah Position ini); untuk elemen lain, offset adalah jumlah elemen turunan sebelum Position ini dalam elemen penampung yang sama (yaitu, indeks elemen turunan setelah Position).

Pulang pergi

Integer — untuk elemen Text, jumlah karakter sebelum Position ini; untuk elemen lain, jumlah elemen turunan sebelum Position ini dalam elemen penampung yang sama

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getSurroundingText()

Membuat elemen Text buatan yang mewakili teks dan pemformatan Paragraph atau ListItem yang berisi Position, baik secara langsung maupun melalui rantai elemen turunan. Untuk menentukan offset Position dalam elemen Text yang ditampilkan, gunakan getSurroundingTextOffset().

Pulang pergi

Text — elemen yang setara dengan hasil pemanggilan editAsText() di Paragraph atau ListItem yang berisi Position, baik secara langsung maupun melalui rantai elemen turunan

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getSurroundingTextOffset()

Mendapatkan offset Position ini dalam elemen Text yang ditampilkan oleh getSurroundingText(). Offset adalah jumlah karakter sebelum Position (yaitu, indeks karakter setelah Position ini).

Pulang pergi

Integer — jumlah karakter sebelum Position ini di Paragraph atau ListItem yang berisi Position, baik secara langsung maupun melalui rantai elemen turunan

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

insertBookmark()

Membuat dan menyisipkan Bookmark baru di Position ini.

Pulang pergi

Bookmark — bookmark baru

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

insertInlineImage(image)

Membuat dan menyisipkan InlineImage baru di Position ini dari blob gambar yang ditentukan.

Parameter

NamaJenisDeskripsi
imageBlobSourcedata gambar yang akan disisipkan di Position ini

Pulang pergi

InlineImage — elemen gambar baru, atau null jika elemen tempat Position ini berada tidak mengizinkan penyisipan gambar

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

insertText(text)

Menyisipkan teks yang ditentukan di Position ini. Metode ini membuat elemen Text baru, meskipun string disisipkan dalam elemen Text yang ada, sehingga mudah untuk menata gaya elemen baru.

Parameter

NamaJenisDeskripsi
textStringstring yang akan disisipkan di Position ini

Pulang pergi

Text — elemen teks baru, atau null jika elemen tempat Position ini berada tidak mengizinkan teks disisipkan

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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