Halaman ini diterjemahkan oleh Cloud Translation API.

Class 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 mengetahui informasi selengkapnya tentang struktur dokumen, lihat panduan memperluas Google Dokumen.

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

ListItems dengan ID daftar yang sama termasuk dalam daftar yang sama dan diberi nomor yang sesuai. ListItems untuk daftar tertentu tidak harus berdekatan dalam dokumen atau bahkan memiliki elemen induk yang sama. Dua item dalam daftar yang sama mungkin ada di mana saja dalam dokumen dengan tetap mempertahankan penomoran berurutan, seperti yang diilustrasikan oleh contoh berikut:

var body = DocumentApp.getActiveDocument().getBody();

// Append a new list item to the body.
var 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.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
`addPositionedImage(image)`	`PositionedImage`	Membuat dan menyisipkan `PositionedImage` baru dari blob gambar yang ditentukan.
`appendHorizontalRule()`	`HorizontalRule`	Membuat dan menambahkan `HorizontalRule` baru.
`appendInlineImage(image)`	`InlineImage`	Membuat dan menambahkan `InlineImage` baru dari blob gambar yang ditentukan.
`appendInlineImage(image)`	`InlineImage`	Menambahkan `InlineImage` yang ditentukan.
`appendPageBreak()`	`PageBreak`	Membuat dan menambahkan `PageBreak` baru.
`appendPageBreak(pageBreak)`	`PageBreak`	Menambahkan `PageBreak` yang ditentukan.
`appendText(text)`	`Text`	Membuat dan menambahkan elemen `Text` baru dengan konten yang ditentukan.
`appendText(text)`	`Text`	Menambahkan elemen `Text` yang diberikan.
`clear()`	`ListItem`	Menghapus konten elemen.
`copy()`	`ListItem`	Menampilkan salinan mendalam dan terpisah dari elemen saat ini.
`editAsText()`	`Text`	Mendapatkan versi `Text` dari elemen saat ini, untuk diedit.
`findElement(elementType)`	`RangeElement`	Menelusuri konten elemen untuk turunan dari jenis yang ditentukan.
`findElement(elementType, from)`	`RangeElement`	Menelusuri konten elemen untuk turunan dari jenis yang ditentukan, mulai dari `RangeElement` yang ditentukan.
`findText(searchPattern)`	`RangeElement`	Menelusuri konten elemen untuk pola teks yang ditentukan menggunakan ekspresi reguler.
`findText(searchPattern, from)`	`RangeElement`	Menelusuri konten elemen untuk pola teks yang ditentukan, mulai dari hasil penelusuran tertentu.
`getAlignment()`	`HorizontalAlignment`	Mengambil `HorizontalAlignment`.
`getAttributes()`	`Object`	Mengambil atribut elemen.
`getChild(childIndex)`	`Element`	Mengambil elemen turunan pada indeks turunan yang ditentukan.
`getChildIndex(child)`	`Integer`	Mengambil indeks turunan untuk elemen turunan yang ditentukan.
`getGlyphType()`	`GlyphType`	Mengambil `GlyphType` item daftar.
`getHeading()`	`ParagraphHeading`	Mengambil `ParagraphHeading`.
`getIndentEnd()`	`Number`	Mengambil indentasi akhir, dalam titik.
`getIndentFirstLine()`	`Number`	Mengambil indentasi baris pertama, dalam titik.
`getIndentStart()`	`Number`	Mengambil indentasi awal.
`getLineSpacing()`	`Number`	Mengambil spasi baris, dalam titik.
`getLinkUrl()`	`String`	Mengambil URL link.
`getListId()`	`String`	Mengambil ID daftar.
`getNestingLevel()`	`Integer`	Mengambil level hierarki item daftar.
`getNextSibling()`	`Element`	Mengambil elemen seinduk elemen berikutnya.
`getNumChildren()`	`Integer`	Mengambil jumlah turunan.
`getParent()`	`ContainerElement`	Mengambil elemen induk elemen.
`getPositionedImage(id)`	`PositionedImage`	Mendapatkan `PositionedImage` berdasarkan ID gambar.
`getPositionedImages()`	`PositionedImage[]`	Mendapatkan semua objek `PositionedImage` yang ditambatkan ke paragraf.
`getPreviousSibling()`	`Element`	Mengambil elemen seinduk elemen sebelumnya.
`getSpacingAfter()`	`Number`	Mengambil spasi setelah elemen, dalam titik.
`getSpacingBefore()`	`Number`	Mengambil spasi sebelum elemen, dalam titik.
`getText()`	`String`	Mengambil konten elemen sebagai string teks.
`getTextAlignment()`	`TextAlignment`	Mendapatkan perataan teks.
`getType()`	`ElementType`	Mengambil `ElementType` elemen.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Membuat dan menyisipkan `HorizontalRule` pada indeks yang ditentukan.
`insertInlineImage(childIndex, image)`	`InlineImage`	Membuat dan menyisipkan `InlineImage` baru dari blob gambar yang ditentukan, pada indeks yang ditentukan.
`insertInlineImage(childIndex, image)`	`InlineImage`	Menyisipkan `InlineImage` yang ditentukan pada indeks yang ditentukan.
`insertPageBreak(childIndex)`	`PageBreak`	Membuat dan menyisipkan `PageBreak` baru pada indeks yang ditentukan.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Menyisipkan `PageBreak` yang ditentukan pada indeks yang ditentukan.
`insertText(childIndex, text)`	`Text`	Membuat dan menyisipkan elemen teks baru pada indeks yang ditentukan.
`insertText(childIndex, text)`	`Text`	Menyisipkan elemen `Text` yang diberikan pada indeks yang ditentukan, dengan konten teks yang ditentukan.
`isAtDocumentEnd()`	`Boolean`	Menentukan apakah elemen berada di akhir `Document`.
`isLeftToRight()`	`Boolean`	Mengambil setelan kiri-ke-kanan.
`merge()`	`ListItem`	Menggabungkan elemen dengan pasangan sebelumnya dari jenis yang sama.
`removeChild(child)`	`ListItem`	Menghapus elemen turunan yang ditentukan.
`removeFromParent()`	`ListItem`	Menghapus elemen dari induknya.
`removePositionedImage(id)`	`Boolean`	Menghapus `PositionedImage` berdasarkan ID gambar.
`replaceText(searchPattern, replacement)`	`Element`	Mengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi reguler.
`setAlignment(alignment)`	`ListItem`	Menetapkan `HorizontalAlignment`.
`setAttributes(attributes)`	`ListItem`	Menetapkan atribut elemen.
`setGlyphType(glyphType)`	`ListItem`	Menetapkan `GlyphType` item daftar.
`setHeading(heading)`	`ListItem`	Menetapkan `ParagraphHeading`.
`setIndentEnd(indentEnd)`	`ListItem`	Menetapkan indentasi akhir, dalam titik.
`setIndentFirstLine(indentFirstLine)`	`ListItem`	Menetapkan indentasi baris pertama, dalam titik.
`setIndentStart(indentStart)`	`ListItem`	Menetapkan indentasi awal, dalam titik.
`setLeftToRight(leftToRight)`	`ListItem`	Menetapkan setelan kiri-ke-kanan.
`setLineSpacing(multiplier)`	`ListItem`	Menetapkan spasi baris, sebagai kuantitas yang menunjukkan jumlah baris yang digunakan untuk spasi.
`setLinkUrl(url)`	`ListItem`	Menetapkan URL link.
`setListId(listItem)`	`ListItem`	Menetapkan ID daftar.
`setNestingLevel(nestingLevel)`	`ListItem`	Menetapkan level hierarki item daftar.
`setSpacingAfter(spacingAfter)`	`ListItem`	Menetapkan spasi setelah elemen, dalam titik.
`setSpacingBefore(spacingBefore)`	`ListItem`	Menetapkan spasi sebelum elemen, dalam titik.
`setText(text)`	`void`	Menetapkan konten item daftar sebagai teks.
`setTextAlignment(textAlignment)`	`ListItem`	Menetapkan perataan teks.

