Class InlineImage

InlineImage

Elemen yang mewakili gambar tersemat. InlineImage dapat dimuat dalam ListItem atau Paragraph, kecuali jika ListItem atau Paragraph berada dalam FootnoteSection. InlineImage tidak boleh berisi elemen lain. Untuk mengetahui informasi selengkapnya tentang struktur dokumen, lihat panduan memperluas Google Dokumen.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
copy()InlineImageMenampilkan salinan mendalam dan terpisah dari elemen saat ini.
getAltDescription()StringMenampilkan deskripsi alternatif gambar.
getAltTitle()StringMenampilkan judul alternatif gambar.
getAs(contentType)BlobMenampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan.
getAttributes()ObjectMengambil atribut elemen.
getBlob()BlobMenampilkan data di dalam objek ini sebagai blob.
getHeight()IntegerMengambil tinggi gambar, dalam piksel.
getLinkUrl()StringMengambil URL link.
getNextSibling()ElementMengambil elemen seinduk elemen berikutnya.
getParent()ContainerElementMengambil elemen induk elemen.
getPreviousSibling()ElementMengambil elemen seinduk elemen sebelumnya.
getType()ElementTypeMengambil ElementType elemen.
getWidth()IntegerMengambil lebar gambar, dalam piksel.
isAtDocumentEnd()BooleanMenentukan apakah elemen berada di akhir Document.
merge()InlineImageMenggabungkan elemen dengan pasangan sebelumnya dari jenis yang sama.
removeFromParent()InlineImageMenghapus elemen dari induknya.
setAltDescription(description)InlineImageMenetapkan deskripsi alternatif gambar.
setAltTitle(title)InlineImageMenetapkan judul alternatif gambar.
setAttributes(attributes)InlineImageMenetapkan atribut elemen.
setHeight(height)InlineImageMenetapkan tinggi gambar, dalam piksel.
setLinkUrl(url)InlineImageMenetapkan URL link.
setWidth(width)InlineImageMenetapkan lebar gambar, dalam piksel.

Dokumentasi mendetail

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

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

getAltDescription()

Menampilkan deskripsi alternatif gambar.

Return

String — judul alternatif, atau null jika elemen tidak memiliki judul alternatif

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAltTitle()

Menampilkan judul alternatif gambar.

Return

String — judul alternatif, atau null jika elemen tidak memiliki judul alternatif

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAs(contentType)

Menampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan. Metode ini menambahkan ekstensi yang sesuai ke nama file—misalnya, "myfile.pdf". Namun, dianggap bahwa bagian nama file yang mengikuti titik terakhir (jika ada) adalah ekstensi yang sudah ada dan harus diganti. Akibatnya, "ShoppingList.12.25.2014" menjadi "ShoppingList.12.25.pdf".

Untuk melihat kuota harian konversi, lihat Kuota untuk Layanan Google. Domain Google Workspace yang baru dibuat untuk sementara mungkin dikenai kuota yang lebih ketat.

Parameter

NamaJenisDeskripsi
contentTypeStringJenis MIME yang menjadi tujuan konversi. Untuk sebagian besar blob, 'application/pdf' adalah satu-satunya opsi yang valid. Untuk gambar dalam format BMP, GIF, JPEG, atau PNG, 'image/bmp', 'image/gif', 'image/jpeg', atau 'image/png' juga valid.

Return

Blob — Data sebagai blob.


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

getBlob()

Menampilkan data di dalam objek ini sebagai blob.

Return

Blob — Data sebagai blob.


getHeight()

Mengambil tinggi gambar, dalam piksel.

Return

Integer — tinggi gambar, dalam piksel

Otorisasi

Skrip yang 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

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

getWidth()

Mengambil lebar gambar, dalam piksel.

Return

Integer — lebar gambar dalam piksel

Otorisasi

Skrip yang 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

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

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

setAltDescription(description)

Menetapkan deskripsi alternatif gambar. Jika judul yang diberikan adalah null, tetapkan deskripsi ke string kosong.

Parameter

NamaJenisDeskripsi
descriptionStringjudul alternatif

Return

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

setAltTitle(title)

Menetapkan judul alternatif gambar. Jika judul yang diberikan adalah null, menetapkan judul ke string kosong.

Parameter

NamaJenisDeskripsi
titleStringjudul alternatif

Return

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

NamaJenisDeskripsi
attributesObjectAtribut elemen.

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

setHeight(height)

Menetapkan tinggi gambar, dalam piksel.

Parameter

NamaJenisDeskripsi
heightIntegertinggi gambar, dalam piksel

Return

InlineImage — objek 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. Jika URL yang diberikan adalah null atau string kosong, metode ini akan membuat link dengan URL kosong yang mungkin ditampilkan sebagai "Link tidak valid" di Google Dokumen.

Parameter

NamaJenisDeskripsi
urlStringURL link

Return

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

setWidth(width)

Menetapkan lebar gambar, dalam piksel.

Parameter

NamaJenisDeskripsi
widthIntegerlebar gambar, dalam piksel

Return

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