דף זה תורגם על ידי Cloud Translation API.

Class InlineImage

רכיב שמייצג תמונה מוטמעת. אפשר לכלול InlineImage ב-ListItem או ב-Paragraph, אלא אם ה-ListItem או ה-Paragraph נמצאים ב-FootnoteSection. רכיב InlineImage לא יכול להכיל רכיב אחר כלשהו. למידע נוסף על מבנה המסמך, קראו את המדריך להרחבת Google Docs.

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
`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 – העותק החדש.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`getAltDescription()`

הפונקציה מחזירה את התיאור החלופי של התמונה.

חזרה

String – הכותרת החלופית, או null אם לרכיב אין כותרת חלופית

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`getAltTitle()`

הפונקציה מחזירה את הכותרת החלופית של התמונה.

חזרה

String – הכותרת החלופית, או null אם לרכיב אין כותרת חלופית

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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.

כדי לראות את המכסות היומיות להמרות, אפשר לעיין במאמר מכסות לשירותי Google. יכול להיות שדומיינים חדשים של Google Workspace יהיו כפופים באופן זמני למכסות מחמירות יותר.

פרמטרים

שם	סוג	תיאור
`contentType`	`String`	סוג ה-MIME שאליו רוצים להמיר. ברוב ה-blobs, `'application/pdf'` היא האפשרות היחידה התקפה. בתמונות בפורמט BMP,‏ GIF,‏ JPEG או PNG, אפשר להשתמש גם ב-`'image/bmp'`,‏ `'image/gif'`,‏ `'image/jpeg'` או `'image/png'`. במסמך ב-Google Docs, גם הערך `'text/markdown'` תקף.

חזרה

Blob – הנתונים כ-blob.

`getAttributes()`

אחזור המאפיינים של האלמנט.

התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין רכיב תקין, כאשר כל שם מאפיין תואם לפריט בספירה 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]}`);
}

חזרה

Object – המאפיינים של האלמנט.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`getBlob()`

החזרת הנתונים שבתוך האובייקט הזה כ-blob.

חזרה

Blob – הנתונים כ-blob.

`getHeight()`

אחזור הגובה של התמונה, בפיקסלים.

חזרה

Integer – הגובה של התמונה, בפיקסלים

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`getLinkUrl()`

אחזור כתובת ה-URL של הקישור.

חזרה

String – כתובת ה-URL של הקישור, או null אם הרכיב מכיל כמה ערכים למאפיין הזה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`getNextSibling()`

אחזור הרכיב הבא של הרכיב.

לרכיב האח הבא יש אותו הורה והוא מופיע אחרי הרכיב הנוכחי.

חזרה

Element – רכיב האח הבא.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`getParent()`

אחזור של רכיב ההורה של האלמנט.

רכיב ההורה מכיל את הרכיב הנוכחי.

חזרה

ContainerElement – רכיב ההורה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`getPreviousSibling()`

אחזור של רכיב האח הקודם של הרכיב.

לרכיב האח הקודם יש אותו הורה והוא מופיע לפני הרכיב הנוכחי.

חזרה

Element — רכיב האח/ה הקודם.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`getType()`

אחזור הערך של ElementType ברכיב.

אפשר להשתמש ב-getType() כדי לקבוע את הסוג המדויק של רכיב נתון.

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

חזרה

ElementType – סוג הרכיב.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`getWidth()`

אחזור רוחב התמונה, בפיקסלים.

חזרה

Integer – רוחב התמונה, בפיקסלים

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`isAtDocumentEnd()`

הפונקציה קובעת אם הרכיב נמצא בסוף ה-Document.

חזרה

Boolean — אם הרכיב נמצא בסוף הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`merge()`

מיזוג הרכיב עם האח/ה הקודם/ה מאותו סוג.

אפשר למזג רק רכיבים מאותו ElementType. כל רכיבי הצאצאים שמכיל הרכיב הנוכחי מועברים לרכיב האח הקודם.

הרכיב הנוכחי יוסר מהמסמך.

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

חזרה

InlineImage – הרכיב הממוזג.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`removeFromParent()`

הסרת הרכיב מהרכיב ההורה שלו.

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

חזרה

InlineImage – הרכיב שהוסרה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`setAltDescription(description)`

הגדרת התיאור החלופי של התמונה. אם השם שצוין הוא null, התיאור מוגדר למחרוזת הריקה.

פרמטרים

שם	סוג	תיאור
`description`	`String`	הכותרת החלופית

חזרה

InlineImage – האובייקט הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`setAltTitle(title)`

הגדרת הכותרת החלופית של התמונה. אם השם שצוין הוא null, המערכת מגדירה את השם למחרוזת הריקה.

פרמטרים

שם	סוג	תיאור
`title`	`String`	הכותרת החלופית

חזרה

InlineImage – האובייקט הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`setAttributes(attributes)`

הגדרת המאפיינים של האלמנט.

פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה של DocumentApp.Attribute וכל ערך מאפיין הוא הערך החדש שרוצים להחיל.

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

פרמטרים

שם	סוג	תיאור
`attributes`	`Object`	המאפיינים של האלמנט.

חזרה

InlineImage – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`setHeight(height)`

הגדרת הגובה של התמונה, בפיקסלים.

פרמטרים

שם	סוג	תיאור
`height`	`Integer`	הגובה של התמונה, בפיקסלים

חזרה

InlineImage – האובייקט הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`setLinkUrl(url)`

הגדרת כתובת ה-URL של הקישור. אם כתובת ה-URL שצוינה היא null או מחרוזת ריקה, השיטה הזו תיצור קישור עם כתובת URL ריקה שעשויה להופיע כ'קישור לא תקין' ב-Google Docs.

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL של הקישור

חזרה

InlineImage – האובייקט הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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

`setWidth(width)`

הגדרת רוחב התמונה, בפיקסלים.

פרמטרים

שם	סוג	תיאור
`width`	`Integer`	רוחב התמונה, בפיקסלים

חזרה

InlineImage – האובייקט הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:

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