องค์ประกอบที่แสดงรูปภาพที่ฝังไว้ InlineImage
จะอยู่ภายใน ListItem
หรือ Paragraph
ได้ เว้นแต่ ListItem
หรือ Paragraph
จะอยู่ใน FootnoteSection
InlineImage
ไม่สามารถมีองค์ประกอบอื่นๆ ได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับโครงสร้างเอกสารได้ในคู่มือการขยายการใช้งาน Google เอกสาร
วิธีการ
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
copy() | InlineImage | แสดงผลสำเนาแบบเจาะลึกขององค์ประกอบปัจจุบันที่แยกออกมา |
getAltDescription() | String | แสดงคำอธิบายสำรองของรูปภาพ |
getAltTitle() | String | แสดงชื่อสำรองของรูปภาพ |
getAs(contentType) | Blob | แสดงผลข้อมูลภายในออบเจ็กต์นี้เป็น Blob ที่แปลงเป็นประเภทเนื้อหาที่ระบุ |
getAttributes() | Object | เรียกแอตทริบิวต์ขององค์ประกอบ |
getBlob() | Blob | แสดงผลข้อมูลภายในออบเจ็กต์นี้เป็น Blob |
getHeight() | Integer | ดึงความสูงของรูปภาพเป็นพิกเซล |
getLinkUrl() | String | เรียก URL ของลิงก์ |
getNextSibling() | Element | เรียกองค์ประกอบข้างเคียงถัดไปขององค์ประกอบ |
getParent() | ContainerElement | เรียกองค์ประกอบระดับบนขององค์ประกอบ |
getPreviousSibling() | Element | เรียกองค์ประกอบข้างเคียงก่อนหน้าขององค์ประกอบ |
getType() | ElementType | ดึงข้อมูล ElementType ขององค์ประกอบ |
getWidth() | Integer | ดึงความกว้างของภาพเป็นพิกเซล |
isAtDocumentEnd() | Boolean | ระบุว่าองค์ประกอบอยู่ที่ส่วนท้ายของ Document หรือไม่ |
merge() | InlineImage | ผสานรวมองค์ประกอบกับข้างเคียงที่อยู่ก่อนหน้าซึ่งเป็นประเภทเดียวกัน |
removeFromParent() | InlineImage | นำองค์ประกอบออกจากระดับบนสุด |
setAltDescription(description) | InlineImage | ตั้งค่าคำอธิบายอื่นของรูปภาพ |
setAltTitle(title) | InlineImage | ตั้งชื่ออื่นของรูปภาพ |
setAttributes(attributes) | InlineImage | ตั้งค่าแอตทริบิวต์ขององค์ประกอบ |
setHeight(height) | InlineImage | กำหนดความสูงของรูปภาพเป็นพิกเซล |
setLinkUrl(url) | InlineImage | ตั้งค่า URL ของลิงก์ |
setWidth(width) | InlineImage | กำหนดความกว้างของรูปภาพเป็นพิกเซล |
เอกสารประกอบโดยละเอียด
copy()
แสดงผลสำเนาแบบเจาะลึกขององค์ประกอบปัจจุบันที่แยกออกมา
ระบบจะคัดลอกองค์ประกอบย่อยที่มีอยู่ในองค์ประกอบนั้นด้วย องค์ประกอบใหม่ไม่มี ระดับบนสุด
รีเทิร์น
InlineImage
— สำเนาใหม่
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltDescription()
แสดงคำอธิบายสำรองของรูปภาพ
รีเทิร์น
String
— ชื่อสำรองหรือ null
หากองค์ประกอบไม่มีชื่ออื่น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltTitle()
แสดงชื่อสำรองของรูปภาพ
รีเทิร์น
String
— ชื่อสำรองหรือ null
หากองค์ประกอบไม่มีชื่ออื่น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
แสดงผลข้อมูลภายในออบเจ็กต์นี้เป็น Blob ที่แปลงเป็นประเภทเนื้อหาที่ระบุ วิธีนี้จะเพิ่มส่วนขยายที่เหมาะสมลงในชื่อไฟล์ เช่น "myfile.pdf" อย่างไรก็ตาม สมมติว่าส่วนของชื่อไฟล์ที่อยู่หลังเครื่องหมายจุดสุดท้าย (ถ้ามี) เป็นส่วนขยายที่มีอยู่แล้วซึ่งควรแทนที่ ดังนั้น "ShoppingList.12.25.2014" จะกลายเป็น "ShoppingList.12.25.pdf"
ดูโควต้ารายวันสำหรับ Conversion ได้ที่โควต้าสำหรับบริการของ Google โดเมน Google Workspace ที่สร้างใหม่อาจอยู่ภายใต้โควต้าที่เข้มงวดเป็นการชั่วคราว
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
contentType | String | ประเภท MIME ที่จะแปลงเป็น สำหรับ Blob ส่วนใหญ่ 'application/pdf' เป็นตัวเลือกเดียวที่ใช้ได้ สำหรับรูปภาพในรูปแบบ BMP, GIF, JPEG หรือ PNG คุณสามารถใช้ 'image/bmp' , 'image/gif' , 'image/jpeg' หรือ 'image/png' ได้เช่นกัน |
รีเทิร์น
Blob
— ข้อมูลในรูปแบบ BLOB
getAttributes()
เรียกแอตทริบิวต์ขององค์ประกอบ
ผลลัพธ์คือออบเจ็กต์ที่มีพร็อพเพอร์ตี้สำหรับแอตทริบิวต์ขององค์ประกอบที่ถูกต้องแต่ละรายการ โดยที่ชื่อพร็อพเพอร์ตี้แต่ละรายการสอดคล้องกับรายการในการแจงนับ 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]); }
รีเทิร์น
Object
— แอตทริบิวต์ขององค์ประกอบ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBlob()
getHeight()
ดึงความสูงของรูปภาพเป็นพิกเซล
รีเทิร์น
Integer
— ความสูงของรูปภาพเป็นพิกเซล
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
เรียก URL ของลิงก์
รีเทิร์น
String
— URL ของลิงก์ หรือ null
หากองค์ประกอบมีค่าหลายค่าสำหรับแอตทริบิวต์นี้
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
เรียกองค์ประกอบข้างเคียงถัดไปขององค์ประกอบ
องค์ประกอบข้างเคียงถัดไปมีระดับบนสุดเดียวกันและอยู่หลังองค์ประกอบปัจจุบัน
รีเทิร์น
Element
— องค์ประกอบข้างเคียงถัดไป
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
เรียกองค์ประกอบระดับบนขององค์ประกอบ
องค์ประกอบระดับบนประกอบด้วยองค์ประกอบปัจจุบัน
รีเทิร์น
ContainerElement
— องค์ประกอบระดับบน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
เรียกองค์ประกอบข้างเคียงก่อนหน้าขององค์ประกอบ
องค์ประกอบข้างเคียงก่อนหน้ามีระดับบนสุดเดียวกันและอยู่ก่อนองค์ประกอบปัจจุบัน
รีเทิร์น
Element
— องค์ประกอบข้างเคียงก่อนหน้า
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
ดึงข้อมูล ElementType
ขององค์ประกอบ
ใช้ getType()
เพื่อระบุประเภทองค์ประกอบที่เฉพาะเจาะจง
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.'); }
รีเทิร์น
ElementType
— ประเภทองค์ประกอบ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getWidth()
ดึงความกว้างของภาพเป็นพิกเซล
รีเทิร์น
Integer
— ความกว้างของรูปภาพเป็นพิกเซล
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
merge()
ผสานรวมองค์ประกอบกับข้างเคียงที่อยู่ก่อนหน้าซึ่งเป็นประเภทเดียวกัน
รวมได้เฉพาะองค์ประกอบของ ElementType
เดียวกัน องค์ประกอบย่อยที่อยู่ในองค์ประกอบปัจจุบันจะย้ายไปยังองค์ประกอบระดับข้างเคียงที่อยู่ก่อนหน้า
องค์ประกอบปัจจุบันจะถูกนำออกจากเอกสาร
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();
รีเทิร์น
InlineImage
— องค์ประกอบที่รวมกัน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
นำองค์ประกอบออกจากระดับบนสุด
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(); }
รีเทิร์น
InlineImage
— องค์ประกอบที่นำออก
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltDescription(description)
ตั้งค่าคำอธิบายอื่นของรูปภาพ หากชื่อที่ระบุคือ null
ให้ตั้งค่าคำอธิบายเป็นสตริงว่างเปล่า
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
description | String | ชื่ออื่น |
รีเทิร์น
InlineImage
— ออบเจ็กต์ปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltTitle(title)
ตั้งชื่ออื่นของรูปภาพ หากชื่อที่ระบุคือ null
ให้ตั้งชื่อเป็นสตริงว่างเปล่า
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
title | String | ชื่ออื่น |
รีเทิร์น
InlineImage
— ออบเจ็กต์ปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
ตั้งค่าแอตทริบิวต์ขององค์ประกอบ
พารามิเตอร์แอตทริบิวต์ที่ระบุต้องเป็นออบเจ็กต์ที่ชื่อพร็อพเพอร์ตี้แต่ละชื่อเป็นรายการในการแจงนับ DocumentApp.Attribute
และค่าพร็อพเพอร์ตี้แต่ละค่าคือค่าใหม่ที่จะใช้
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);
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
attributes | Object | แอตทริบิวต์ขององค์ประกอบ |
รีเทิร์น
InlineImage
— องค์ประกอบปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeight(height)
กำหนดความสูงของรูปภาพเป็นพิกเซล
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
height | Integer | ความสูงของรูปภาพเป็นพิกเซล |
รีเทิร์น
InlineImage
— ออบเจ็กต์ปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
ตั้งค่า URL ของลิงก์ หาก URL ที่ระบุคือ null
หรือสตริงว่าง วิธีนี้จะสร้างลิงก์ที่มี URL ว่างเปล่าซึ่งอาจแสดงเป็น "ลิงก์ไม่ถูกต้อง" ใน Google เอกสาร
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
url | String | URL ของลิงก์ |
รีเทิร์น
InlineImage
— ออบเจ็กต์ปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setWidth(width)
กำหนดความกว้างของรูปภาพเป็นพิกเซล
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
width | Integer | ความกว้างของรูปภาพเป็นพิกเซล |
รีเทิร์น
InlineImage
— ออบเจ็กต์ปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents