Class ListItem

ListItem

Elemen yang mewakili item daftar. ListItem adalah Paragraph yang terkait dengan ID daftar. ListItem dapat berisi elemen Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak, dan Text. Untuk informasi selengkapnya tentang struktur dokumen, lihat panduan untuk memperluas Google Dokumen.

ListItems tidak boleh berisi karakter baris baru. Karakter baris baru ("\n") dikonversi menjadi karakter baris baru ("\r").

ListItems dengan ID daftar yang sama termasuk dalam daftar yang sama dan diberi nomor yang sesuai. ListItems untuk daftar tertentu tidak harus berdekatan di tab atau bahkan memiliki elemen induk yang sama. Dua item yang termasuk dalam daftar yang sama dapat berada di mana saja di tab sekaligus mempertahankan penomoran berturut-turut, seperti yang diilustrasikan dalam contoh berikut: 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a new list item to the body.
const item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([['Cell 1', 'Cell 2']]);

// Append a second list item with the same list ID. The two items are treated as
// the same list, despite not being consecutive.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addPositionedImage(image)PositionedImageMembuat dan menyisipkan PositionedImage baru dari blob gambar yang ditentukan.
appendHorizontalRule()HorizontalRuleMembuat dan menambahkan HorizontalRule baru.
appendInlineImage(image)InlineImageMembuat dan menambahkan InlineImage baru dari blob gambar yang ditentukan.
appendInlineImage(image)InlineImageMenambahkan InlineImage yang diberikan.
appendPageBreak()PageBreakMembuat dan menambahkan PageBreak baru.
appendPageBreak(pageBreak)PageBreakMenambahkan PageBreak yang diberikan.
appendText(text)TextMembuat dan menambahkan elemen Text baru dengan konten yang ditentukan.
appendText(text)TextMenambahkan elemen Text yang diberikan.
clear()ListItemMenghapus konten elemen.
copy()ListItemMenampilkan salinan mendalam yang terpisah dari elemen saat ini.
editAsText()TextMendapatkan versi Text elemen saat ini, untuk diedit.
findElement(elementType)RangeElementMenelusuri konten elemen untuk menemukan turunan dari jenis yang ditentukan.
findElement(elementType, from)RangeElementMenelusuri konten elemen untuk mencari turunan dari jenis yang ditentukan, mulai dari RangeElement yang ditentukan.
findText(searchPattern)RangeElementMenelusuri konten elemen untuk pola teks yang ditentukan menggunakan ekspresi reguler.
findText(searchPattern, from)RangeElementMenelusuri konten elemen untuk pola teks yang ditentukan, mulai dari hasil penelusuran tertentu.
getAlignment()HorizontalAlignmentMengambil HorizontalAlignment.
getAttributes()ObjectMengambil atribut elemen.
getChild(childIndex)ElementMengambil elemen turunan pada indeks turunan yang ditentukan.
getChildIndex(child)IntegerMengambil indeks turunan untuk elemen turunan yang ditentukan.
getGlyphType()GlyphTypeMengambil GlyphType item daftar.
getHeading()ParagraphHeadingMengambil ParagraphHeading.
getIndentEnd()NumberMengambil indentasi akhir, dalam poin.
getIndentFirstLine()NumberMengambil indentasi baris pertama, dalam poin.
getIndentStart()NumberMengambil indentasi awal.
getLineSpacing()NumberMengambil spasi baris, dalam poin.
getLinkUrl()StringMengambil URL link.
getListId()StringMengambil ID daftar.
getNestingLevel()IntegerMengambil level hierarki item daftar.
getNextSibling()ElementMengambil elemen pasangan berikutnya dari elemen.
getNumChildren()IntegerMengambil jumlah turunan.
getParent()ContainerElementMengambil elemen induk elemen.
getPositionedImage(id)PositionedImageMendapatkan PositionedImage berdasarkan ID gambar.
getPositionedImages()PositionedImage[]Mendapatkan semua objek PositionedImage yang ditautkan ke paragraf.
getPreviousSibling()ElementMengambil elemen saudara sebelumnya dari elemen.
getSpacingAfter()NumberMengambil spasi setelah elemen, dalam poin.
getSpacingBefore()NumberMengambil spasi sebelum elemen, dalam poin.
getText()StringMengambil konten elemen sebagai string teks.
getTextAlignment()TextAlignmentMendapatkan perataan teks.
getType()ElementTypeMengambil ElementType elemen.
insertHorizontalRule(childIndex)HorizontalRuleMembuat dan menyisipkan HorizontalRule di indeks yang ditentukan.
insertInlineImage(childIndex, image)InlineImageMembuat dan menyisipkan InlineImage baru dari blob gambar yang ditentukan, pada indeks yang ditentukan.
insertInlineImage(childIndex, image)InlineImageMenyisipkan InlineImage yang diberikan pada indeks yang ditentukan.
insertPageBreak(childIndex)PageBreakMembuat dan menyisipkan PageBreak baru di indeks yang ditentukan.
insertPageBreak(childIndex, pageBreak)PageBreakMenyisipkan PageBreak yang diberikan pada indeks yang ditentukan.
insertText(childIndex, text)TextMembuat dan menyisipkan elemen teks baru pada indeks yang ditentukan.
insertText(childIndex, text)TextMenyisipkan elemen Text yang diberikan pada indeks yang ditentukan, dengan konten teks yang ditentukan.
isAtDocumentEnd()BooleanMenentukan apakah elemen berada di akhir Document.
isLeftToRight()BooleanMengambil setelan kiri-ke-kanan.
merge()ListItemMenggabungkan elemen dengan elemen sebelumnya dari jenis yang sama.
removeChild(child)ListItemMenghapus elemen turunan yang ditentukan.
removeFromParent()ListItemMenghapus elemen dari induknya.
removePositionedImage(id)BooleanMenghapus PositionedImage berdasarkan ID gambar.
replaceText(searchPattern, replacement)ElementMengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi reguler.
setAlignment(alignment)ListItemMenetapkan HorizontalAlignment.
setAttributes(attributes)ListItemMenetapkan atribut elemen.
setGlyphType(glyphType)ListItemMenetapkan GlyphType item daftar.
setHeading(heading)ListItemMenetapkan ParagraphHeading.
setIndentEnd(indentEnd)ListItemMenetapkan indentasi akhir, dalam poin.
setIndentFirstLine(indentFirstLine)ListItemMenetapkan indentasi baris pertama, dalam poin.
setIndentStart(indentStart)ListItemMenetapkan indentasi awal, dalam poin.
setLeftToRight(leftToRight)ListItemMenetapkan setelan kiri-ke-kanan.
setLineSpacing(multiplier)ListItemMenetapkan spasi baris, sebagai kuantitas yang menunjukkan jumlah baris yang akan digunakan untuk spasi.
setLinkUrl(url)ListItemMenetapkan URL link.
setListId(listItem)ListItemMenetapkan ID daftar.
setNestingLevel(nestingLevel)ListItemMenetapkan level hierarki item daftar.
setSpacingAfter(spacingAfter)ListItemMenetapkan spasi setelah elemen, dalam poin.
setSpacingBefore(spacingBefore)ListItemMenetapkan spasi sebelum elemen, dalam poin.
setText(text)voidMenetapkan konten item daftar sebagai teks.
setTextAlignment(textAlignment)ListItemMenetapkan perataan teks.

