Class EquationFunction

تابع معادله

عنصری که یک تابع را در یک Equation ریاضی نشان می‌دهد. یک EquationFunction ممکن است شامل عناصر EquationFunction ، EquationFunctionArgumentSeparator ، EquationSymbol و Text باشد. برای اطلاعات بیشتر در مورد ساختار سند، به راهنمای توسعه Google Docs مراجعه کنید.

روش‌ها

روش نوع بازگشتی شرح مختصر
clear() Equation Function محتویات عنصر را پاک می‌کند.
copy() Equation Function یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.
edit As Text() Text یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می‌کند.
find Element(elementType) Range Element |null محتویات عنصر را برای یافتن نسلی از نوع مشخص شده جستجو می‌کند.
find Element(elementType, from) Range Element |null محتویات عنصر را برای یافتن نسلی از نوع مشخص شده، با شروع از Range Element مشخص شده، جستجو می‌کند.
find Text(searchPattern) Range Element |null با استفاده از عبارات منظم، محتوای عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.
find Text(searchPattern, from) Range Element |null با شروع از یک نتیجه جستجوی داده شده، محتویات عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.
get Attributes() Object ویژگی‌های عنصر را بازیابی می‌کند.
get Child(childIndex) Element عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.
get Child Index(child) Integer اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.
get Code() String کد مربوط به تابع معادله را بازیابی می‌کند.
get Link Url() String|null آدرس لینک را بازیابی می‌کند.
get Next Sibling() Element |null عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.
get Num Children() Integer تعداد فرزندان را بازیابی می‌کند.
get Parent() Container Element |null عنصر والد عنصر را بازیابی می‌کند.
get Previous Sibling() Element |null عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.
get Text() String محتوای عنصر را به صورت یک رشته متنی بازیابی می‌کند.
get Text Alignment() Text Alignment |null ترازبندی متن را دریافت می‌کند.
get Type() Element Type Element Type را بازیابی می‌کند.
is At Document End() Boolean تعیین می‌کند که آیا عنصر در انتهای Document قرار دارد یا خیر.
merge() Equation Function |null عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام می‌کند.
remove From Parent() Equation Function |null عنصر را از والدش حذف می‌کند.
replace Text(searchPattern, replacement) Element با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.
set Attributes(attributes) Equation Function ویژگی‌های عنصر را تنظیم می‌کند.
set Link Url(url) Equation Function آدرس لینک را تنظیم می‌کند.
set Text Alignment(textAlignment) Equation Function ترازبندی متن را تنظیم می‌کند.

مستندات دقیق

clear()

محتویات عنصر را پاک می‌کند.

بازگشت

EquationFunction - عنصر فعلی.

copy()

یک کپی جدا و عمیق از عنصر فعلی را برمی‌گرداند.

هر عنصر فرزندی که در عنصر وجود داشته باشد نیز کپی می‌شود. عنصر جدید والد ندارد.

بازگشت

EquationFunction - نسخه جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

editAsText()

یک نسخه Text از عنصر فعلی را برای ویرایش دریافت می‌کند.

editAsText برای دستکاری محتوای عناصر به عنوان متن غنی استفاده کنید. حالت editAsText عناصر غیر متنی (مانند InlineImage و HorizontalRule ) را نادیده می‌گیرد.

عناصر فرزندی که کاملاً در محدوده متن حذف شده قرار دارند، از عنصر حذف می‌شوند.

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

محتویات عنصر را برای یافتن نسلی از نوع مشخص شده جستجو می‌کند.

پارامترها

نام نوع توضیحات
element Type Element Type نوع عنصری که باید جستجو شود.

بازگشت

RangeElement |null — نتیجه جستجو که موقعیت عنصر جستجو را نشان می‌دهد.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

findElement(elementType, from)

محتویات عنصر را برای یافتن نسلی از نوع مشخص شده، با شروع از RangeElement مشخص شده، جستجو می‌کند.

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

پارامترها

نام نوع توضیحات
element Type Element Type نوع عنصری که باید جستجو شود.
from Range Element نتیجه جستجو برای جستجو از.

بازگشت

RangeElement |null — نتیجه جستجو که موقعیت بعدی عنصر جستجو را نشان می‌دهد.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

findText(searchPattern)

با استفاده از عبارات منظم، محتوای عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.

زیرمجموعه‌ای از ویژگی‌های عبارات منظم جاوا اسکریپت به طور کامل پشتیبانی نمی‌شوند، مانند گروه‌های ضبط و اصلاح‌کننده‌های حالت.

الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متنی موجود در عنصر فعلی مطابقت داده می‌شود.

پارامترها

نام نوع توضیحات
search Pattern String الگویی که باید جستجو شود

بازگشت

RangeElement |null — نتیجه جستجو که موقعیت متن جستجو را نشان می‌دهد، یا در صورت عدم تطابق، null

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

findText(searchPattern, from)

با شروع از یک نتیجه جستجوی داده شده، محتویات عنصر را برای الگوی متنی مشخص شده جستجو می‌کند.

زیرمجموعه‌ای از ویژگی‌های عبارات منظم جاوا اسکریپت به طور کامل پشتیبانی نمی‌شوند، مانند گروه‌های ضبط و اصلاح‌کننده‌های حالت.

الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متنی موجود در عنصر فعلی مطابقت داده می‌شود.

پارامترها

نام نوع توضیحات
search Pattern String الگویی که باید جستجو شود
from Range Element نتیجه جستجو برای جستجو از

بازگشت

RangeElement |null — نتیجه جستجو که موقعیت بعدی متن جستجو را نشان می‌دهد، یا در صورت عدم تطابق، null

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

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

getChild(childIndex)

عنصر فرزند را در اندیس فرزند مشخص شده بازیابی می‌کند.

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

// Obtain the first element in the tab.
const 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.');
}

پارامترها

نام نوع توضیحات
child Index Integer اندیس عنصر فرزندی که قرار است بازیابی شود.

بازگشت

Element - عنصر فرزند در اندیس مشخص شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getChildIndex(child)

اندیس فرزند را برای عنصر فرزند مشخص شده بازیابی می‌کند.

پارامترها

نام نوع توضیحات
child Element عنصر فرزندی که اندیس آن بازیابی می‌شود.

بازگشت

Integer - اندیس فرزند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getCode()

کد مربوط به تابع معادله را بازیابی می‌کند.

بازگشت

String - کد تابع

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getLinkUrl()

آدرس لینک را بازیابی می‌کند.

بازگشت

String|null — آدرس اینترنتی لینک، یا اگر عنصر شامل چندین مقدار برای این ویژگی باشد، null.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getNextSibling()

عنصر خواهر یا برادر بعدی عنصر را بازیابی می‌کند.

خواهر یا برادر بعدی، والد یکسانی دارد و عنصر فعلی را دنبال می‌کند.

بازگشت

Element |null — عنصر خواهر یا برادر بعدی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getNumChildren()

تعداد فرزندان را بازیابی می‌کند.

const 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 |null — عنصر والد.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getPreviousSibling()

عنصر خواهر و برادر قبلی عنصر را بازیابی می‌کند.

عنصر خواهر یا برادر قبلی، والد یکسانی دارد و قبل از عنصر فعلی قرار می‌گیرد.

بازگشت

Element |null — عنصر خواهر یا برادر قبلی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • 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 — نوع ترازبندی متن، یا اگر متن شامل چندین نوع ترازبندی متن باشد یا ترازبندی متن هرگز تنظیم نشده باشد، null

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • 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

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

بازگشت

EquationFunction |null — عنصر ادغام‌شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

بازگشت

EquationFunction |null — عنصر حذف شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

replaceText(searchPattern, replacement)

با استفاده از عبارات منظم، تمام موارد تکرار یک الگوی متنی مشخص را با یک رشته جایگزین مشخص جایگزین می‌کند.

الگوی جستجو به صورت یک رشته ارسال می‌شود، نه یک شیء عبارت منظم جاوا اسکریپت. به همین دلیل، باید هرگونه بک‌اسلش را در الگو escape کنید.

این روش از کتابخانه عبارات منظم RE2 گوگل استفاده می‌کند که سینتکس‌های پشتیبانی‌شده را محدود می‌کند.

الگوی عبارت منظم ارائه شده به طور مستقل با هر بلوک متنی موجود در عنصر فعلی مطابقت داده می‌شود.

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

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

پارامترها

نام نوع توضیحات
search Pattern String الگوی regex برای جستجو
replacement String متنی که قرار است به عنوان جایگزین استفاده شود

بازگشت

Element - عنصر فعلی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

پارامترها

نام نوع توضیحات
attributes Object ویژگی‌های عنصر.

بازگشت

EquationFunction - عنصر فعلی.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

setLinkUrl(url)

آدرس لینک را تنظیم می‌کند.

پارامترها

نام نوع توضیحات
url String آدرس لینک

بازگشت

EquationFunction - عنصر فعلی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

  • 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.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

پارامترها

نام نوع توضیحات
text Alignment Text Alignment نوع ترازبندی متن که باید اعمال شود

بازگشت

EquationFunction - عنصر فعلی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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