Dokumentasi mendetail

`addPositionedImage(image)`

Membuat dan menyisipkan PositionedImage baru dari blob gambar yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`image`	`BlobSource`	data gambar

Return

PositionedImage — gambar baru 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

`appendHorizontalRule()`

Membuat dan menambahkan HorizontalRule baru.

Return

HorizontalRule — garis 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

Nama	Jenis	Deskripsi
`image`	`BlobSource`	data gambar

Return

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 ditentukan.

Parameter

Nama	Jenis	Deskripsi
`image`	`InlineImage`	data gambar

Return

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 mungkin tidak ada dalam TableCells. Jika elemen saat ini dimuat dalam sel tabel, pengecualian akan dilempar.

Return

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 ditentukan.

Catatan: PageBreaks mungkin tidak ada dalam TableCells. Jika elemen saat ini dimuat dalam sel tabel, pengecualian akan dilempar.

Parameter

Nama	Jenis	Deskripsi
`pageBreak`	`PageBreak`	batas halaman untuk ditambahkan

Return

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

Nama	Jenis	Deskripsi
`text`	`String`	konten teks

Return

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

Nama	Jenis	Deskripsi
`text`	`Text`	elemen teks untuk menambahkan

Return

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.

Return

ListItem — elemen saat ini

`copy()`