Dokumentasi mendetail

addPositionedImage(image)

Membuat dan menyisipkan PositionedImage baru dari blob gambar yang ditentukan.

Parameter

NamaJenisDeskripsi
imageBlobSourcedata gambar

Pulang pergi

PositionedImage — gambar yang diposisikan 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

appendHorizontalRule()

Membuat dan menambahkan HorizontalRule baru.

Pulang pergi

HorizontalRule — aturan horizontal 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

appendInlineImage(image)

Membuat dan menambahkan InlineImage baru dari blob gambar yang ditentukan.

Parameter

NamaJenisDeskripsi
imageBlobSourcedata gambar

Pulang pergi

InlineImage — gambar yang ditambahkan

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

appendInlineImage(image)

Menambahkan InlineImage yang diberikan.

Parameter

NamaJenisDeskripsi
imageInlineImagedata gambar

Pulang pergi

InlineImage — gambar yang ditambahkan

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

appendPageBreak()

Membuat dan menambahkan PageBreak baru.

Catatan: PageBreaks tidak boleh berada dalam TableCells. Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.

Pulang pergi

PageBreak — elemen batas halaman 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

appendPageBreak(pageBreak)

Menambahkan PageBreak yang diberikan.

Catatan: PageBreaks tidak boleh berada dalam TableCells. Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.

