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

Class InlineImage

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

שיטות

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

החזרות

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 - מאפייני הרכיב.

הרשאות

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

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() כדי לקבוע את הסוג המדויק של רכיב נתון.

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 - סוג הרכיב.

הרשאות

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

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. כל רכיבי הצאצא שנכללים ברכיב הנוכחי מועברים אל הרכיב האח הקודם.

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

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 - הרכיב שמוזג.

הרשאות

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

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 - הרכיב שהוסר.

הרשאות

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

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 וכל ערך של מאפיין הוא הערך החדש שיש להחיל.

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

פרמטרים

שם	תיאור	התיאור
`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 היא null או שהמחרוזת ריקה, השיטה הזו תיצור קישור עם כתובת URL ריקה שעלולה להופיע כ'קישור לא חוקי' ב-Google Docs.

פרמטרים

שם	תיאור	התיאור
`url`	`String`	כתובת האתר של הקישור

החזרות

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