Menampilkan salinan mendalam dan terpisah dari elemen saat ini.

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

Return

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 dari elemen saat ini, untuk diedit.

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

Elemen turunan yang sepenuhnya terdapat dalam rentang teks yang dihapus dihapus dari elemen.

var body = DocumentApp.getActiveDocument().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);

Return

Text — versi teks dari elemen saat ini

`findElement(elementType)`

Menelusuri konten elemen untuk turunan dari jenis yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`elementType`	`ElementType`	jenis elemen yang akan dicari

Return

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 turunan dari jenis yang ditentukan, mulai dari RangeElement yang ditentukan.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parameter

Nama	Jenis	Deskripsi
`elementType`	`ElementType`	jenis elemen yang akan dicari
`from`	`RangeElement`	hasil penelusuran untuk mencari

Return

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.

Subset fitur ekspresi reguler JavaScript tidak sepenuhnya didukung, seperti grup tangkapan dan pengubah mode.

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

Parameter

Nama	Jenis	Deskripsi
`searchPattern`	`String`	pola untuk mencari

Return

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.

Subset fitur ekspresi reguler JavaScript tidak sepenuhnya didukung, seperti grup tangkapan dan pengubah mode.

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

Parameter

Nama	Jenis	Deskripsi
`searchPattern`	`String`	pola untuk mencari
`from`	`RangeElement`	hasil penelusuran untuk mencari

Return

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.

Return

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.

var body = DocumentApp.getActiveDocument().getBody();

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

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

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

Return

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.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var 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

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks elemen turunan untuk mengambil

Return

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

Nama	Jenis	Deskripsi
`child`	`Element`	elemen turunan untuk mengambil indeks

Return

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.

Return

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.

Return

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 titik.

Return

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 titik.

Return

Number — indentasi baris pertama, dalam titik

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.

Return

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 titik.

Return

Number — jarak antar-baris, 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.

Return

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.

Return

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 tingkat hierarki nol. Tingkat bertingkat menentukan glyph yang digunakan oleh item daftar.

Return

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 seinduk elemen berikutnya.

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

Return

Element — Elemen seinduk 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.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Return

Integer — jumlah anak

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.

Return

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

Nama	Jenis	Deskripsi
`id`	`String`	id gambar

Return

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 ditambatkan ke paragraf.

Return

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 seinduk elemen sebelumnya.

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

Return

Element — Elemen seinduk 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 titik.

Return

Number — spasi setelah elemen, dalam titik

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 titik.

Return

Number — spasi sebelum elemen, dalam titik

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.

Return

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.

Return

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 yang tepat dari elemen tertentu.

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document body.

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

Return

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 pada indeks yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks untuk menyisipkan elemen

Return

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

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks untuk menyisipkan elemen
`image`	`BlobSource`	data gambar

Return

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 ditentukan pada indeks yang ditentukan.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks untuk menyisipkan elemen
`image`	`InlineImage`	data gambar

Return

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 pada indeks yang ditentukan.

Catatan: PageBreaks mungkin tidak ada dalam TableCells. Jika elemen saat ini dimuat dalam sel tabel, pengecualian akan dilempar.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks untuk menyisipkan elemen