Parameter

NamaJenisDeskripsi
pageBreakPageBreakbatas halaman yang akan ditambahkan

Pulang pergi

PageBreak — elemen jeda halaman yang ditambahkan

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

appendText(text)

Membuat dan menambahkan elemen Text baru dengan konten yang ditentukan.

Parameter

NamaJenisDeskripsi
textStringkonten teks

Pulang pergi

Text — elemen teks 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

appendText(text)

Menambahkan elemen Text yang diberikan.

Parameter

NamaJenisDeskripsi
textTextelemen teks yang akan ditambahkan

Pulang pergi

Text — elemen teks yang ditambahkan

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

clear()

Menghapus konten elemen.

Pulang pergi

ListItem — Elemen saat ini.

copy()

Menampilkan salinan mendalam yang terpisah dari elemen saat ini.

Semua elemen turunan yang ada dalam elemen juga akan disalin. Elemen baru tidak memiliki induk.

Pulang pergi

ListItem — Salinan 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

editAsText()

Mendapatkan versi Text elemen saat ini, untuk diedit.

Gunakan editAsText untuk memanipulasi konten elemen sebagai teks kaya. Mode editAsText mengabaikan elemen non-teks (seperti InlineImage dan HorizontalRule).

Elemen turunan yang sepenuhnya berada dalam rentang teks yang dihapus akan dihapus dari elemen. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Pulang pergi

Text — versi teks elemen saat ini

findElement(elementType)

Menelusuri konten elemen untuk menemukan turunan dari jenis yang ditentukan.

Parameter

NamaJenisDeskripsi
elementTypeElementTypeJenis elemen yang akan ditelusuri.

Pulang pergi

RangeElement — Hasil penelusuran yang menunjukkan posisi elemen penelusuran.

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

findElement(elementType, from)

Menelusuri konten elemen untuk mencari turunan dari jenis yang ditentukan, mulai dari RangeElement yang ditentukan. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parameter

NamaJenisDeskripsi
elementTypeElementTypeJenis elemen yang akan ditelusuri.
fromRangeElementHasil penelusuran yang akan digunakan untuk melakukan penelusuran.

Pulang pergi

RangeElement — Hasil penelusuran yang menunjukkan posisi berikutnya dari elemen penelusuran.

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

findText(searchPattern)

Menelusuri konten elemen untuk pola teks yang ditentukan menggunakan ekspresi reguler.

Sebagian fitur ekspresi reguler JavaScript tidak didukung sepenuhnya, seperti grup pengambilan dan pengubah mode.

Pola ekspresi reguler yang disediakan dicocokkan secara independen dengan setiap blok teks yang terdapat dalam elemen saat ini.

Parameter

NamaJenisDeskripsi
searchPatternStringpola yang akan ditelusuri

Pulang pergi

RangeElement — hasil penelusuran yang menunjukkan posisi teks penelusuran, atau null jika tidak ada kecocokan

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

findText(searchPattern, from)

Menelusuri konten elemen untuk pola teks yang ditentukan, mulai dari hasil penelusuran tertentu.

Sebagian fitur ekspresi reguler JavaScript tidak didukung sepenuhnya, seperti grup pengambilan dan pengubah mode.

Pola ekspresi reguler yang disediakan dicocokkan secara independen dengan setiap blok teks yang terdapat dalam elemen saat ini.

Parameter

NamaJenisDeskripsi
searchPatternStringpola yang akan ditelusuri
fromRangeElementhasil penelusuran yang akan digunakan untuk menelusuri

Pulang pergi

RangeElement — hasil penelusuran yang menunjukkan posisi berikutnya dari teks penelusuran, atau null jika tidak ada kecocokan

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

getAlignment()

Mengambil HorizontalAlignment.

Pulang pergi

