Elemen yang mewakili item daftar. List
adalah Paragraph
yang terkait
dengan ID daftar. List
dapat berisi elemen Equation
, Footnote
, Horizontal
, Inline
, Inline
, Page
, dan Text
. Untuk informasi selengkapnya tentang struktur dokumen, lihat panduan untuk memperluas Google Dokumen.
List
tidak boleh berisi karakter baris baru. Karakter baris baru ("\n")
dikonversi menjadi karakter baris baru ("\r").
List
dengan ID daftar yang sama termasuk dalam daftar yang sama dan diberi nomor yang sesuai.
List
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
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
add | Positioned | Membuat dan menyisipkan Positioned baru dari blob gambar yang ditentukan. |
append | Horizontal | Membuat dan menambahkan Horizontal baru. |
append | Inline | Membuat dan menambahkan Inline baru dari blob gambar yang ditentukan. |
append | Inline | Menambahkan Inline yang diberikan. |
append | Page | Membuat dan menambahkan Page baru. |
append | Page | Menambahkan Page yang diberikan. |
append | Text | Membuat dan menambahkan elemen Text baru dengan konten yang ditentukan. |
append | Text | Menambahkan elemen Text yang diberikan. |
clear() | List | Menghapus konten elemen. |
copy() | List | Menampilkan salinan mendalam yang terpisah dari elemen saat ini. |
edit | Text | Mendapatkan versi Text elemen saat ini, untuk diedit. |
find | Range | Menelusuri konten elemen untuk menemukan turunan dari jenis yang ditentukan. |
find | Range | Menelusuri konten elemen untuk mencari turunan dari jenis yang ditentukan, mulai dari
Range yang ditentukan. |
find | Range | Menelusuri konten elemen untuk pola teks yang ditentukan menggunakan ekspresi reguler. |
find | Range | Menelusuri konten elemen untuk pola teks yang ditentukan, mulai dari hasil penelusuran tertentu. |
get | Horizontal | Mengambil Horizontal . |
get | Object | Mengambil atribut elemen. |
get | Element | Mengambil elemen turunan pada indeks turunan yang ditentukan. |
get | Integer | Mengambil indeks turunan untuk elemen turunan yang ditentukan. |
get | Glyph | Mengambil Glyph item daftar. |
get | Paragraph | Mengambil Paragraph . |
get | Number | Mengambil indentasi akhir, dalam poin. |
get | Number | Mengambil indentasi baris pertama, dalam poin. |
get | Number | Mengambil indentasi awal. |
get | Number | Mengambil spasi baris, dalam poin. |
get | String | Mengambil URL link. |
get | String | Mengambil ID daftar. |
get | Integer | Mengambil level hierarki item daftar. |
get | Element | Mengambil elemen pasangan berikutnya dari elemen. |
get | Integer | Mengambil jumlah turunan. |
get | Container | Mengambil elemen induk elemen. |
get | Positioned | Mendapatkan Positioned berdasarkan ID gambar. |
get | Positioned | Mendapatkan semua objek Positioned yang ditautkan ke paragraf. |
get | Element | Mengambil elemen saudara sebelumnya dari elemen. |
get | Number | Mengambil spasi setelah elemen, dalam poin. |
get | Number | Mengambil spasi sebelum elemen, dalam poin. |
get | String | Mengambil konten elemen sebagai string teks. |
get | Text | Mendapatkan perataan teks. |
get | Element | Mengambil Element elemen. |
insert | Horizontal | Membuat dan menyisipkan Horizontal di indeks yang ditentukan. |
insert | Inline | Membuat dan menyisipkan Inline baru dari blob gambar yang ditentukan, pada indeks
yang ditentukan. |
insert | Inline | Menyisipkan Inline yang diberikan pada indeks yang ditentukan. |
insert | Page | Membuat dan menyisipkan Page baru di indeks yang ditentukan. |
insert | Page | Menyisipkan Page yang diberikan pada indeks yang ditentukan. |
insert | Text | Membuat dan menyisipkan elemen teks baru pada indeks yang ditentukan. |
insert | Text | Menyisipkan elemen Text yang diberikan pada indeks yang ditentukan, dengan konten teks yang ditentukan. |
is | Boolean | Menentukan apakah elemen berada di akhir Document . |
is | Boolean | Mengambil setelan kiri-ke-kanan. |
merge() | List | Menggabungkan elemen dengan elemen sebelumnya dari jenis yang sama. |
remove | List | Menghapus elemen turunan yang ditentukan. |
remove | List | Menghapus elemen dari induknya. |
remove | Boolean | Menghapus Positioned berdasarkan ID gambar. |
replace | Element | Mengganti semua kemunculan pola teks tertentu dengan string pengganti tertentu, menggunakan ekspresi reguler. |
set | List | Menetapkan Horizontal . |
set | List | Menetapkan atribut elemen. |
set | List | Menetapkan Glyph item daftar. |
set | List | Menetapkan Paragraph . |
set | List | Menetapkan indentasi akhir, dalam poin. |
set | List | Menetapkan indentasi baris pertama, dalam poin. |
set | List | Menetapkan indentasi awal, dalam poin. |
set | List | Menetapkan setelan kiri-ke-kanan. |
set | List | Menetapkan spasi baris, sebagai kuantitas yang menunjukkan jumlah baris yang akan digunakan untuk spasi. |
set | List | Menetapkan URL link. |
set | List | Menetapkan ID daftar. |
set | List | Menetapkan level hierarki item daftar. |
set | List | Menetapkan spasi setelah elemen, dalam poin. |
set | List | Menetapkan spasi sebelum elemen, dalam poin. |
set | void | Menetapkan konten item daftar sebagai teks. |
set | List | Menetapkan perataan teks. |
Dokumentasi mendetail
add Positioned Image(image)
Membuat dan menyisipkan Positioned
baru dari blob gambar yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
image | Blob | data gambar |
Pulang pergi
Positioned
— 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
append Horizontal Rule()
Membuat dan menambahkan Horizontal
baru.
Pulang pergi
Horizontal
— 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
append Inline Image(image)
Membuat dan menambahkan Inline
baru dari blob gambar yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
image | Blob | data gambar |
Pulang pergi
Inline
— 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
append Inline Image(image)
Menambahkan Inline
yang diberikan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
image | Inline | data gambar |
Pulang pergi
Inline
— 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
append Page Break()
Membuat dan menambahkan Page
baru.
Catatan: Page
tidak boleh berada dalam Table
.
Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.
Pulang pergi
Page
— 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
append Page Break(pageBreak)
Menambahkan Page
yang diberikan.
Catatan: Page
tidak boleh berada dalam Table
.
Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
page | Page | batas halaman yang akan ditambahkan |
Pulang pergi
Page
— 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
append Text(text)
Membuat dan menambahkan elemen Text
baru dengan konten yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
text | String | konten 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
append Text(text)
Menambahkan elemen Text
yang diberikan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
text | Text | elemen 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()
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
List
— 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
edit As Text()
Mendapatkan versi Text
elemen saat ini, untuk diedit.
Gunakan edit
untuk memanipulasi konten elemen sebagai teks kaya. Mode edit
mengabaikan elemen non-teks (seperti Inline
dan Horizontal
).
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
find Element(elementType)
Menelusuri konten elemen untuk menemukan turunan dari jenis yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
element | Element | Jenis elemen yang akan ditelusuri. |
Pulang pergi
Range
— 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
find Element(elementType, from)
Menelusuri konten elemen untuk mencari turunan dari jenis yang ditentukan, mulai dari
Range
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
Nama | Jenis | Deskripsi |
---|---|---|
element | Element | Jenis elemen yang akan ditelusuri. |
from | Range | Hasil penelusuran yang akan digunakan untuk melakukan penelusuran. |
Pulang pergi
Range
— 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
find Text(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
Nama | Jenis | Deskripsi |
---|---|---|
search | String | pola yang akan ditelusuri |
Pulang pergi
Range
— 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
find Text(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
Nama | Jenis | Deskripsi |
---|---|---|
search | String | pola yang akan ditelusuri |
from | Range | hasil penelusuran yang akan digunakan untuk menelusuri |
Pulang pergi
Range
— 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
get Alignment()
Mengambil Horizontal
.
Pulang pergi
Horizontal
— 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
get Attributes()
Mengambil atribut elemen.
Hasilnya adalah objek yang berisi properti untuk setiap atribut elemen yang valid dengan setiap
nama properti sesuai dengan item dalam enumerasi Document
.
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
get Child(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
Nama | Jenis | Deskripsi |
---|---|---|
child | Integer | Indeks 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
get Child Index(child)
Mengambil indeks turunan untuk elemen turunan yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Element | Elemen 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
get Glyph Type()
get Heading()
Mengambil Paragraph
.
Pulang pergi
Paragraph
— 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
get Indent End()
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
get Indent First Line()
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
get Indent Start()
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
get Line Spacing()
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
get Link Url()
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
get List Id()
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
get Nesting Level()
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
get Next Sibling()
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
get Num Children()
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
get Parent()
Mengambil elemen induk elemen.
Elemen induk berisi elemen saat ini.
Pulang pergi
Container
— 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
get Positioned Image(id)
Mendapatkan Positioned
berdasarkan ID gambar.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
id | String | ID gambar |
Pulang pergi
Positioned
— 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
get Positioned Images()
Mendapatkan semua objek Positioned
yang ditautkan ke paragraf.
Pulang pergi
Positioned
— 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
get Previous Sibling()
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
get Spacing After()
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
get Spacing Before()
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
get Text()
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
get Text Alignment()
Mendapatkan perataan teks. Jenis perataan yang tersedia adalah Document
, Document
, dan Document
.
Pulang pergi
Text
— 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
get Type()
Mengambil Element
elemen.
Gunakan get
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
Element
— 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
insert Horizontal Rule(childIndex)
Membuat dan menyisipkan Horizontal
di indeks yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Integer | indeks tempat elemen disisipkan |
Pulang pergi
Horizontal
— 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
insert Inline Image(childIndex, image)
Membuat dan menyisipkan Inline
baru dari blob gambar yang ditentukan, pada indeks
yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Integer | indeks tempat elemen disisipkan |
image | Blob | data gambar |
Pulang pergi
Inline
— 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
insert Inline Image(childIndex, image)
Menyisipkan Inline
yang diberikan pada indeks yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Integer | indeks tempat elemen disisipkan |
image | Inline | data gambar |
Pulang pergi
Inline
— 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
insert Page Break(childIndex)
Membuat dan menyisipkan Page
baru di indeks yang ditentukan.
Catatan: Page
tidak boleh berada dalam Table
.
Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Integer | indeks tempat elemen disisipkan |
Pulang pergi
Page
— 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
insert Page Break(childIndex, pageBreak)
Menyisipkan Page
yang diberikan pada indeks yang ditentukan.
Catatan: Page
tidak boleh berada dalam Table
.
Jika elemen saat ini terdapat dalam sel tabel, pengecualian akan ditampilkan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Integer | indeks tempat elemen disisipkan |
page | Page | batas halaman yang akan disisipkan |
Pulang pergi
Page
— 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
insert Text(childIndex, text)
Membuat dan menyisipkan elemen teks baru pada indeks yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Integer | indeks tempat elemen disisipkan |
text | String | konten 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
insert Text(childIndex, text)
Menyisipkan elemen Text
yang diberikan pada indeks yang ditentukan, dengan konten teks yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Integer | indeks tempat elemen disisipkan |
text | Text | elemen 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
is At Document End()
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
is Left To Right()
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 Element
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
List
— 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
remove Child(child)
Menghapus elemen turunan yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
child | Element | elemen turunan yang akan dihapus |
Pulang pergi
List
— 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
remove From Parent()
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
List
— 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
remove Positioned Image(id)
Menghapus Positioned
berdasarkan ID gambar.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
id | String |
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
replace Text(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
Nama | Jenis | Deskripsi |
---|---|---|
search | String | pola ekspresi reguler yang akan ditelusuri |
replacement | String | teks 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
set Alignment(alignment)
Menetapkan Horizontal
.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
alignment | Horizontal | perataan horizontal |
Pulang pergi
List
— 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
set Attributes(attributes)
Menetapkan atribut elemen.
Parameter atribut yang ditentukan harus berupa objek dengan setiap nama properti adalah item dalam
enumerasi Document
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
Nama | Jenis | Deskripsi |
---|---|---|
attributes | Object | Atribut elemen. |
Pulang pergi
List
— 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
set Glyph Type(glyphType)
Menetapkan Glyph
item daftar.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
glyph | Glyph | jenis glyph |
Pulang pergi
List
— 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
set Heading(heading)
Menetapkan Paragraph
.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
heading | Paragraph | judul |
Pulang pergi
List
— 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
set Indent End(indentEnd)
Menetapkan indentasi akhir, dalam poin.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
indent | Number | indentasi akhir, dalam titik |
Pulang pergi
List
— 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
set Indent First Line(indentFirstLine)
Menetapkan indentasi baris pertama, dalam poin.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
indent | Number | indentasi baris pertama, dalam poin |
Pulang pergi
List
— 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
set Indent Start(indentStart)
Menetapkan indentasi awal, dalam poin.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
indent | Number | indentasi awal, dalam poin |
Pulang pergi
List
— 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
set Left To Right(leftToRight)
Menetapkan setelan kiri-ke-kanan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
left | Boolean | setelan kiri ke kanan |
Pulang pergi
List
— 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
set Line Spacing(multiplier)
Menetapkan spasi baris, sebagai kuantitas yang menunjukkan jumlah baris yang akan digunakan untuk spasi.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
multiplier | Number | jumlah baris |
Pulang pergi
List
— 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
set Link Url(url)
Menetapkan URL link.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
url | String | URL link |
Pulang pergi
List
— 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
set List Id(listItem)
Menetapkan ID daftar.
ID daftar ditetapkan ke nilai yang sama untuk List
yang ditentukan. Kedua List
akan diperlakukan sebagai anggota daftar yang sama.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
list | List | item daftar yang ID daftarnya akan digunakan |
Pulang pergi
List
— 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
set Nesting Level(nestingLevel)
Menetapkan level hierarki item daftar.
Secara default, item daftar memiliki level hierarki nol. Tingkat bertingkat menentukan glyph yang digunakan oleh item daftar.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
nesting | Integer | tingkat bertingkat |
Pulang pergi
List
— 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
set Spacing After(spacingAfter)
Menetapkan spasi setelah elemen, dalam poin.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
spacing | Number | spasi setelah elemen, dalam poin |
Pulang pergi
List
— 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
set Spacing Before(spacingBefore)
Menetapkan spasi sebelum elemen, dalam poin.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
spacing | Number | spasi sebelum elemen, dalam poin |
Pulang pergi
List
— 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
set Text(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
set Text Alignment(textAlignment)
Menetapkan perataan teks. Jenis perataan yang tersedia adalah Document
, Document
, dan Document
.
// 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
Nama | Jenis | Deskripsi |
---|---|---|
text | Text | jenis perataan teks yang akan diterapkan |
Pulang pergi
List
— 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