Esta página foi traduzida pela API Cloud Translation.

Class PositionedImage

Imagem de posição fixa ancorada a um Paragraph. Ao contrário de um InlineImage, um PositionedImage é e não um Element. Ele não tem pai ou irmão Element. Em vez disso, é ancorada em Paragraph ou ListItem e é posicionada por deslocamentos da aquela âncora. Uma PositionedImage tem um ID que pode ser usado para fazer referência a ela.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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étodo	Tipo de retorno	Breve descrição
`getAs(contentType)`	`Blob`	Retorna os dados dentro desse objeto como um blob convertido no tipo de conteúdo especificado.
`getBlob()`	`Blob`	Retorne os dados dentro desse objeto como um blob.
`getHeight()`	`Integer`	Recupera a altura da imagem, em pixels.
`getId()`	`String`	Recebe o ID da imagem.
`getLayout()`	`PositionedLayout`	Recebe um valor de enumeração que representa como a imagem é disposta.
`getLeftOffset()`	`Number`	Recebe o deslocamento da imagem, em pontos, a partir da esquerda do parágrafo.
`getParagraph()`	`Paragraph`	Recebe o `Paragraph` em que a imagem está ancorada.
`getTopOffset()`	`Number`	Extrai o deslocamento da imagem, em pontos, a partir da parte superior do parágrafo.
`getWidth()`	`Integer`	Recupera a largura da imagem em pixels.
`setHeight(height)`	`PositionedImage`	Define a altura da imagem em pixels.
`setLayout(layout)`	`PositionedImage`	Define a definição de como a imagem é disposta.
`setLeftOffset(offset)`	`PositionedImage`	Define o deslocamento da imagem, em pontos, a partir da esquerda do parágrafo.
`setTopOffset(offset)`	`PositionedImage`	Define o deslocamento da imagem, em pontos, a partir da parte superior do parágrafo.
`setWidth(width)`	`PositionedImage`	Define a largura da imagem em pixels.

Documentação detalhada

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

`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

`getId()`

Recebe o ID da imagem.

Retornar

String: o ID da imagem

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

`getLayout()`

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

Retornar

PositionedLayout: o layout da imagem.

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

`getLeftOffset()`

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

Retornar

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

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

`getParagraph()`

Recebe o Paragraph em que a imagem está ancorada.

Retornar

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

`getTopOffset()`

Extrai o deslocamento da imagem, em pontos, a partir da parte superior 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 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

`setHeight(height)`

Define a altura da imagem em pixels.

Parâmetros

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

Retornar

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

`setLayout(layout)`

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

Parâmetros

Nome	Tipo	Descrição
`layout`	`PositionedLayout`	um tipo enumerado que representa o modo de layout

Retornar

PositionedImage: este objeto para encadeamento

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

`setLeftOffset(offset)`

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

Parâmetros

Nome	Tipo	Descrição
`offset`	`Number`	deslocamento da esquerda do parágrafo

Retornar

PositionedImage: este objeto para encadeamento

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

`setTopOffset(offset)`

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

Parâmetros

Nome	Tipo	Descrição
`offset`	`Number`	deslocado da parte superior do parágrafo

Retornar

PositionedImage: este objeto para encadeamento

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

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