דף זה תורגם על ידי 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`	מגדיר את כתובת ה-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 שהומר לסוג התוכן שצוין. הזה method מוסיפה את הסיומת המתאימה לשם הקובץ, לדוגמה, "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.

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

אישור

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

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

אישור

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

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

אישור

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

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

אישור

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

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

פרמטרים

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