Class InlineImage

InlineImage

Một phần tử đại diện cho hình ảnh được nhúng. InlineImage có thể nằm trong ListItem hoặc Paragraph, trừ phi ListItem hoặc Paragraph nằm trong FootnoteSection. InlineImage không thể tự chứa bất kỳ phần tử nào khác. Để biết thêm thông tin về cấu trúc tài liệu, hãy xem hướng dẫn mở rộng Google Tài liệu.

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
copy()InlineImageTrả về một bản sao sâu, tách biệt của phần tử hiện tại.
getAltDescription()StringTrả về nội dung mô tả thay thế của hình ảnh.
getAltTitle()StringTrả về tiêu đề thay thế của hình ảnh.
getAs(contentType)BlobTrả về dữ liệu bên trong đối tượng này dưới dạng một blob được chuyển đổi thành loại nội dung đã chỉ định.
getAttributes()ObjectTruy xuất các thuộc tính của phần tử.
getBlob()BlobTrả về dữ liệu bên trong đối tượng này dưới dạng blob.
getHeight()IntegerTruy xuất chiều cao của hình ảnh, tính bằng pixel.
getLinkUrl()StringTruy xuất URL của đường liên kết.
getNextSibling()ElementTruy xuất phần tử đồng cấp tiếp theo của phần tử.
getParent()ContainerElementTruy xuất phần tử mẹ của phần tử.
getPreviousSibling()ElementTruy xuất phần tử đồng cấp trước đó của phần tử.
getType()ElementTypeTruy xuất ElementType của phần tử.
getWidth()IntegerTruy xuất chiều rộng của hình ảnh, tính bằng pixel.
isAtDocumentEnd()BooleanXác định xem phần tử có ở cuối Document hay không.
merge()InlineImageHợp nhất phần tử với phần tử đồng cấp trước đó có cùng loại.
removeFromParent()InlineImageXoá phần tử khỏi phần tử mẹ.
setAltDescription(description)InlineImageĐặt nội dung mô tả thay thế của hình ảnh.
setAltTitle(title)InlineImageĐặt tiêu đề thay thế của hình ảnh.
setAttributes(attributes)InlineImageĐặt thuộc tính của phần tử.
setHeight(height)InlineImageĐặt chiều cao của hình ảnh, tính bằng pixel.
setLinkUrl(url)InlineImageĐặt URL của đường liên kết.
setWidth(width)InlineImageĐặt chiều rộng của hình ảnh, tính bằng pixel.

Tài liệu chi tiết

copy()

Trả về một bản sao sâu, tách biệt của phần tử hiện tại.

Mọi phần tử con có trong phần tử cũng được sao chép. Phần tử mới không có phần tử mẹ.

Cầu thủ trả bóng

InlineImage – Bản sao mới.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getAltDescription()

Trả về nội dung mô tả thay thế của hình ảnh.

Cầu thủ trả bóng

String – tiêu đề thay thế hoặc null nếu phần tử không có tiêu đề thay thế

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getAltTitle()

Trả về tiêu đề thay thế của hình ảnh.

Cầu thủ trả bóng

String – tiêu đề thay thế hoặc null nếu phần tử không có tiêu đề thay thế

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getAs(contentType)

Trả về dữ liệu bên trong đối tượng này dưới dạng một blob được chuyển đổi thành loại nội dung đã chỉ định. Phương thức này thêm đuôi tệp thích hợp vào tên tệp, ví dụ: "myfile.pdf". Tuy nhiên, hàm này giả định rằng phần tên tệp theo sau dấu chấm cuối cùng (nếu có) là một đuôi tệp hiện có cần được thay thế. Do đó, "ShoppingList.12.25.2014" sẽ trở thành "ShoppingList.12.25.pdf".

Để xem hạn mức hằng ngày cho lượt chuyển đổi, hãy xem bài viết Hạn mức cho Dịch vụ của Google. Các miền Google Workspace mới tạo có thể tạm thời phải tuân theo hạn mức nghiêm ngặt hơn.

Tham số

TênLoạiMô tả
contentTypeStringLoại MIME cần chuyển đổi sang. Đối với hầu hết các blob, 'application/pdf' là tuỳ chọn hợp lệ duy nhất. Đối với hình ảnh ở định dạng BMP, GIF, JPEG hoặc PNG, bất kỳ 'image/bmp', 'image/gif', 'image/jpeg' hoặc 'image/png' nào cũng đều hợp lệ. Đối với tài liệu Google Tài liệu, 'text/markdown' cũng hợp lệ.

Cầu thủ trả bóng

Blob – Dữ liệu dưới dạng blob.

getAttributes()

Truy xuất các thuộc tính của phần tử.

