Class PositionedImage

PositionedImage

A imagem de posição fixada em um Paragraph foi corrigida Diferente de um InlineImage, um PositionedImage não é um Element. Ela não tem um Element pai ou irmão. Em vez disso, ele é ancorado a uma Paragraph ou ListItem e é colocado por deslocamentos dessa âncora. Uma PositionedImage tem um ID que pode ser usado para referenciar.

var body = DocumentApp.getActiveDocument().getBody();

// Append a new paragraph.
var paragraph = body.appendParagraph("New paragraph to anchor the image to.");

// Get an image in Drive from its ID.
var image = DriveApp.getFileById('ENTER_IMAGE_FILE_ID_HERE').getBlob();

// Add the PositionedImage with offsets (in points).
var posImage = paragraph.addPositionedImage(image)
    .setTopOffset(60)
    .setLeftOffset(40);

Métodos

MétodoTipo de retornoBreve descrição
getAs(contentType)BlobRetorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getHeight()IntegerRecupera a altura da imagem em pixels.
getId()StringRecebe o ID da imagem.
getLayout()PositionedLayoutRecebe um valor de enumeração que representa como a imagem é disposta.
getLeftOffset()NumberRecebe o deslocamento da imagem, em pontos, a partir da esquerda do parágrafo.
getParagraph()ParagraphRecebe o Paragraph ao qual a imagem está ancorada.
getTopOffset()NumberRecebe o deslocamento da imagem, em pontos, a partir da parte superior do parágrafo.
getWidth()IntegerRecupera a largura da imagem em pixels.
setHeight(height)PositionedImageDefine a altura da imagem em pixels.
setLayout(layout)PositionedImageDefine a definição de como a imagem é exibida.
setLeftOffset(offset)PositionedImageDefine o deslocamento da imagem, em pontos, a partir da esquerda do parágrafo.
setTopOffset(offset)PositionedImageDefine o deslocamento da imagem, em pontos, a partir da parte superior do parágrafo.
setWidth(width)PositionedImageDefine a largura da imagem em pixels.

Documentação detalhada

getAs(contentType)

Retorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. Esse método adiciona a extensão apropriada ao nome do arquivo, por exemplo, "meuarquivo.pdf". No entanto, ela pressupõe que a parte do nome do arquivo que segue o último ponto (se houver) é uma extensão que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ShoppingList.12.25.pdf".

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

Parâmetros

NomeTipoDescrição
contentTypeStringO tipo MIME para conversão. Para a maioria dos blobs, 'application/pdf' é a única opção válida. Para imagens no formato BMP, GIF, JPEG ou PNG, qualquer elemento 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também é válido.

Retorno

Blob: os dados como um blob.


getBlob()

Retorne os dados dentro desse objeto como um blob.

Retorno

Blob: os dados como um blob.


getHeight()

Recupera a altura da imagem em pixels.

Retorno

Integer: a altura da imagem em pixels.

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

getId()

Recebe o ID da imagem.

Retorno

String: o ID da imagem.

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

getLayout()

Recebe um valor de enumeração que representa como a imagem é disposta.

Retorno

PositionedLayout: o layout da imagem

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

getLeftOffset()

Recebe o deslocamento da imagem, em pontos, a partir da esquerda do parágrafo.

Retorno

Number: o deslocamento da imagem do parágrafo à esquerda

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

getParagraph()

Recebe o Paragraph ao qual a imagem está ancorada.

Retorno

Paragraph: o parágrafo 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

getTopOffset()

Recebe o deslocamento da imagem, em pontos, a partir da parte superior do parágrafo.

Retorno

Number: o deslocamento da imagem da parte superior do parágrafo à esquerda

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

getWidth()

Recupera a largura da imagem em pixels.

Retorno

Integer: a largura da imagem em pixels.

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

setHeight(height)

Define a altura da imagem em pixels.

Parâmetros

NomeTipoDescrição
heightIntegerA altura da imagem em pixels.

Retorno

PositionedImage: 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

setLayout(layout)

Define a definição de como a imagem é exibida.

Parâmetros

NomeTipoDescrição
layoutPositionedLayoutum enum que representa o modo de layout

Retorno

PositionedImage: este objeto para encadeamento.

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

setLeftOffset(offset)

Define o deslocamento da imagem, em pontos, a partir da esquerda do parágrafo.

Parâmetros

NomeTipoDescrição
offsetNumberdeslocamento da esquerda do parágrafo

Retorno

PositionedImage: este objeto para encadeamento.

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

setTopOffset(offset)

Define o deslocamento da imagem, em pontos, a partir da parte superior do parágrafo.

Parâmetros

NomeTipoDescrição
offsetNumberdeslocamento da parte superior do parágrafo

Retorno

PositionedImage: este objeto para encadeamento.

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

setWidth(width)

Define a largura da imagem em pixels.

Parâmetros

NomeTipoDescrição
widthIntegerA largura da imagem em pixels.

Retorno

PositionedImage: 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