Interface Element

Elemen

Elemen generik. Konten Document direpresentasikan sebagai elemen. Misalnya, ListItem, Paragraph, dan Table adalah elemen dan mewarisi semua metode yang ditentukan oleh Element, seperti getType().

Mengimplementasikan class

NamaDeskripsi singkat
BodyKonten tab dalam dokumen Google Dokumen.
ContainerElementElemen generik yang dapat berisi elemen lain.
DateElemen yang mewakili tanggal yang diformat
EquationElemen yang merepresentasikan ekspresi matematika.
EquationFunctionElemen yang merepresentasikan fungsi dalam Equation matematika.
EquationFunctionArgumentSeparatorElemen yang merepresentasikan pemisah fungsi dalam Equation matematika.
EquationSymbolElemen yang merepresentasikan simbol dalam Equation matematika.
FooterSectionElemen yang mewakili bagian footer.
FootnoteElemen yang merepresentasikan catatan kaki.
FootnoteSectionElemen yang merepresentasikan bagian catatan kaki.
HeaderSectionElemen yang merepresentasikan bagian header.
HorizontalRuleElemen yang merepresentasikan aturan horizontal.
InlineDrawingElemen yang mewakili gambar yang disematkan.
InlineImageElemen yang merepresentasikan gambar sematan.
ListItemElemen yang mewakili item daftar.
PageBreakElemen yang merepresentasikan jeda halaman.
ParagraphElemen yang merepresentasikan paragraf.
PersonElemen yang mewakili link ke seseorang.
RichLinkElemen yang merepresentasikan link ke resource Google, seperti file Drive atau video YouTube.
TableElemen yang merepresentasikan tabel.
TableCellElemen yang merepresentasikan sel tabel.
TableOfContentsElemen yang berisi daftar isi.
TableRowElemen yang merepresentasikan baris tabel.
TextElemen yang merepresentasikan area teks kaya.
UnsupportedElementElemen yang merepresentasikan wilayah yang tidak diketahui atau tidak dapat dipengaruhi oleh skrip, seperti nomor halaman.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
asBody()BodyMenampilkan elemen saat ini sebagai Body.
asDate()DateMenampilkan elemen saat ini sebagai Date.
asEquation()EquationMenampilkan elemen saat ini sebagai Equation.
asEquationFunction()EquationFunctionMenampilkan elemen saat ini sebagai EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorMenampilkan elemen saat ini sebagai EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolMenampilkan elemen saat ini sebagai EquationSymbol.
asFooterSection()FooterSectionMenampilkan elemen saat ini sebagai FooterSection.
asFootnote()FootnoteMenampilkan elemen saat ini sebagai Footnote.
asFootnoteSection()FootnoteSectionMenampilkan elemen saat ini sebagai FootnoteSection.
asHeaderSection()HeaderSectionMenampilkan elemen saat ini sebagai HeaderSection.
asHorizontalRule()HorizontalRuleMenampilkan elemen saat ini sebagai HorizontalRule.
asInlineDrawing()InlineDrawingMenampilkan elemen saat ini sebagai InlineDrawing.
asInlineImage()InlineImageMenampilkan elemen saat ini sebagai InlineImage.
asListItem()ListItemMenampilkan elemen saat ini sebagai ListItem.
asPageBreak()PageBreakMenampilkan elemen saat ini sebagai PageBreak.
asParagraph()ParagraphMenampilkan elemen saat ini sebagai Paragraph.
asPerson()PersonMenampilkan elemen saat ini sebagai Person.
asRichLink()RichLinkMenampilkan elemen saat ini sebagai RichLink, misalnya, link ke file Google Spreadsheet.
asTable()TableMenampilkan elemen saat ini sebagai Table.
asTableCell()TableCellMenampilkan elemen saat ini sebagai TableCell.
asTableOfContents()TableOfContentsMenampilkan elemen saat ini sebagai TableOfContents.
asTableRow()TableRowMenampilkan elemen saat ini sebagai TableRow.
asText()TextMenampilkan elemen saat ini sebagai Text.
copy()ElementMenampilkan salinan mendalam yang terlepas dari elemen saat ini.
getAttributes()ObjectMengambil atribut elemen.
getNextSibling()Element|nullMengambil elemen pasangan berikutnya dari elemen.
getParent()ContainerElement|nullMengambil elemen induk elemen.
getPreviousSibling()Element|nullMengambil elemen saudara sebelumnya dari elemen.
getType()ElementTypeMengambil ElementType elemen.
isAtDocumentEnd()BooleanMenentukan apakah elemen berada di akhir Document.
merge()Element|nullMenggabungkan elemen dengan elemen saudara sebelumnya dengan jenis yang sama.
removeFromParent()Element|nullMenghapus elemen dari induknya.
setAttributes(attributes)ElementMenetapkan atribut elemen.

