Class PositionedImage

PositionedImage

Imagem de posição fixa ancorada em um Paragraph. Ao contrário de um InlineImage, um PositionedImage não é um Element. Ele não tem um elemento Element pai ou irmão. Em vez disso, ele é ancorado em um Paragraph ou ListItem e posicionado por deslocamentos dessa âncora. Um PositionedImage tem um ID que pode ser usado para referenciá-lo. 

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

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

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

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

Métodos

MétodoTipo de retornoBreve descrição
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorna 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 é organizada.
getLeftOffset()NumberRecebe o deslocamento da imagem, em pontos, da esquerda do parágrafo.
getParagraph()ParagraphRecebe o Paragraph a que a imagem está ancorada.
getTopOffset()NumberRecebe o deslocamento da imagem, em pontos, da parte de cima do parágrafo.
getWidth()IntegerRecupera a largura da imagem, em pixels.
setHeight(height)PositionedImageDefine a altura da imagem em pixels.
setLayout(layout)PositionedImageDefine como a imagem é organizada.
setLeftOffset(offset)PositionedImageDefine o deslocamento da imagem, em pontos, à esquerda do parágrafo.
setTopOffset(offset)PositionedImageDefine o deslocamento da imagem, em pontos, da parte superior do parágrafo.
setWidth(width)PositionedImageDefine a largura da imagem, em pixels.

Documentação detalhada

getAs(contentType)

Retorna 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, ele pressupõe que a parte do nome do arquivo que segue o último ponto (se houver) é uma extensão existente que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ShoppingList.12.25.pdf".

Para conferir 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 sujeitos temporariamente a cotas mais rígidas.

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 em formato BMP, GIF, JPEG ou PNG, qualquer uma das opções 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também é válida. Para um documento do Google Docs, 'text/markdown' também é válido.

Retornar

Blob: os dados como um blob.

getBlob()

Retorna 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 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.

Retornar

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 é organizada.

Retornar

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, da esquerda do parágrafo.

Retornar

Number: o deslocamento da imagem da esquerda 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 a que a imagem está ancorada.

Retornar

Paragraph: o parágrafo principal

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, da parte de cima do parágrafo.

Retornar

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.

Retornar

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

Retornar

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 como a imagem é organizada.

Parâmetros

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

Retornar

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, à esquerda do parágrafo.

Parâmetros

NomeTipoDescrição
offsetNumberdeslocamento à esquerda do parágrafo

Retornar

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, da parte superior do parágrafo.

Parâmetros

NomeTipoDescrição
offsetNumberdeslocamento da parte de cima do parágrafo

Retornar

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

Retornar

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