HorizontalAlignment — perataan

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

getAttributes()

Mengambil atribut elemen.

Hasilnya adalah objek yang berisi properti untuk setiap atribut elemen yang valid dengan setiap nama properti sesuai dengan item dalam enumerasi DocumentApp.Attribute. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Pulang pergi

Object — Atribut elemen.

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

getChild(childIndex)

Mengambil elemen turunan pada indeks turunan yang ditentukan. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Parameter

NamaJenisDeskripsi
childIndexIntegerIndeks elemen turunan yang akan diambil.

Pulang pergi

Element — Elemen turunan pada indeks yang ditentukan.

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

getChildIndex(child)

Mengambil indeks turunan untuk elemen turunan yang ditentukan.

Parameter

NamaJenisDeskripsi
childElementElemen turunan yang indeksnya akan diambil.

Pulang pergi

Integer — Indeks 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

getGlyphType()

Mengambil GlyphType item daftar.

Pulang pergi

GlyphType — jenis glyph

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

getHeading()

Mengambil ParagraphHeading.

Pulang pergi

ParagraphHeading — judul

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

getIndentEnd()

Mengambil indentasi akhir, dalam poin.

Pulang pergi

Number — indentasi akhir, dalam poin

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

getIndentFirstLine()

Mengambil indentasi baris pertama, dalam poin.

Pulang pergi

Number — indentasi baris pertama, dalam poin

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

getIndentStart()

Mengambil indentasi awal.

Pulang pergi

Number — indentasi awal

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

getLineSpacing()

Mengambil spasi baris, dalam poin.

Pulang pergi

Number — spasi antarbaris, dalam poin

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

getLinkUrl()

Mengambil URL link.

Pulang pergi

String — URL link, atau null jika elemen berisi beberapa nilai untuk atribut ini

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

getListId()

Mengambil ID daftar.

Pulang pergi

String — ID daftar

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

getNestingLevel()

Mengambil level hierarki item daftar.

Secara default, item daftar memiliki level hierarki nol. Tingkat bertingkat menentukan glyph yang digunakan oleh item daftar.

Pulang pergi

Integer — tingkat hierarki

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

getNextSibling()

Mengambil elemen pasangan berikutnya dari elemen.

Saudara berikutnya memiliki induk yang sama dan mengikuti elemen saat ini.

Pulang pergi

Element — Elemen sibling berikutnya.

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

getNumChildren()

Mengambil jumlah turunan. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Pulang pergi

Integer — Jumlah 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

getParent()

Mengambil elemen induk elemen.

Elemen induk berisi elemen saat ini.

Pulang pergi

ContainerElement — Elemen induk.

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

getPositionedImage(id)

Mendapatkan PositionedImage berdasarkan ID gambar.

Parameter

NamaJenisDeskripsi
idStringID gambar

Pulang pergi

PositionedImage — gambar yang diposisikan

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

getPositionedImages()

Mendapatkan semua objek PositionedImage yang ditautkan ke paragraf.

Pulang pergi

PositionedImage[] — daftar gambar yang diposisikan

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

getPreviousSibling()

Mengambil elemen saudara sebelumnya dari elemen.

Saudara sebelumnya memiliki induk yang sama dan mendahului elemen saat ini.

Pulang pergi

Element — Elemen sibling sebelumnya.

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

getSpacingAfter()

Mengambil spasi setelah elemen, dalam poin.

Pulang pergi

Number — spasi setelah elemen, dalam poin

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

getSpacingBefore()

Mengambil spasi sebelum elemen, dalam poin.

Pulang pergi

Number — spasi sebelum elemen, dalam poin

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

getText()

Mengambil konten elemen sebagai string teks.

Pulang pergi

String — konten elemen sebagai string teks

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

getTextAlignment()

Mendapatkan perataan teks. Jenis perataan yang tersedia adalah DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, dan DocumentApp.TextAlignment.SUPERSCRIPT.

Pulang pergi

TextAlignment — jenis perataan teks, atau null jika teks berisi beberapa jenis perataan teks atau jika perataan teks belum pernah ditetapkan

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

getType()

Mengambil ElementType elemen.