Kết quả là một đối tượng chứa một thuộc tính cho mỗi thuộc tính phần tử hợp lệ, trong đó mỗi tên thuộc tính tương ứng với một mục trong enum 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]}`);
}

Cầu thủ trả bóng

Object – Các thuộc tính của phần tử.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getBlob()

Trả về dữ liệu bên trong đối tượng này dưới dạng blob.

Cầu thủ trả bóng

Blob – Dữ liệu dưới dạng blob.

getHeight()

Truy xuất chiều cao của hình ảnh, tính bằng pixel.

Cầu thủ trả bóng

Integer – chiều cao của hình ảnh, tính bằng pixel

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getLinkUrl()

Truy xuất URL của đường liên kết.

Cầu thủ trả bóng

String – URL của đường liên kết hoặc null nếu phần tử chứa nhiều giá trị cho thuộc tính này.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getNextSibling()

Truy xuất phần tử đồng cấp tiếp theo của phần tử.

Phần tử đồng cấp tiếp theo có cùng phần tử mẹ và theo sau phần tử hiện tại.

Cầu thủ trả bóng

Element – Phần tử đồng cấp tiếp theo.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getParent()

Truy xuất phần tử mẹ của phần tử.

Phần tử mẹ chứa phần tử hiện tại.

Cầu thủ trả bóng

ContainerElement – Phần tử mẹ.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getPreviousSibling()

Truy xuất phần tử đồng cấp trước đó của phần tử.

Phần tử đồng cấp trước đó có cùng phần tử mẹ và đứng trước phần tử hiện tại.

Cầu thủ trả bóng

Element – Phần tử đồng cấp trước đó.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getType()

Truy xuất ElementType của phần tử.

Sử dụng getType() để xác định chính xác loại của một phần tử nhất định. 

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.');
}

Cầu thủ trả bóng

ElementType – Loại phần tử.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

getWidth()

Truy xuất chiều rộng của hình ảnh, tính bằng pixel.

Cầu thủ trả bóng

Integer – chiều rộng của hình ảnh, tính bằng pixel

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

isAtDocumentEnd()

Xác định xem phần tử có ở cuối Document hay không.

Cầu thủ trả bóng

Boolean – Liệu phần tử có ở cuối thẻ hay không.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

merge()

Hợp nhất phần tử với phần tử đồng cấp trước đó có cùng loại.

Bạn chỉ có thể hợp nhất các phần tử của cùng một ElementType. Mọi phần tử con có trong phần tử hiện tại sẽ được chuyển sang phần tử đồng cấp trước đó.

Phần tử hiện tại sẽ bị xoá khỏi tài liệu. 

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();

Cầu thủ trả bóng

InlineImage – Phần tử được hợp nhất.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

removeFromParent()

Xoá phần tử khỏi phần tử mẹ. 

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();
}

Cầu thủ trả bóng

InlineImage – Phần tử đã xoá.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setAltDescription(description)

Đặt nội dung mô tả thay thế của hình ảnh. Nếu tiêu đề đã cho là null, hãy đặt nội dung mô tả thành chuỗi trống.

Tham số

TênLoạiMô tả
descriptionStringtiêu đề thay thế

Cầu thủ trả bóng

InlineImage – đối tượng hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setAltTitle(title)

Đặt tiêu đề thay thế của hình ảnh. Nếu tiêu đề đã cho là null, hãy đặt tiêu đề thành chuỗi trống.

Tham số

TênLoạiMô tả
titleStringtiêu đề thay thế

Cầu thủ trả bóng

InlineImage – đối tượng hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setAttributes(attributes)

Đặt thuộc tính của phần tử.

Tham số thuộc tính được chỉ định phải là một đối tượng, trong đó mỗi tên thuộc tính là một mục trong enumeration DocumentApp.Attribute và mỗi giá trị thuộc tính là giá trị mới sẽ được áp dụng. 

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);

Tham số

TênLoạiMô tả
attributesObjectThuộc tính của phần tử.

Cầu thủ trả bóng

InlineImage – Phần tử hiện tại.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setHeight(height)

Đặt chiều cao của hình ảnh, tính bằng pixel.

Tham số

TênLoạiMô tả
heightIntegerchiều cao của hình ảnh, tính bằng pixel

Cầu thủ trả bóng

InlineImage – đối tượng hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setLinkUrl(url)

Đặt URL của đường liên kết. Nếu URL đã cho là null hoặc một chuỗi trống, phương thức này sẽ tạo một đường liên kết có URL trống có thể hiển thị dưới dạng "Đường liên kết không hợp lệ" trong Google Tài liệu.

Tham số

TênLoạiMô tả
urlStringURL của đường liên kết

Cầu thủ trả bóng

InlineImage – đối tượng hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

setWidth(width)

Đặt chiều rộng của hình ảnh, tính bằng pixel.

Tham số

TênLoạiMô tả
widthIntegerchiều rộng của hình ảnh, tính bằng pixel

Cầu thủ trả bóng

InlineImage – đối tượng hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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