Class EquationFunction

EquazioneFunzione

Un elemento che rappresenta una funzione in un Equation matematico. Un EquationFunction può contenere elementi EquationFunction, EquationFunctionArgumentSeparator, EquationSymbol e Text. Per saperne di più sulla struttura dei documenti, consulta la guida all'estensione di Google Docs.

Metodi

MetodoTipo restituitoBreve descrizione
clear()EquationFunctionCancella i contenuti dell'elemento.
copy()EquationFunctionRestituisce una copia indipendente e completa dell'elemento corrente.
editAsText()TextOttiene una versione Text dell'elemento corrente per la modifica.
findElement(elementType)RangeElement|nullCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElement|nullCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal RangeElement specificato.
findText(searchPattern)RangeElement|nullCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando le espressioni regolari.
findText(searchPattern, from)RangeElement|nullCerca nel contenuto dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento secondario all'indice secondario specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getCode()StringRecupera il codice corrispondente alla funzione dell'equazione.
getLinkUrl()String|nullRecupera l'URL del link.
getNextSibling()Element|nullRecupera l'elemento successivo associato all'elemento.
getNumChildren()IntegerRecupera il numero di figli.
getParent()ContainerElement|nullRecupera l'elemento principale dell'elemento.
getPreviousSibling()Element|nullRecupera l'elemento precedente associato all'elemento.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignment|nullOttiene l'allineamento del testo.
getType()ElementTypeRecupera ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()EquationFunction|nullUnisce l'elemento al fratello precedente dello stesso tipo.
removeFromParent()EquationFunction|nullRimuove l'elemento dal relativo elemento principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa di sostituzione, utilizzando espressioni regolari.
setAttributes(attributes)EquationFunctionImposta gli attributi dell'elemento.
setLinkUrl(url)EquationFunctionImposta l'URL del link.
setTextAlignment(textAlignment)EquationFunctionImposta l'allineamento del testo.

Documentazione dettagliata

clear()

Cancella i contenuti dell'elemento.

Indietro

EquationFunction: l'elemento corrente.


copy()

Restituisce una copia indipendente e completa dell'elemento corrente.

Vengono copiati anche gli eventuali elementi secondari presenti nell'elemento. Il nuovo elemento non ha un elemento principale.

Indietro

EquationFunction: la nuova copia.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

editAsText()

Ottiene una versione Text dell'elemento corrente per la modifica.

Utilizza editAsText per manipolare i contenuti degli elementi come testo RTF. La modalità editAsText ignora gli elementi non di testo (come InlineImage e HorizontalRule).

Gli elementi secondari completamente contenuti in un intervallo di testo eliminato vengono rimossi dall'elemento.

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

Indietro

Text: una versione di testo dell'elemento corrente


findElement(elementType)

Cerca nei contenuti dell'elemento un discendente del tipo specificato.

Parametri

NomeTipoDescrizione
elementTypeElementTypeIl tipo di elemento da cercare.

Indietro

RangeElement|null: un risultato di ricerca che indica la posizione dell'elemento di ricerca.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

findElement(elementType, from)

Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal RangeElement specificato.

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

Parametri

NomeTipoDescrizione
elementTypeElementTypeIl tipo di elemento da cercare.
fromRangeElementIl risultato di ricerca da cui effettuare la ricerca.

Indietro

RangeElement|null: un risultato di ricerca che indica la posizione successiva dell'elemento di ricerca.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

findText(searchPattern)

Cerca nei contenuti dell'elemento il pattern di testo specificato utilizzando le espressioni regolari.

Un sottoinsieme delle funzionalità delle espressioni regolari JavaScript non è completamente supportato, ad esempio gruppi di acquisizione e modificatori di modalità.

Il pattern di espressione regolare fornito viene confrontato in modo indipendente con ogni blocco di testo contenuto nell'elemento corrente.

Parametri

NomeTipoDescrizione
searchPatternStringil pattern da cercare

Indietro

RangeElement|null: un risultato di ricerca che indica la posizione del testo di ricerca o null se non corrisponde

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

findText(searchPattern, from)

Cerca nel contenuto dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca.

Un sottoinsieme delle funzionalità delle espressioni regolari JavaScript non è completamente supportato, ad esempio gruppi di acquisizione e modificatori di modalità.

Il pattern di espressione regolare fornito viene confrontato in modo indipendente con ogni blocco di testo contenuto nell'elemento corrente.

Parametri

NomeTipoDescrizione
searchPatternStringil pattern da cercare
fromRangeElementil risultato di ricerca da cui effettuare la ricerca

Indietro

