Class Equation

משוואה

רכיב שמייצג ביטוי מתמטי. Equation יכול להכיל את הרכיבים EquationFunction, EquationSymbol ו-Text. מידע נוסף על למבנה המסמך, ניתן לעיין במדריך הרחבה של Google Docs.

שיטות

שיטהסוג הערך המוחזרתיאור קצר
clear()Equationניקוי התוכן של הרכיב.
copy()Equationהפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי.
editAsText()Textמתקבלת גרסת Text של הרכיב הנוכחי, לעריכה.
findElement(elementType)RangeElementחיפוש תוכן הרכיב כדי למצוא צאצא מהסוג שצוין.
findElement(elementType, from)RangeElementמחפש את תוכן הרכיב כדי למצוא צאצא מהסוג שצוין, החל מ- ציינת RangeElement.
findText(searchPattern)RangeElementחיפוש תוכן הרכיב לפי דפוס הטקסט שצוין באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElementחיפוש תוכן הרכיב לפי תבנית הטקסט שצוינה, החל ממאפיין נתון בתוצאות החיפוש.
getAttributes()Objectאחזור המאפיינים של הרכיב.
getChild(childIndex)Elementאחזור הרכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerאחזור של אינדקס הצאצא לרכיב הצאצא שצוין.
getLinkUrl()Stringאחזור כתובת ה-URL של הקישור.
getNextSibling()Elementאחזור של רכיב האח הבא של הרכיב.
getNumChildren()Integerאחזור של מספר הילדים.
getParent()ContainerElementאחזור הרכיב ההורה של הרכיב.
getPreviousSibling()Elementאחזור של רכיב האח הקודם של הרכיב.
getText()Stringאחזור תוכן הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignmentמקבל את היישור של הטקסט.
getType()ElementTypeמאחזר את ElementType של הרכיב.
isAtDocumentEnd()Booleanהפונקציה קובעת אם הרכיב נמצא בסוף Document.
merge()Equationהתכונה ממזגת את הרכיב עם האח הקודם מאותו סוג.
removeFromParent()Equationהסרת הרכיב מרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementמחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת החלפה נתונה, באמצעות הפונקציה הרגילה הבעות פנים.
setAttributes(attributes)Equationמגדיר את המאפיינים של הרכיב.
setLinkUrl(url)Equationמגדיר את כתובת האתר של הקישור.
setTextAlignment(textAlignment)Equationמגדיר את יישור הטקסט.

מסמכי תיעוד מפורטים

clear()

ניקוי התוכן של הרכיב.

חזרה

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


copy()

הפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי.

כל רכיבי הצאצא שקיימים ברכיב מועתקים גם כן. ברכיב החדש אין הורה.

חזרה

Equation – העותק החדש.

אישור

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

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

editAsText()

מתקבלת גרסת Text של הרכיב הנוכחי, לעריכה.

אפשר להשתמש ב-editAsText כדי לבצע מניפולציות על התוכן של הרכיבים כטקסט עשיר. מצב editAsText מתעלם מאלמנטים שאינם טקסט (כמו InlineImage ו-HorizontalRule).

רכיבי צאצא הכלולים בטווח טקסט שנמחק יוסרו מהרכיב.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

חזרה

Text – גרסת טקסט של הרכיב הנוכחי


findElement(elementType)

חיפוש תוכן הרכיב כדי למצוא צאצא מהסוג שצוין.

פרמטרים

שםסוגתיאור
elementTypeElementTypeסוג הרכיב שצריך לחפש.

חזרה

RangeElement - תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.

אישור

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

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

findElement(elementType, from)

מחפש את תוכן הרכיב כדי למצוא צאצא מהסוג שצוין, החל מ- ציינת RangeElement.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

פרמטרים

שםסוגתיאור
elementTypeElementTypeסוג הרכיב שצריך לחפש.
fromRangeElementתוצאת החיפוש שממנה יש לחפש.

חזרה

RangeElement - תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש.

אישור

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

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

findText(searchPattern)

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

אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כגון לתעד קבוצות ותנאים.

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

פרמטרים

שםסוגתיאור
searchPatternStringהדפוס שצריך לחפש

חזרה

RangeElement - תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או ערך null אם אין להתאים

אישור

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

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

findText(searchPattern, from)

חיפוש תוכן הרכיב לפי תבנית הטקסט שצוינה, החל ממאפיין נתון בתוצאות החיפוש.

אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כגון לתעד קבוצות ותנאים.

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

פרמטרים

שםסוגתיאור
searchPatternStringהדפוס שצריך לחפש
fromRangeElementתוצאת החיפוש שממנה יש לחפש

חזרה

RangeElement - תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או ערך null אם אין להתאים

אישור

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

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

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

getChild(childIndex)

אחזור הרכיב הצאצא באינדקס הצאצא שצוין.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס של רכיב הצאצא לאחזור.

חזרה

Element – רכיב הצאצא באינדקס שצוין.

אישור

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

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

getChildIndex(child)

אחזור של אינדקס הצאצא לרכיב הצאצא שצוין.

פרמטרים

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

חזרה

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

getNumChildren()

אחזור של מספר הילדים.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log("There are " + body.getNumChildren() +
    " elements in the tab's body.");

חזרה

Integer – מספר הילדים.

אישור

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

  • 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

getText()

אחזור תוכן הרכיב כמחרוזת טקסט.

חזרה

String – תוכן הרכיב כמחרוזת טקסט

אישור

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

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

getTextAlignment()

מקבל את היישור של הטקסט. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT ו-DocumentApp.TextAlignment.SUPERSCRIPT.

חזרה

TextAlignment - סוג היישור של הטקסט, או null אם הטקסט מכיל כמה סוגים של טקסט יישור או אם יישור הטקסט מעולם לא הוגדר

אישור

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

  • 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

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

חזרה

Equation – הרכיב שמוזג.

אישור

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

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

חזרה

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

אישור

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

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

replaceText(searchPattern, replacement)

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

דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט של ביטוי רגולרי של JavaScript. לכן, צריך לסמן בתו בריחה (escape) את כל לוכסן הפוך בתבנית.

בשיטה הזאת נעשה שימוש במודל RE2 הרגיל של Google של ביטויים, שמגבילה את התחביר הנתמך.

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

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

פרמטרים

שםסוגתיאור
searchPatternStringדפוס הביטוי הרגולרי שצריך לחפש
replacementStringהטקסט שישמש כתחליף

חזרה

Element – הרכיב הנוכחי

אישור

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

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

פרמטרים

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

חזרה

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

אישור

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

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

setLinkUrl(url)

מגדיר את כתובת האתר של הקישור.

פרמטרים

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

חזרה

Equation – הרכיב הנוכחי

אישור

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

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

setTextAlignment(textAlignment)

מגדיר את יישור הטקסט. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT ו-DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

פרמטרים

שםסוגתיאור
textAlignmentTextAlignmentסוג היישור של הטקסט שרוצים להחיל

חזרה

Equation – הרכיב הנוכחי

אישור

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

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