Dokumentasi mendetail

asBody()

Menampilkan elemen saat ini sebagai Body.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

Body — 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

asDate()

Menampilkan elemen saat ini sebagai Date.

Jika Anda mengetahui bahwa suatu elemen adalah Date, gunakan metode ini untuk menetapkan jenisnya sebagai Date. Dengan melakukannya, pelengkapan otomatis di editor Apps Script akan menampilkan metode yang dapat Anda gunakan dengan Date.

Pulang pergi

Date — Elemen saat ini dengan jenisnya ditetapkan sebagai Date.

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

asEquation()

Menampilkan elemen saat ini sebagai Equation.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

Equation — 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

asEquationFunction()

Menampilkan elemen saat ini sebagai EquationFunction.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

EquationFunction — 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

asEquationFunctionArgumentSeparator()

Menampilkan elemen saat ini sebagai EquationFunctionArgumentSeparator.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

EquationFunctionArgumentSeparator — 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

asEquationSymbol()

Menampilkan elemen saat ini sebagai EquationSymbol.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

EquationSymbol — 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

asFooterSection()

Menampilkan elemen saat ini sebagai FooterSection.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

FooterSection — 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

asFootnote()

Menampilkan elemen saat ini sebagai Footnote.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

Footnote — 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

asFootnoteSection()

Menampilkan elemen saat ini sebagai FootnoteSection.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

FootnoteSection — 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

asHeaderSection()

Menampilkan elemen saat ini sebagai HeaderSection.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

HeaderSection — 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

asHorizontalRule()

Menampilkan elemen saat ini sebagai HorizontalRule.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

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

asInlineDrawing()

Menampilkan elemen saat ini sebagai InlineDrawing.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

InlineDrawing — 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

asInlineImage()

Menampilkan elemen saat ini sebagai InlineImage.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

InlineImage — 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

asListItem()

Menampilkan elemen saat ini sebagai ListItem.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

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

asPageBreak()

Menampilkan elemen saat ini sebagai PageBreak.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

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

asParagraph()

Menampilkan elemen saat ini sebagai Paragraph.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

Paragraph — 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

asPerson()

Menampilkan elemen saat ini sebagai Person.

Jika Anda tahu bahwa suatu elemen adalah Person, gunakan metode ini untuk menetapkan jenisnya sebagai orang. Dengan melakukannya, pelengkapan otomatis di editor Apps Script akan menampilkan metode yang dapat Anda gunakan dengan elemen orang.

Pulang pergi

Person — Elemen saat ini dengan jenisnya ditetapkan sebagai Person.

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

Menampilkan elemen saat ini sebagai RichLink, misalnya, link ke file Google Spreadsheet.

Jika Anda mengetahui bahwa suatu elemen adalah RichLink, gunakan metode ini untuk menetapkan jenisnya sebagai RichLink. Dengan melakukannya, pelengkapan otomatis di editor Apps Script akan menampilkan metode yang dapat Anda gunakan dengan RichLink.

Pulang pergi

RichLink — Elemen saat ini dengan jenisnya ditetapkan sebagai RichLink.

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

asTable()

Menampilkan elemen saat ini sebagai Table.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

Table — 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

asTableCell()

Menampilkan elemen saat ini sebagai TableCell.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

TableCell — 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

asTableOfContents()

Menampilkan elemen saat ini sebagai TableOfContents.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

TableOfContents — 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

asTableRow()

Menampilkan elemen saat ini sebagai TableRow.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

TableRow — 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

asText()

Menampilkan elemen saat ini sebagai Text.

Gunakan metode ini untuk membantu pelengkapan otomatis setiap kali elemen tertentu diketahui memiliki jenis tertentu.

Pulang pergi

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

copy()

Menampilkan salinan mendalam yang terlepas dari elemen saat ini.

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

Pulang pergi

Element — 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

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

getNextSibling()

Mengambil elemen pasangan berikutnya dari elemen.

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

Pulang pergi

Element|null — Elemen saudara 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

getParent()

Mengambil elemen induk elemen.

Elemen induk berisi elemen saat ini.

Pulang pergi

ContainerElement|null — 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

getPreviousSibling()

Mengambil elemen saudara sebelumnya dari elemen.

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

Pulang pergi

Element|null — Elemen saudara 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

getType()

Mengambil ElementType elemen.

Gunakan getType() untuk menentukan jenis pasti 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

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

merge()

Menggabungkan elemen dengan elemen saudara sebelumnya dengan jenis yang sama.

Hanya elemen dengan ElementType yang sama yang dapat digabungkan. Elemen turunan apa pun yang ada dalam elemen saat ini 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

Element|null — 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

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

Element|null — 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

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

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