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 יהיו כפופים באופן זמני למכסות מחמירות יותר.

פרמטרים

שםסוגתיאור
contentTypeStringסוג ה-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, התיאור מוגדר כמחרוזת ריקה.

פרמטרים

שםסוגתיאור
descriptionStringהתיאור החלופי.

חזרה

‫InlineImage — האובייקט הנוכחי.

אישור

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

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

setAltTitle(title)

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

פרמטרים

שםסוגתיאור
titleStringהכותרת החלופית.

חזרה

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

פרמטרים

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

חזרה

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

אישור

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

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

setHeight(height)

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

פרמטרים

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

חזרה

‫InlineImage — האובייקט הנוכחי

אישור

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

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

setLinkUrl(url)

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

פרמטרים

שםסוגתיאור
urlStringכתובת ה-URL של הקישור.

חזרה

‫InlineImage — האובייקט הנוכחי.

אישור

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

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

setWidth(width)

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

פרמטרים

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

חזרה

‫InlineImage — האובייקט הנוכחי

אישור

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

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