Class EquationFunction

RównanieFunkcja

Element reprezentujący funkcję w Equation matematycznym. Element EquationFunction może zawierać elementy EquationFunction, EquationFunctionArgumentSeparator, EquationSymbolText. Więcej informacji o strukturze dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.

Metody

MetodaZwracany typKrótki opis
clear()EquationFunctionUsuwa zawartość elementu.
copy()EquationFunctionZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getCode()StringPobiera kod odpowiadający funkcji równania.
getLinkUrl()String|nullPobiera adres URL linku.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()EquationFunction|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()EquationFunction|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)EquationFunctionUstawia atrybuty elementu.
setLinkUrl(url)EquationFunctionUstawia adres URL linku.
setTextAlignment(textAlignment)EquationFunctionUstawia wyrównanie tekstu.

Szczegółowa dokumentacja

clear()

Usuwa zawartość elementu.

Powrót

EquationFunction – bieżący element.


copy()

Zwraca odłączoną, głęboką kopię bieżącego elementu.

Kopiowane są też wszystkie elementy podrzędne znajdujące się w elemencie. Nowy element nie ma elementu nadrzędnego.

Powrót

EquationFunction – nowy tekst.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

editAsText()

Pobiera wersję Text bieżącego elementu do edycji.

Użyj editAsText, aby manipulować zawartością elementów jako tekstem sformatowanym. Tryb editAsText ignoruje elementy inne niż tekstowe (takie jak InlineImageHorizontalRule).

Elementy podrzędne w pełni zawarte w zakresie usuniętego tekstu są usuwane z elementu.

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

Powrót

Text – tekstowa wersja bieżącego elementu.


findElement(elementType)

Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.

Parametry

NazwaTypOpis
elementTypeElementTypeTyp elementu do wyszukania.

Powrót

RangeElement|null – wynik wyszukiwania wskazujący pozycję elementu wyszukiwania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

findElement(elementType, from)

Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu 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;
  }
}

Parametry

NazwaTypOpis
elementTypeElementTypeTyp elementu do wyszukania.
fromRangeElementWynik wyszukiwania, z którego chcesz wyszukiwać.

Powrót

RangeElement|null – wynik wyszukiwania wskazujący następną pozycję elementu wyszukiwania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

findText(searchPattern)

Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.

Niektóre funkcje wyrażeń regularnych JavaScriptu nie są w pełni obsługiwane, np. grupy przechwytywania i modyfikatory trybu.

Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie do każdego bloku tekstu zawartego w bieżącym elemencie.

Parametry

NazwaTypOpis
searchPatternStringwzór do wyszukania,

Powrót

RangeElement|null – wynik wyszukiwania wskazujący pozycję tekstu wyszukiwania lub wartość null, jeśli nie ma dopasowania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

findText(searchPattern, from)

Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.

Niektóre funkcje wyrażeń regularnych JavaScriptu nie są w pełni obsługiwane, np. grupy przechwytywania i modyfikatory trybu.

Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie do każdego bloku tekstu zawartego w bieżącym elemencie.

Parametry

NazwaTypOpis
searchPatternStringwzór do wyszukania,
fromRangeElementwynik wyszukiwania, z którego chcesz wyszukiwać;

Powrót

RangeElement|null – wynik wyszukiwania wskazujący następną pozycję tekstu wyszukiwania lub wartość null, jeśli nie ma dopasowania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getAttributes()

Pobiera atrybuty elementu.

Wynikiem jest obiekt zawierający właściwość dla każdego prawidłowego atrybutu elementu, przy czym nazwa każdej właściwości odpowiada elementowi w wyliczeniu 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]}`);
}

Powrót

Object – atrybuty elementu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getChild(childIndex)

Pobiera element podrzędny o określonym indeksie.

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.');
}

Parametry

NazwaTypOpis
childIndexIntegerIndeks elementu podrzędnego do pobrania.

Powrót

Element – element podrzędny w określonym indeksie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getChildIndex(child)

Pobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.

Parametry

NazwaTypOpis
childElementElement podrzędny, dla którego ma zostać pobrany indeks.

Powrót

Integer – indeks podrzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getCode()

Pobiera kod odpowiadający funkcji równania.

Powrót

String – kod funkcji;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getLinkUrl()

Pobiera adres URL linku.

Powrót

String|null – adres URL linku lub wartość null, jeśli element zawiera wiele wartości tego atrybutu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getNextSibling()

Pobiera następny element równorzędny.

Następny element równorzędny ma tego samego rodzica i występuje po bieżącym elemencie.

Powrót

Element|null – następny element równorzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getNumChildren()

Pobiera liczbę dzieci.

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

Powrót

Integer – liczba dzieci.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getParent()

Pobiera element nadrzędny elementu.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement|null – element nadrzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getPreviousSibling()

Pobiera poprzedni element sąsiedni elementu.

Poprzedni element równorzędny ma tego samego rodzica i występuje przed bieżącym elementem.

Powrót

Element|null – poprzedni element równorzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getText()

Pobiera zawartość elementu jako ciąg tekstowy.

Powrót

String – zawartość elementu w postaci ciągu tekstowego.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getTextAlignment()

Pobiera wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPTDocumentApp.TextAlignment.SUPERSCRIPT.

Powrót

TextAlignment|null – typ wyrównania tekstu lub null, jeśli tekst zawiera wiele typów wyrównania lub jeśli wyrównanie tekstu nigdy nie zostało ustawione.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getType()

Pobiera ElementType elementu.

Użyj właściwości getType(), aby określić dokładny typ danego elementu.

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.');
}

Powrót

ElementType – typ elementu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

isAtDocumentEnd()

Określa, czy element znajduje się na końcu Document.

Powrót

Boolean – czy element znajduje się na końcu karty.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

merge()

Łączy element z poprzednim elementem tego samego typu.

Można scalać tylko elementy tego samego ElementType. Wszystkie elementy podrzędne zawarte w bieżącym elemencie są przenoszone do poprzedniego elementu równorzędnego.

Bieżący element zostanie usunięty z dokumentu.

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

Powrót

EquationFunction|null – scalony element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

removeFromParent()

Usuwa element z elementu nadrzędnego.

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

Powrót

EquationFunction|null – usunięty element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

replaceText(searchPattern, replacement)

Zamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.

Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie jako obiekt wyrażenia regularnego JavaScript. Dlatego musisz zmienić znaczenie wszystkich ukośników odwrotnych we wzorcu.

Ta metoda korzysta z biblioteki wyrażeń regularnych RE2 Google, która ogranicza obsługiwaną składnię.

Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie do każdego bloku tekstu zawartego w bieżącym elemencie.

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

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

Parametry

NazwaTypOpis
searchPatternStringwzór wyrażenia regularnego do wyszukania;
replacementStringtekst, który ma zastąpić oryginalny tekst;

Powrót

Element – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

setAttributes(attributes)

Ustawia atrybuty elementu.

Parametr specifiedAttributes musi być obiektem, w którym każda nazwa właściwości jest elementem wyliczenia DocumentApp.Attribute, a każda wartość właściwości jest nową wartością do zastosowania.

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

Parametry

NazwaTypOpis
attributesObjectAtrybuty elementu.

Powrót

EquationFunction – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

setLinkUrl(url)

Ustawia adres URL linku.

Parametry

NazwaTypOpis
urlStringadres URL linku,

Powrót

EquationFunction – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

setTextAlignment(textAlignment)

Ustawia wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPTDocumentApp.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);

Parametry

NazwaTypOpis
textAlignmentTextAlignmenttyp wyrównania tekstu do zastosowania;

Powrót

EquationFunction – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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