Cette page a été traduite par l'API Cloud Translation.

Class PositionedImage

Position fixe de l'image ancrée à un Paragraph Contrairement à un InlineImage, un PositionedImage n'est pas un Element. Elle n'a pas de Element parent ni frère ou sœur. Au lieu de cela, elle est ancrée à une Paragraph ou à une ListItem, et placée via des décalages à partir de cette ancre. Un PositionedImage possède un ID qui peut être utilisé pour le référencer.

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éthodes

Méthode	Type renvoyé	Brève description
`getAs(contentType)`	`Blob`	Renvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié.
`getBlob()`	`Blob`	Renvoyez les données contenues dans cet objet sous forme d'objet blob.
`getHeight()`	`Integer`	Récupère la hauteur de l'image, en pixels.
`getId()`	`String`	Récupère l'ID de l'image.
`getLayout()`	`PositionedLayout`	Récupère une valeur d'énumération représentant la disposition de l'image.
`getLeftOffset()`	`Number`	Récupère le décalage de l'image, en points, à partir de la gauche du paragraphe.
`getParagraph()`	`Paragraph`	Récupère l'élément `Paragraph` auquel l'image est ancrée.
`getTopOffset()`	`Number`	Récupère le décalage de l'image, en points, à partir du haut du paragraphe.
`getWidth()`	`Integer`	Récupère la largeur de l'image, en pixels.
`setHeight(height)`	`PositionedImage`	Définit la hauteur de l'image, en pixels.
`setLayout(layout)`	`PositionedImage`	Définit la mise en page de l'image.
`setLeftOffset(offset)`	`PositionedImage`	Définit le décalage de l'image, en points, à partir de la gauche du paragraphe.
`setTopOffset(offset)`	`PositionedImage`	Définit le décalage de l'image, en points, par rapport au haut du paragraphe.
`setWidth(width)`	`PositionedImage`	Définit la largeur de l'image, en pixels.

Documentation détaillée

`getAs(contentType)`

Renvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "myfile.pdf"). Cependant, nous supposons que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une extension existante qui doit être remplacée. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour connaître les quotas quotidiens de conversions, consultez la page Quotas pour les services Google. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des quotas plus stricts.

Paramètres

Nom	Type	Description
`contentType`	`String`	Type MIME vers lequel effectuer la conversion. Pour la plupart des blobs, `'application/pdf'` est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, `'image/bmp'`, `'image/gif'`, `'image/jpeg'` ou `'image/png'` sont également valides.

Renvois

Blob : données sous forme de blob.

`getBlob()`

Renvoyez les données contenues dans cet objet sous forme d'objet blob.

Renvois

Blob : données sous forme de blob.

`getHeight()`

Récupère la hauteur de l'image, en pixels.

Renvois

Integer : hauteur de l'image, en pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`getId()`

Récupère l'ID de l'image.

Renvois

String : ID de l'image

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`getLayout()`

Récupère une valeur d'énumération représentant la disposition de l'image.

Renvois

PositionedLayout : mise en page des images

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`getLeftOffset()`

Récupère le décalage de l'image, en points, à partir de la gauche du paragraphe.

Renvois

Number : décalage de l'image par rapport à la gauche du paragraphe de gauche

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`getParagraph()`

Récupère l'élément Paragraph auquel l'image est ancrée.

Renvois

Paragraph : paragraphe parent

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`getTopOffset()`

Récupère le décalage de l'image, en points, à partir du haut du paragraphe.

Renvois

Number : décalage de l'image par rapport au haut du paragraphe de gauche

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`getWidth()`

Récupère la largeur de l'image, en pixels.

Renvois

Integer : largeur de l'image, en pixels.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`setHeight(height)`

Définit la hauteur de l'image, en pixels.

Paramètres

Nom	Type	Description
`height`	`Integer`	la hauteur de l’image, en pixels

Renvois

PositionedImage : objet actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`setLayout(layout)`

Définit la mise en page de l'image.

Paramètres

Nom	Type	Description
`layout`	`PositionedLayout`	une énumération représentant le mode de mise en page ;

Renvois

PositionedImage : objet de chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`setLeftOffset(offset)`

Définit le décalage de l'image, en points, à partir de la gauche du paragraphe.

Paramètres

Nom	Type	Description
`offset`	`Number`	décalage par rapport à la gauche du paragraphe

Renvois

PositionedImage : objet de chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`setTopOffset(offset)`

Définit le décalage de l'image, en points, par rapport au haut du paragraphe.

Paramètres

Nom	Type	Description
`offset`	`Number`	décalé par rapport au haut du paragraphe

Renvois

PositionedImage : objet de chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`setWidth(width)`

Définit la largeur de l'image, en pixels.

Paramètres

Nom	Type	Description
`width`	`Integer`	la largeur de l'image, en pixels.

Renvois

PositionedImage : objet actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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