Class InlineDrawing

Desenhoinline

Um elemento que representa um desenho incorporado. Um InlineDrawing pode estar contido em um ListItem ou Paragraph, a menos que o ListItem ou Paragraph esteja em um FootnoteSection. Um InlineDrawing não pode conter outro elemento. Para mais informações sobre a estrutura de documentos, consulte o guia para estender o Google Docs.

Métodos

MétodoTipo de retornoBreve descrição
copy()InlineDrawingRetorna uma cópia detalhada e independente do elemento atual.
getAltDescription()StringRetorna a descrição alternativa do desenho.
getAltTitle()StringRetorna o título alternativo do desenho.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()InlineDrawingMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()InlineDrawingRemove o elemento do pai.
setAltDescription(description)InlineDrawingDefine a descrição alternativa do desenho.
setAltTitle(title)InlineDrawingDefine o título alternativo do desenho.
setAttributes(attributes)InlineDrawingDefine os atributos do elemento.

Documentação detalhada

copy()

Retorna uma cópia detalhada e independente do elemento atual.

Todos os elementos filhos presentes no elemento também são copiados. O novo elemento não tem um elemento pai.

Retornar

InlineDrawing: o novo texto.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getAltDescription()

Retorna a descrição alternativa do desenho.

Retornar

String: a descrição alternativa ou null se o elemento não tiver uma descrição alternativa.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getAltTitle()

Retorna o título alternativo do desenho.

Retornar

String: o título alternativo ou null se o elemento não tiver um título alternativo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getAttributes()

Recupera os atributos do elemento.

O resultado é um objeto que contém uma propriedade para cada atributo de elemento válido, em que cada nome de propriedade corresponde a um item na enumeração 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]}`); }

Retornar

Object: os atributos do elemento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getNextSibling()

Recupera o próximo elemento irmão do elemento.

O próximo elemento irmão tem o mesmo elemento pai e segue o elemento atual.

Retornar

Element: o próximo elemento irmão.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getParent()

Recupera o elemento pai do elemento.

O elemento pai contém o elemento atual.

Retornar

ContainerElement: o elemento pai.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getPreviousSibling()

Recupera o elemento irmão anterior do elemento.

O irmão anterior tem o mesmo pai e precede o elemento atual.

Retornar

Element: o elemento irmão anterior.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

getType()

Recupera o ElementType do elemento.

Use getType() para determinar o tipo exato de um elemento específico.

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

Retornar

ElementType: o tipo de elemento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

isAtDocumentEnd()

Determina se o elemento está no final do Document.

Retornar

Boolean: se o elemento está no final da guia.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

merge()

Mescla o elemento com o irmão anterior do mesmo tipo.

Só é possível mesclar elementos do mesmo ElementType. Todos os elementos filhos contidos no elemento atual são movidos para o elemento irmão anterior.

O elemento atual é removido do 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();

Retornar

InlineDrawing: o elemento mesclado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

removeFromParent()

Remove o elemento do pai.

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

Retornar

InlineDrawing: o elemento removido.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setAltDescription(description)

Define a descrição alternativa do desenho. Se a descrição fornecida for null, defina a descrição como a string vazia.

Parâmetros

NomeTipoDescrição
descriptionStringA descrição alternativa.

Retornar

InlineDrawing: o objeto atual.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setAltTitle(title)

Define o título alternativo do desenho. Se o título fornecido for null, defina o título como a string vazia.

Parâmetros

NomeTipoDescrição
titleStringO título alternativo.

Retornar

InlineDrawing: o objeto atual.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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

setAttributes(attributes)

Define os atributos do elemento.

O parâmetro de atributos especificado precisa ser um objeto em que cada nome de propriedade é um item na enumeração DocumentApp.Attribute e cada valor de propriedade é o novo valor a ser aplicado.

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

Parâmetros

NomeTipoDescrição
attributesObjectOs atributos do elemento.

Retornar

InlineDrawing: o elemento atual.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

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