Gunakan getType() untuk menentukan jenis persis elemen tertentu. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Pulang pergi

ElementType — Jenis elemen.

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

insertHorizontalRule(childIndex)

Membuat dan menyisipkan HorizontalRule di indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen disisipkan

Pulang pergi

HorizontalRule — elemen aturan horizontal 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(childIndex, image)

Membuat dan menyisipkan InlineImage baru dari blob gambar yang ditentukan, pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen disisipkan
imageBlobSourcedata gambar

Pulang pergi

InlineImage — elemen gambar inline yang 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

insertInlineImage(childIndex, image)

Menyisipkan InlineImage yang diberikan pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen disisipkan
imageInlineImagedata gambar

Pulang pergi

InlineImage — elemen gambar inline yang 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

insertPageBreak(childIndex)

Membuat dan menyisipkan PageBreak baru di indeks yang ditentukan.

Catatan: PageBreaks tidak boleh berada dalam TableCells. Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen disisipkan

Pulang pergi

PageBreak — elemen batas halaman 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

insertPageBreak(childIndex, pageBreak)

Menyisipkan PageBreak yang diberikan pada indeks yang ditentukan.

Catatan: PageBreaks tidak boleh berada dalam TableCells. Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen disisipkan
pageBreakPageBreakbatas halaman yang akan disisipkan

Pulang pergi

PageBreak — elemen batas halaman yang 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

insertText(childIndex, text)

Membuat dan menyisipkan elemen teks baru pada indeks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen disisipkan
textStringkonten teks

Pulang pergi

Text — elemen teks 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

insertText(childIndex, text)

Menyisipkan elemen Text yang diberikan pada indeks yang ditentukan, dengan konten teks yang ditentukan.

Parameter

NamaJenisDeskripsi
childIndexIntegerindeks tempat elemen disisipkan
textTextelemen teks yang akan disisipkan

Pulang pergi

Text — elemen teks yang 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

isAtDocumentEnd()

Menentukan apakah elemen berada di akhir Document.

Pulang pergi

Boolean — Apakah elemen berada di akhir tab.

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

isLeftToRight()

Mengambil setelan kiri-ke-kanan.

Pulang pergi

Boolean — setelan kiri ke kanan

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

merge()

Menggabungkan elemen dengan elemen sebelumnya dari jenis yang sama.

Hanya elemen dengan ElementType yang sama yang dapat digabungkan. Setiap elemen turunan yang terdapat dalam elemen saat ini akan dipindahkan ke elemen saudara sebelumnya.

Elemen saat ini akan dihapus dari dokumen. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Pulang pergi

ListItem — Elemen yang digabungkan.

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

removeChild(child)

Menghapus elemen turunan yang ditentukan.

Parameter

NamaJenisDeskripsi
childElementelemen turunan yang akan dihapus

Pulang pergi

ListItem — elemen saat ini

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

removeFromParent()

Menghapus elemen dari induknya. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Pulang pergi

ListItem — Elemen yang dihapus.

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

removePositionedImage(id)

Menghapus PositionedImage berdasarkan ID gambar.

Parameter

NamaJenisDeskripsi
idString

Pulang pergi

Boolean — apakah gambar yang ditentukan telah dihapus atau tidak

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

replaceText(searchPattern, replacement)

Mengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi reguler.

Pola penelusuran diteruskan sebagai string, bukan objek ekspresi reguler JavaScript. Oleh karena itu, Anda harus meng-escape garis miring terbalik dalam pola.

Metode ini menggunakan library ekspresi reguler RE2 Google, yang membatasi sintaksis yang didukung.

Pola ekspresi reguler yang disediakan dicocokkan secara independen dengan setiap blok teks yang terdapat dalam elemen saat ini. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

Parameter

NamaJenisDeskripsi
searchPatternStringpola ekspresi reguler yang akan ditelusuri
replacementStringteks yang akan digunakan sebagai pengganti

Pulang pergi

Element — elemen saat ini

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

setAlignment(alignment)

Menetapkan HorizontalAlignment.

Parameter

NamaJenisDeskripsi
alignmentHorizontalAlignmentperataan horizontal

Pulang pergi

ListItem — elemen saat ini

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

setAttributes(attributes)

Menetapkan atribut elemen.

Parameter atribut yang ditentukan harus berupa objek dengan setiap nama properti adalah item dalam enumerasi DocumentApp.Attribute dan setiap nilai properti adalah nilai baru yang akan diterapkan. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parameter

NamaJenisDeskripsi
attributesObjectAtribut elemen.

Pulang pergi

ListItem — Elemen saat ini.

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

setGlyphType(glyphType)

Menetapkan GlyphType item daftar.

Parameter

NamaJenisDeskripsi
glyphTypeGlyphTypejenis glyph

Pulang pergi

ListItem — elemen saat ini

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

setHeading(heading)

Menetapkan ParagraphHeading.

Parameter

NamaJenisDeskripsi
headingParagraphHeadingjudul

Pulang pergi

ListItem — elemen saat ini

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

setIndentEnd(indentEnd)

Menetapkan indentasi akhir, dalam poin.

Parameter

NamaJenisDeskripsi
indentEndNumberindentasi akhir, dalam titik

Pulang pergi

ListItem — elemen saat ini

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

setIndentFirstLine(indentFirstLine)

Menetapkan indentasi baris pertama, dalam poin.

Parameter

NamaJenisDeskripsi
indentFirstLineNumberindentasi baris pertama, dalam poin

Pulang pergi

ListItem — elemen saat ini

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

setIndentStart(indentStart)

Menetapkan indentasi awal, dalam poin.

Parameter

NamaJenisDeskripsi
indentStartNumberindentasi awal, dalam poin

Pulang pergi

ListItem — elemen saat ini

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

setLeftToRight(leftToRight)

Menetapkan setelan kiri-ke-kanan.

Parameter

NamaJenisDeskripsi
leftToRightBooleansetelan kiri ke kanan

Pulang pergi

ListItem — elemen saat ini

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

setLineSpacing(multiplier)

Menetapkan spasi baris, sebagai kuantitas yang menunjukkan jumlah baris yang akan digunakan untuk spasi.

Parameter

NamaJenisDeskripsi
multiplierNumberjumlah baris

Pulang pergi

ListItem — elemen saat ini

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

setLinkUrl(url)

Menetapkan URL link.

Parameter

NamaJenisDeskripsi
urlStringURL link

Pulang pergi

ListItem — elemen saat ini

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

setListId(listItem)

Menetapkan ID daftar.

ID daftar ditetapkan ke nilai yang sama untuk ListItem yang ditentukan. Kedua ListItems akan diperlakukan sebagai anggota daftar yang sama.

Parameter

NamaJenisDeskripsi
listItemListItemitem daftar yang ID daftarnya akan digunakan

Pulang pergi

ListItem — elemen saat ini

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

setNestingLevel(nestingLevel)

Menetapkan level hierarki item daftar.

Secara default, item daftar memiliki level hierarki nol. Tingkat bertingkat menentukan glyph yang digunakan oleh item daftar.

Parameter

NamaJenisDeskripsi
nestingLevelIntegertingkat bertingkat

Pulang pergi

ListItem — elemen saat ini

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

setSpacingAfter(spacingAfter)

Menetapkan spasi setelah elemen, dalam poin.

Parameter

NamaJenisDeskripsi
spacingAfterNumberspasi setelah elemen, dalam poin

Pulang pergi

ListItem — elemen saat ini

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

setSpacingBefore(spacingBefore)

Menetapkan spasi sebelum elemen, dalam poin.

Parameter

NamaJenisDeskripsi
spacingBeforeNumberspasi sebelum elemen, dalam poin

Pulang pergi

ListItem — elemen saat ini

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

setText(text)

Menetapkan konten item daftar sebagai teks.

Catatan: konten yang ada akan dihapus.

Parameter

NamaJenisDeskripsi
textStringkonten teks 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

setTextAlignment(textAlignment)

Menetapkan perataan teks. Jenis perataan yang tersedia adalah DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, dan DocumentApp.TextAlignment.SUPERSCRIPT. 

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

NamaJenisDeskripsi
textAlignmentTextAlignmentjenis perataan teks yang akan diterapkan

Pulang pergi

ListItem — elemen saat ini

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