Class InlineImage

InlineImage

องค์ประกอบที่แสดงถึงรูปภาพที่ฝัง 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 ที่สร้างใหม่อาจมีข้อกำหนดที่เข้มงวดขึ้นชั่วคราว โควต้า

พารามิเตอร์

ชื่อประเภทคำอธิบาย
contentTypeStringประเภท MIME ที่จะแปลง สำหรับ BLOB ส่วนใหญ่ 'application/pdf' คือ เป็นตัวเลือกเดียวที่ใช้ได้ สำหรับรูปภาพในรูปแบบ BMP, GIF, JPEG หรือ PNG ระบบจะใช้ 'image/bmp', 'image/gif', 'image/jpeg' หรือ 'image/png' ด้วย ใช้ได้ ใช้ 'text/markdown' สำหรับเอกสารของ Google เอกสารได้ด้วย

รีเทิร์น

Blob — ข้อมูลในรูปแบบ BLOB


getAttributes()

ดึงแอตทริบิวต์ขององค์ประกอบ

ผลลัพธ์คือออบเจ็กต์ที่มีพร็อพเพอร์ตี้สำหรับแอตทริบิวต์ขององค์ประกอบที่ถูกต้องแต่ละรายการ โดยที่แต่ละรายการ ชื่อพร็อพเพอร์ตี้สอดคล้องกับรายการในการแจกแจง DocumentApp.Attribute

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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()

แสดงข้อมูลภายในออบเจ็กต์นี้เป็น BLOB

รีเทิร์น

Blob — ข้อมูลในรูปแบบ BLOB


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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's 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()

กำหนดว่าองค์ประกอบอยู่ที่ส่วนท้ายของ Document หรือไม่

รีเทิร์น

Boolean — องค์ประกอบอยู่ที่ส่วนท้ายของแท็บหรือไม่

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

merge()

ผสานองค์ประกอบกับรายการข้างเคียงที่อยู่ก่อนหน้าประเภทเดียวกัน

รวมได้เฉพาะองค์ประกอบของ ElementType เดียวกันเท่านั้น องค์ประกอบย่อยใดๆ ที่มีอยู่ใน ระบบจะย้ายองค์ประกอบปัจจุบันไปยังองค์ประกอบระดับเดียวกันที่อยู่ก่อนหน้า

องค์ประกอบปัจจุบันจะถูกนำออกจากเอกสาร

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

// Remove all images in the active tab's 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 ให้ตั้งค่า เป็นสตริงว่างเปล่า

พารามิเตอร์

ชื่อประเภทคำอธิบาย
descriptionStringชื่ออื่น

รีเทิร์น

InlineImage — ออบเจ็กต์ปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setAltTitle(title)

ตั้งชื่ออื่นของรูปภาพ หากชื่อที่ระบุคือ null ให้กำหนดชื่อเป็น สตริงว่าง

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่ออื่น

รีเทิร์น

InlineImage — ออบเจ็กต์ปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setAttributes(attributes)

ตั้งค่าแอตทริบิวต์ขององค์ประกอบ

พารามิเตอร์แอตทริบิวต์ที่ระบุต้องเป็นออบเจ็กต์ที่ชื่อพร็อพเพอร์ตี้แต่ละชื่อเป็นรายการใน การแจงนับ DocumentApp.Attribute และค่าพร็อพเพอร์ตี้แต่ละค่าคือค่าใหม่ ใช้แล้ว

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
attributesObjectแอตทริบิวต์ขององค์ประกอบ

รีเทิร์น

InlineImage — องค์ประกอบปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setHeight(height)

ตั้งค่าความสูงของรูปภาพเป็นพิกเซล

พารามิเตอร์

ชื่อประเภทคำอธิบาย
heightIntegerความสูงของรูปภาพเป็นพิกเซล

รีเทิร์น

InlineImage — ออบเจ็กต์ปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setLinkUrl(url)

ตั้งค่า URL ของลิงก์ หาก URL ที่ระบุคือ null หรือสตริงว่าง วิธีนี้จะสร้าง ลิงก์ที่มี URL ว่างเปล่าซึ่งอาจแสดงเป็น "ลิงก์ไม่ถูกต้อง" ใน Google เอกสาร

พารามิเตอร์

ชื่อประเภทคำอธิบาย
urlStringURL ของลิงก์

รีเทิร์น

InlineImage — ออบเจ็กต์ปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

setWidth(width)

ตั้งค่าความกว้างของรูปภาพเป็นพิกเซล

พารามิเตอร์

ชื่อประเภทคำอธิบาย
widthIntegerความกว้างของภาพเป็นพิกเซล

รีเทิร์น

InlineImage — ออบเจ็กต์ปัจจุบัน

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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