Esta página foi traduzida pela API Cloud Translation.

Class InlineImage

Um elemento que representa uma imagem incorporada. Um InlineImage pode estar contido em um ListItem ou Paragraph, a menos que ListItem ou Paragraph estejam dentro um FootnoteSection. Um InlineImage não pode conter nenhum outro elemento. Para Saiba mais sobre a estrutura do documento no guia para ampliar os arquivos do Documentos Google.

Métodos

Método	Tipo de retorno	Breve descrição
`copy()`	`InlineImage`	Retorna uma cópia detalhada e removida do elemento atual.
`getAltDescription()`	`String`	Retorna a descrição alternativa da imagem.
`getAltTitle()`	`String`	Retorna o título alternativo da imagem.
`getAs(contentType)`	`Blob`	Retorna os dados dentro desse objeto como um blob convertido no tipo de conteúdo especificado.
`getAttributes()`	`Object`	Recupera os atributos do elemento.
`getBlob()`	`Blob`	Retorne os dados dentro desse objeto como um blob.
`getHeight()`	`Integer`	Recupera a altura da imagem, em pixels.
`getLinkUrl()`	`String`	Recupera o URL do link.
`getNextSibling()`	`Element`	Recupera o próximo elemento irmão do elemento.
`getParent()`	`ContainerElement`	Recupera o elemento pai do elemento.
`getPreviousSibling()`	`Element`	Recupera o elemento irmão anterior do elemento.
`getType()`	`ElementType`	Recupera o `ElementType` do elemento.
`getWidth()`	`Integer`	Recupera a largura da imagem em pixels.
`isAtDocumentEnd()`	`Boolean`	Determina se o elemento está no final do `Document`.
`merge()`	`InlineImage`	Mescla o elemento com o irmão anterior do mesmo tipo.
`removeFromParent()`	`InlineImage`	Remove o elemento do pai.
`setAltDescription(description)`	`InlineImage`	Define a descrição alternativa da imagem.
`setAltTitle(title)`	`InlineImage`	Define o título alternativo da imagem.
`setAttributes(attributes)`	`InlineImage`	Define os atributos do elemento.
`setHeight(height)`	`InlineImage`	Define a altura da imagem em pixels.
`setLinkUrl(url)`	`InlineImage`	Define o URL do link.
`setWidth(width)`	`InlineImage`	Define a largura da imagem em pixels.

Documentação detalhada

`copy()`

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

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

Retornar

InlineImage: a nova cópia.

Autorização

Os scripts que usam esse método precisam de 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 da imagem.

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 precisam de 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 da imagem.

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 precisam de autorização com um ou mais dos seguintes escopos:

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

`getAs(contentType)`

Retorna os dados dentro desse objeto como um blob convertido no tipo de conteúdo especificado. Isso adiciona a extensão adequada ao nome do arquivo, por exemplo, "myfile.pdf". No entanto, pressupõe que a parte do nome do arquivo que segue o ponto final (se houver) é uma que deve ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ListaShopping.12.25.pdf".

Para acessar as cotas diárias para conversões, consulte Cotas do Google Serviços. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a medidas cotas.

Parâmetros

Nome	Tipo	Descrição
`contentType`	`String`	O tipo MIME em que a conversão será feita. Para a maioria dos blobs, `'application/pdf'` é a única opção válida. Para imagens no formato BMP, GIF, JPEG ou PNG, qualquer um dos valores `'image/bmp'`, `'image/gif'`, `'image/jpeg'` ou `'image/png'` também precisa ser válidos. Para um documento do Documentos Google, `'text/markdown'` também é válido.

Retornar

Blob: os dados como um blob.

`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 da propriedade corresponde a um item na enumeração 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]);
}

Retornar

Object: os atributos do elemento.

Autorização

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

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

`getBlob()`

Retorne os dados dentro desse objeto como um blob.

Retornar

Blob: os dados como um blob.

`getHeight()`

Recupera a altura da imagem, em pixels.

Retornar

Integer: a altura da imagem, em pixels.

Autorização

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

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

`getLinkUrl()`

Recupera o URL do link.

Retornar

String: o URL do link ou null se o elemento tiver vários valores para este .

Autorização

Os scripts que usam esse método precisam de 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 irmão tem o mesmo pai e segue o elemento atual.

Retornar

Element: o próximo elemento irmão.

Autorização

Os scripts que usam esse método precisam de 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 precisam de 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 precisam de 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 determinado elemento.

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

Retornar

ElementType: o tipo de elemento.

Autorização

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

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

`getWidth()`

Recupera a largura da imagem em pixels.

Retornar

Integer: a largura da imagem, em pixels

Autorização

Os scripts que usam esse método precisam de 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 precisam de 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.

Somente elementos do mesmo ElementType podem ser mesclados. Todos os elementos filhos contidos o elemento atual são movidos para o elemento irmão anterior.

O elemento atual é removido do documento.

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

Retornar

InlineImage: o elemento mesclado.

Autorização

Os scripts que usam esse método precisam de 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.

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

Retornar

InlineImage: o elemento removido.

Autorização

Os scripts que usam esse método precisam de 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 da imagem. Se o título fornecido for null, define o description para a string vazia.

Parâmetros

Nome	Tipo	Descrição
`description`	`String`	o título alternativo

Retornar

InlineImage: o objeto atual.

Autorização

Os scripts que usam esse método precisam de 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 da imagem. Se o título fornecido for null, define o título como o string vazia.

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título alternativo

Retornar

InlineImage: o objeto atual.

Autorização

Os scripts que usam esse método precisam de 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 a enumeração DocumentApp.Attribute e cada valor de propriedade é o novo valor a ser aplicada.

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

Parâmetros

Nome	Tipo	Descrição
`attributes`	`Object`	Os atributos do elemento.

Retornar

InlineImage: o elemento atual.

Autorização

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

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

`setHeight(height)`

Define a altura da imagem em pixels.

Parâmetros

Nome	Tipo	Descrição
`height`	`Integer`	a altura da imagem em pixels

Retornar

InlineImage: o objeto atual.

Autorização

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

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

`setLinkUrl(url)`

Define o URL do link. Se o URL for null ou uma string vazia, este método criará Um link com um URL vazio que pode ser exibido como "Link inválido" no app Documentos Google.

Parâmetros

Nome	Tipo	Descrição
`url`	`String`	o URL do link

Retornar

InlineImage: o objeto atual.

Autorização

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

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

`setWidth(width)`

Define a largura da imagem em pixels.

Parâmetros

Nome	Tipo	Descrição
`width`	`Integer`	a largura da imagem em pixels

Retornar

InlineImage: o objeto atual.

Autorização

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

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