RangeElement|null: un risultato di ricerca che indica la posizione successiva del testo di ricerca o null se non è presente alcuna corrispondenza

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getAttributes()

Recupera gli attributi dell'elemento.

Il risultato è un oggetto contenente una proprietà per ogni attributo dell'elemento valido, in cui ogni nome di proprietà corrisponde a un elemento dell'enumerazione 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]}`);
}

Indietro

Object: gli attributi dell'elemento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getChild(childIndex)

Recupera l'elemento secondario all'indice secondario specificato.

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

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice dell'elemento secondario da recuperare.

Indietro

Element: l'elemento secondario all'indice specificato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getChildIndex(child)

Recupera l'indice figlio per l'elemento figlio specificato.

Parametri

NomeTipoDescrizione
childElementL'elemento secondario per cui recuperare l'indice.

Indietro

Integer: l'indice secondario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getCode()

Recupera il codice corrispondente alla funzione dell'equazione.

Indietro

String: il codice della funzione

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getLinkUrl()

Recupera l'URL del link.

Indietro

String|null: l'URL del link o null se l'elemento contiene più valori per questo attributo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getNextSibling()

Recupera l'elemento successivo associato all'elemento.

L'elemento successivo ha lo stesso elemento principale e segue l'elemento corrente.

Indietro

Element|null: l'elemento associato successivo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getNumChildren()

Recupera il numero di figli.

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

Indietro

Integer: il numero di figli.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getParent()

Recupera l'elemento principale dell'elemento.

L'elemento principale contiene l'elemento corrente.

Indietro

ContainerElement|null: l'elemento principale.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getPreviousSibling()

Recupera l'elemento precedente associato all'elemento.

L'elemento associato precedente ha lo stesso elemento principale e precede l'elemento corrente.

Indietro

Element|null: l'elemento associato precedente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getText()

Recupera i contenuti dell'elemento come stringa di testo.

Indietro

String: i contenuti dell'elemento come stringa di testo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getTextAlignment()

Ottiene l'allineamento del testo. I tipi di allineamento disponibili sono DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e DocumentApp.TextAlignment.SUPERSCRIPT.

Indietro

TextAlignment|null: il tipo di allineamento del testo o null se il testo contiene più tipi di allineamento del testo o se l'allineamento del testo non è mai stato impostato

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getType()

Recupera ElementType dell'elemento.

Utilizza getType() per determinare il tipo esatto di un determinato elemento.

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

Indietro

ElementType: il tipo di elemento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isAtDocumentEnd()

Determina se l'elemento si trova alla fine di Document.

Indietro

Boolean: indica se l'elemento si trova alla fine della scheda.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

merge()

Unisce l'elemento al fratello precedente dello stesso tipo.

È possibile unire solo elementi dello stesso ElementType. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento precedente.

L'elemento corrente viene rimosso dal documento.

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

Indietro

EquationFunction|null: l'elemento unito.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeFromParent()

Rimuove l'elemento dal relativo elemento principale.

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

Indietro

EquationFunction|null: l'elemento rimosso.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

replaceText(searchPattern, replacement)

Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa di sostituzione, utilizzando espressioni regolari.

Il pattern di ricerca viene passato come stringa, non come oggetto espressione regolare JavaScript. Per questo motivo, dovrai eseguire l'escape di tutte le barre rovesciate nel pattern.

Questi metodi utilizzano la libreria di espressioni regolari RE2 di Google, che limita la sintassi supportata.

Il pattern di espressione regolare fornito viene confrontato in modo indipendente con ogni blocco di testo contenuto nell'elemento corrente.

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

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

Parametri

NomeTipoDescrizione
searchPatternStringil pattern dell'espressione regolare da cercare
replacementStringil testo da utilizzare come sostituzione

Indietro

Element: l'elemento corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setAttributes(attributes)

Imposta gli attributi dell'elemento.

Il parametro degli attributi specificato deve essere un oggetto in cui ogni nome di proprietà è un elemento dell'enumerazione DocumentApp.Attribute e ogni valore di proprietà è il nuovo valore da applicare.

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

Parametri

NomeTipoDescrizione
attributesObjectGli attributi dell'elemento.

Indietro

EquationFunction: l'elemento corrente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setLinkUrl(url)

Imposta l'URL del link.

Parametri

NomeTipoDescrizione
urlStringl'URL del link

Indietro

EquationFunction: l'elemento corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setTextAlignment(textAlignment)

Imposta l'allineamento del testo. I tipi di allineamento disponibili sono DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e 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);

Parametri

NomeTipoDescrizione
textAlignmentTextAlignmentil tipo di allineamento del testo da applicare

Indietro

EquationFunction: l'elemento corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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