רכיב שמייצג ציור מוטמע. אפשר להשתמש ב-Inline בתוך List או Paragraph, אלא אם List או Paragraph נמצאים בתוך Footnote. רכיב Inline לא יכול להכיל רכיב אחר. למידע נוסף על מבנה המסמך, אפשר לעיין במדריך להרחבת Google Docs.
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
copy() | Inline | מחזירה עותק מנותק ועמוק של הרכיב הנוכחי. |
get | String | מחזירה את התיאור החלופי של הציור. |
get | String | מחזירה את הכותרת החלופית של הציור. |
get | Object | מאחזר את המאפיינים של האלמנט. |
get | Element | מאחזר את רכיב האח הבא של הרכיב. |
get | Container | מאחזר את רכיב ההורה של הרכיב. |
get | Element | אחזור של רכיב אחים קודם של הרכיב. |
get | Element | אחזור Element של הרכיב. |
is | Boolean | ההגדרה הזו קובעת אם הרכיב נמצא בסוף Document. |
merge() | Inline | מיזוג הרכיב עם הרכיב הקודם מאותו סוג. |
remove | Inline | הפונקציה מסירה את הרכיב מהרכיב ברמה העליונה. |
set | Inline | מגדיר את התיאור החלופי של הציור. |
set | Inline | מגדיר את הכותרת החלופית של הציור. |
set | Inline | הגדרת המאפיינים של האלמנט. |
תיעוד מפורט
copy()
מחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
כל רכיבי הצאצא שקיימים ברכיב מועתקים גם הם. לאלמנט החדש אין אלמנט אב.
חזרה
Inline — העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Alt Description()
מחזירה את התיאור החלופי של הציור.
חזרה
String – התיאור החלופי, או null אם לרכיב אין תיאור חלופי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Alt Title()
מחזירה את הכותרת החלופית של הציור.
חזרה
String – הכותרת החלופית, או null אם לרכיב אין כותרת חלופית.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Attributes()
מאחזר את המאפיינים של האלמנט.
התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין של רכיב תקין, כאשר כל שם מאפיין תואם לפריט בספירה Document.
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
get Next Sibling()
מאחזר את רכיב האח הבא של הרכיב.
האח הבא באותה רמה הוא רכיב שיש לו את אותו רכיב אב והוא מופיע אחרי הרכיב הנוכחי.
חזרה
Element — רכיב האחים הבא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Parent()
מאחזר את רכיב ההורה של הרכיב.
רכיב ההורה מכיל את הרכיב הנוכחי.
חזרה
Container – רכיב ההורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Previous Sibling()
אחזור של רכיב אחים קודם של הרכיב.
האח או האחות הקודמים הם בעלי אותו הורה ומקדימים את הרכיב הנוכחי.
חזרה
Element — הרכיב הקודם באותה רמה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Type()
אחזור Element של הרכיב.
משתמשים ב-get כדי לקבוע את הסוג המדויק של רכיב נתון.
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.'); }
חזרה
Element – סוג הרכיב.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
is At Document End()
merge()
מיזוג הרכיב עם הרכיב הקודם מאותו סוג.
אפשר למזג רק רכיבים מאותו Element. כל רכיבי הצאצא שנכללים ברכיב הנוכחי מועברים לרכיב האח הקודם.
האלמנט הנוכחי יוסר מהמסמך.
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();
חזרה
Inline – האלמנט הממוזג.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove From Parent()
הפונקציה מסירה את הרכיב מהרכיב ברמה העליונה.
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(); }
חזרה
Inline — הרכיב שהוסר.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Alt Description(description)
מגדיר את התיאור החלופי של הציור. אם התיאור שצוין הוא null, התיאור מוגדר כמחרוזת ריקה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
description | String | התיאור החלופי. |
חזרה
Inline — האובייקט הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Alt Title(title)
מגדיר את הכותרת החלופית של הציור. אם השם שצוין הוא null, השם מוגדר כמחרוזת ריקה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
title | String | הכותרת החלופית. |
חזרה
Inline — האובייקט הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Attributes(attributes)
הגדרת המאפיינים של האלמנט.
פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה Document וכל ערך מאפיין הוא הערך החדש שיוחל.
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 | המאפיינים של האלמנט. |
חזרה
Inline – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents