Élément représentant une image intégrée. Un InlineImage
peut être contenu dans un ListItem
ou un Paragraph
, sauf si ListItem
ou Paragraph
se trouve dans un FootnoteSection
. Une InlineImage
ne peut contenir aucun autre élément. Pour en savoir plus sur la structure des documents, consultez le guide sur l'extension de Google Docs.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | InlineImage | Renvoie une copie profonde détachée de l'élément actuel. |
getAltDescription() | String | Affiche la description alternative de l'image. |
getAltTitle() | String | Renvoie le titre de substitution de l'image. |
getAs(contentType) | Blob | Renvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié. |
getAttributes() | Object | Récupère les attributs de l'élément. |
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. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
getWidth() | Integer | Récupère la largeur de l'image, en pixels. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | InlineImage | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | InlineImage | Supprime l'élément de son parent. |
setAltDescription(description) | InlineImage | Définit la description alternative de l'image. |
setAltTitle(title) | InlineImage | Définit le titre de substitution de l'image. |
setAttributes(attributes) | InlineImage | Définit les attributs de l'élément. |
setHeight(height) | InlineImage | Définit la hauteur de l'image, en pixels. |
setLinkUrl(url) | InlineImage | Définit l'URL du lien. |
setWidth(width) | InlineImage | Définit la largeur de l'image, en pixels. |
Documentation détaillée
copy()
Renvoie une copie profonde détachée de l'élément actuel.
Tous les éléments enfants présents dans l'élément sont également copiés. Le nouvel élément n'a pas de parent.
Renvois
InlineImage
: nouvelle copie
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
getAltDescription()
Affiche la description alternative de l'image.
Renvois
String
: titre alternatif, ou null
si l'élément n'a pas de titre alternatif
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
getAltTitle()
Renvoie le titre de substitution de l'image.
Renvois
String
: titre alternatif, ou null
si l'élément n'a pas de titre alternatif
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
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.
getAttributes()
Récupère les attributs de l'élément.
Le résultat est un objet contenant une propriété pour chaque attribut d'élément valide, où chaque nom de propriété correspond à un élément de l'énumération DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Renvois
Object
: attributs de l'élément.
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
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
getLinkUrl()
Récupère l'URL du lien.
Renvois
String
: URL du lien ou null
si l'élément contient plusieurs valeurs pour cet attribut.
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
getNextSibling()
Récupère l'élément frère suivant de l'élément.
Le frère suivant a le même parent et suit l'élément actuel.
Renvois
Element
: élément frère suivant.
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
getParent()
Récupère l'élément parent de l'élément.
L'élément parent contient l'élément actuel.
Renvois
ContainerElement
: élément 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
getPreviousSibling()
Récupère l'élément frère précédent de l'élément.
Le frère ou sœur précédent a le même parent et précède l'élément actuel.
Renvois
Element
: élément frère précédent.
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
getType()
Récupère l'ElementType
de l'élément.
Utilisez getType()
pour déterminer le type exact d'un élément donné.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Renvois
ElementType
: type d'élément.
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
isAtDocumentEnd()
Détermine si l'élément se trouve à la fin de Document
.
Renvois
Boolean
: indique si l'élément se trouve à la fin du document.
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
merge()
Fusionne l'élément avec le frère ou la sœur précédent du même type.
Seuls les éléments d'un même ElementType
peuvent être fusionnés. Tous les éléments enfants contenus dans l'élément actuel sont déplacés vers l'élément frère précédent.
L'élément actuel est supprimé du document.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Renvois
InlineImage
: élément fusionné
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
removeFromParent()
Supprime l'élément de son parent.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Renvois
InlineImage
: élément supprimé.
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
setAltDescription(description)
Définit la description alternative de l'image. Si le titre donné est null
, définit la description sur la chaîne vide.
Paramètres
Nom | Type | Description |
---|---|---|
description | String | titre alternatif |
Renvois
InlineImage
: 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
setAltTitle(title)
Définit le titre de substitution de l'image. Si le titre donné est null
, il définit le titre sur une chaîne vide.
Paramètres
Nom | Type | Description |
---|---|---|
title | String | titre alternatif |
Renvois
InlineImage
: 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
setAttributes(attributes)
Définit les attributs de l'élément.
Le paramètre d'attributs spécifié doit être un objet dans lequel chaque nom de propriété est un élément de l'énumération DocumentApp.Attribute
, et chaque valeur de propriété correspond à la nouvelle valeur à appliquer.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Paramètres
Nom | Type | Description |
---|---|---|
attributes | Object | Attributs de l'élément |
Renvois
InlineImage
: élément 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
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
InlineImage
: 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
setLinkUrl(url)
Définit l'URL du lien. Si l'URL donnée est null
ou correspond à une chaîne vide, cette méthode crée un lien avec une URL vide qui peut s'afficher avec la mention "Lien non valide" dans Google Docs.
Paramètres
Nom | Type | Description |
---|---|---|
url | String | URL du lien. |
Renvois
InlineImage
: 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
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
InlineImage
: 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