Return

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 ditentukan pada indeks yang ditentukan.

Catatan: PageBreaks mungkin tidak ada dalam TableCells. Jika elemen saat ini dimuat dalam sel tabel, pengecualian akan dilempar.

Parameter

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks untuk menyisipkan elemen
`pageBreak`	`PageBreak`	p[age break [batas usia] untuk menyisipkan

Return

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

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks untuk menyisipkan elemen
`text`	`String`	konten teks

Return

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

Nama	Jenis	Deskripsi
`childIndex`	`Integer`	indeks untuk menyisipkan elemen
`text`	`Text`	elemen teks untuk menyisipkan

Return

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.

Return

Boolean — Apakah elemen berada di akhir dokumen.

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.

Return

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 pasangan sebelumnya dari jenis yang sama.

Hanya elemen dari ElementType yang sama yang dapat digabungkan. Setiap elemen turunan yang terkandung dalam elemen saat ini akan dipindahkan ke elemen seinduk sebelumnya.

Elemen saat ini dihapus dari dokumen.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

Return

ListItem — Elemen gabungan.

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

Nama	Jenis	Deskripsi
`child`	`Element`	elemen turunan yang akan dihapus

Return

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.

var body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Return

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

Nama	Jenis	Deskripsi
`id`	`String`

Return

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 setiap garis miring terbalik di pola tersebut.

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.

var body = DocumentApp.getActiveDocument().getBody();

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

Parameter

Nama	Jenis	Deskripsi
`searchPattern`	`String`	pola regex untuk mencari
`replacement`	`String`	teks untuk digunakan sebagai pengganti

Return

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

Nama	Jenis	Deskripsi
`alignment`	`HorizontalAlignment`	perataan horizontal

Return

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 merupakan item dalam enumerasi DocumentApp.Attribute dan setiap nilai properti adalah nilai baru yang akan diterapkan.

var body = DocumentApp.getActiveDocument().getBody();

// Define a custom paragraph style.
var 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.
var par = body.appendParagraph('A paragraph with custom style.');

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

Parameter

Nama	Jenis	Deskripsi
`attributes`	`Object`	Atribut elemen.

Return

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

Nama	Jenis	Deskripsi
`glyphType`	`GlyphType`	jenis glyph

Return

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

Nama	Jenis	Deskripsi
`heading`	`ParagraphHeading`	judul

Return

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 titik.

Parameter

Nama	Jenis	Deskripsi
`indentEnd`	`Number`	indentasi akhir, dalam poin

Return

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 titik.

Parameter

Nama	Jenis	Deskripsi
`indentFirstLine`	`Number`	indentasi baris pertama, pada titik

Return

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 titik.

Parameter

Nama	Jenis	Deskripsi
`indentStart`	`Number`	indentasi awal, dalam poin

Return

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

Nama	Jenis	Deskripsi
`leftToRight`	`Boolean`	setelan kiri-ke-kanan

Return

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 digunakan untuk spasi.

Parameter

Nama	Jenis	Deskripsi
`multiplier`	`Number`	jumlah baris

Return

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

Nama	Jenis	Deskripsi
`url`	`String`	URL link

Return

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

Nama	Jenis	Deskripsi
`listItem`	`ListItem`	item daftar yang ID daftarnya akan digunakan

Return

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 tingkat hierarki nol. Tingkat bertingkat menentukan glyph yang digunakan oleh item daftar.

Parameter

Nama	Jenis	Deskripsi
`nestingLevel`	`Integer`	{i>nesting level<i} (tingkat hierarki)

Return

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 titik.

Parameter

Nama	Jenis	Deskripsi
`spacingAfter`	`Number`	spasi setelah elemen, dalam poin

Return

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 titik.

Parameter

Nama	Jenis	Deskripsi
`spacingBefore`	`Number`	spasi sebelum elemen, dalam poin

Return

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

Nama	Jenis	Deskripsi
`text`	`String`	konten 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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parameter

Nama	Jenis	Deskripsi
`textAlignment`	`TextAlignment`	jenis perataan teks yang akan diterapkan

Return

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