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
BodyElemen yang mewakili isi dokumen.
ContainerElementElemen generik yang mungkin berisi elemen lain.
DateElemen yang mewakili tanggal yang telah diformat
EquationElemen yang mewakili ekspresi matematika.
EquationFunctionElemen yang merepresentasikan fungsi dalam Equation matematika.
EquationFunctionArgumentSeparatorElemen yang mewakili pemisah fungsi dalam Equation matematika.
EquationSymbolElemen yang merepresentasikan simbol dalam Equation matematika.
FooterSectionElemen yang mewakili bagian {i>footer<i}.
FootnoteElemen yang merepresentasikan catatan kaki.
FootnoteSectionElemen yang merepresentasikan bagian catatan kaki.
HeaderSectionElemen yang mewakili bagian header.
HorizontalRuleElemen yang mewakili penggaris horizontal.
InlineDrawingElemen yang mewakili gambar tersemat.
InlineImageElemen yang mewakili gambar tersemat.
ListItemElemen yang mewakili item daftar.
PageBreakElemen yang mewakili batas halaman.
ParagraphElemen yang mewakili paragraf.
PersonElemen yang mewakili tautan ke seseorang.
RichLinkElemen yang mewakili link ke referensi Google, seperti file Drive atau video YouTube.
TableElemen yang mewakili tabel.
TableCellElemen yang mewakili sel tabel.
TableOfContentsElemen yang berisi daftar isi.
TableRowElemen yang mewakili baris tabel.
TextElemen yang mewakili region rich text.
UnsupportedElementElemen yang mewakili 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 dan terpisah dari elemen saat ini.
getAttributes()ObjectMengambil atribut elemen.
getNextSibling()ElementMengambil elemen seinduk elemen berikutnya.
getParent()ContainerElementMengambil elemen induk elemen.
getPreviousSibling()ElementMengambil elemen seinduk elemen sebelumnya.
getType()ElementTypeMengambil ElementType elemen.
isAtDocumentEnd()BooleanMenentukan apakah elemen berada di akhir Document.
merge()ElementMenggabungkan elemen dengan pasangan sebelumnya dari jenis yang sama.
removeFromParent()ElementMenghapus 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 berjenis tertentu.

Return

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 elemen adalah Date, gunakan metode ini untuk menetapkan jenisnya sebagai Date. Dengan begitu, pelengkapan otomatis di editor Apps Script akan menampilkan metode yang dapat Anda gunakan dengan Date.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

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

asPageBreak()

Menampilkan elemen saat ini sebagai PageBreak.

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

Return

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 berjenis tertentu.

Return

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 mengetahui bahwa suatu elemen adalah Person, gunakan metode ini untuk menetapkan jenisnya sebagai pribadi. Dengan melakukannya, pelengkapan otomatis di editor Apps Script dapat menampilkan metode yang dapat Anda gunakan dengan elemen orang.

Return

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

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 berjenis tertentu.

Return

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 dan terpisah dari elemen saat ini.

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

Return

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.

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

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

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

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

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

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

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

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

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

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

NamaJenisDeskripsi
attributesObjectAtribut elemen.

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