Class PositionedImage

PositionedImage

Image à position fixe ancrée à un Paragraph. Contrairement à un InlineImage, un PositionedImage n'est pas un Element. Il n'a pas de Element parent ni de Element frère ou sœur. Au lieu de cela, il est ancré à un Paragraph ou un ListItem, et est placé à l'aide de décalages par rapport à cet ancrage. Un PositionedImage possède un ID qui peut être utilisé pour le référencer.

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

Méthode	Type renvoyé	Brève description
getAs(contentType)	Blob	Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié.
getBlob()	Blob	Renvoie les données de cet objet sous forme de 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	Obtient une valeur enum qui représente la mise en page de l'image.
getLeftOffset()	Number	Récupère le décalage de l'image, en points, par rapport à la gauche du paragraphe.
getParagraph()	Paragraph	Récupère le Paragraph auquel l'image est ancrée.
getTopOffset()	Number	Récupère le décalage de l'image, en points, par rapport au 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 façon dont l'image est mise en page.
setLeftOffset(offset)	PositionedImage	Définit le décalage de l'image, en points, par rapport à 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 de cet objet sous forme de blob converti au type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "myfile.pdf"). Toutefois, il suppose 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 consulter les quotas quotidiens pour les conversions, consultez 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, les extensions 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' sont également valides. Pour un document Google Docs, 'text/markdown' est également valide.

Renvois

Blob : données sous forme de blob.

---

getBlob()

Renvoie les données de cet objet sous forme de 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 avec un ou plusieurs des scopes 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 avec un ou plusieurs des scopes suivants :

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

---

getLayout()

Obtient une valeur enum qui représente la mise en page de l'image.

Renvois

PositionedLayout : mise en page de l'image

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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, par rapport à la gauche du paragraphe.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

getParagraph()

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

Renvois

Paragraph : paragraphe parent

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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, par rapport au 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 avec un ou plusieurs des scopes 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 avec un ou plusieurs des scopes 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	hauteur de l'image, en pixels

Renvois

PositionedImage : l'objet actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

setLayout(layout)

Définit la façon dont l'image est mise en page.

Paramètres

Nom	Type	Description
layout	PositionedLayout	Énumération représentant le mode de mise en page.

Renvois

PositionedImage : cet objet pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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, par rapport à la gauche du paragraphe.

Paramètres

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

Renvois

PositionedImage : cet objet pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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écalage par rapport au haut du paragraphe

Renvois

PositionedImage : cet objet pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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	Largeur de l'image, en pixels

Renvois

PositionedImage : l'objet actuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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