Ein Element, das ein eingebettetes Bild darstellt. Ein InlineImage
kann in ListItem
oder Paragraph
enthalten sein, es sei denn, ListItem
oder Paragraph
ist in FootnoteSection
. Ein InlineImage
kann selbst keine anderen Elemente enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | InlineImage | Gibt eine getrennte, tiefgehende Kopie des aktuellen Elements zurück. |
getAltDescription() | String | Gibt die alternative Beschreibung des Bildes zurück. |
getAltTitle() | String | Gibt den alternativen Titel des Bildes zurück. |
getAs(contentType) | Blob | Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getBlob() | Blob | Gibt die Daten in diesem Objekt als Blob zurück. |
getHeight() | Integer | Ruft die Bildhöhe in Pixeln ab. |
getLinkUrl() | String | Ruft die Link-URL ab. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab. |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
getWidth() | Integer | Ruft die Bildbreite in Pixeln ab. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | InlineImage | Führt das Element mit dem vorherigen gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | InlineImage | Entfernt das Element aus seinem übergeordneten Element. |
setAltDescription(description) | InlineImage | Legt die alternative Beschreibung des Bildes fest. |
setAltTitle(title) | InlineImage | Legt den alternativen Titel des Bildes fest. |
setAttributes(attributes) | InlineImage | Legt die Attribute des Elements fest. |
setHeight(height) | InlineImage | Legt die Höhe des Bildes in Pixeln fest. |
setLinkUrl(url) | InlineImage | Legt die Link-URL fest. |
setWidth(width) | InlineImage | Legt die Breite des Bildes in Pixeln fest. |
Detaillierte Dokumentation
copy()
Gibt eine getrennte, tiefgehende Kopie des aktuellen Elements zurück.
Alle untergeordneten Elemente, die im Element vorhanden sind, werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.
Return
InlineImage
: Die neue Kopie.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltDescription()
Gibt die alternative Beschreibung des Bildes zurück.
Return
String
: der alternative Titel oder null
, wenn das Element keinen alternativen Titel hat
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltTitle()
Gibt den alternativen Titel des Bildes zurück.
Return
String
: der alternative Titel oder null
, wenn das Element keinen alternativen Titel hat
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. Bei dieser Methode wird dem Dateinamen die entsprechende Erweiterung hinzugefügt, z. B. "myfile.pdf". Dabei wird jedoch davon ausgegangen, dass der Teil des Dateinamens, der auf den letzten Punkt (falls vorhanden) folgt, eine vorhandene Erweiterung ist, die ersetzt werden sollte. Aus „ShoppingList.12.25.2014“ wird dann „ShoppingList.12.25.pdf“.
Informationen zu den Tageskontingenten für Conversions finden Sie unter Kontingente für Google-Dienste. Für neu erstellte Google Workspace-Domains gelten möglicherweise vorübergehend strengere Kontingente.
Parameter
Name | Typ | Beschreibung |
---|---|---|
contentType | String | Der MIME-Typ, in den konvertiert werden soll. Für die meisten Blobs ist 'application/pdf' die einzige gültige Option. Für Bilder im BMP-, GIF-, JPEG- oder PNG-Format sind auch 'image/bmp' , 'image/gif' , 'image/jpeg' oder 'image/png' gültig. |
Return
Blob
: Die Daten als Blob.
getAttributes()
Ruft die Attribute des Elements ab.
Das Ergebnis ist ein Objekt, das ein Attribut für jedes gültige Elementattribut enthält, wobei jeder Attributname einem Element in der DocumentApp.Attribute
-Aufzählung entspricht.
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]); }
Return
Object
: Die Attribute des Elements.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBlob()
getHeight()
Ruft die Bildhöhe in Pixeln ab.
Return
Integer
: die Höhe des Bildes in Pixeln
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
Ruft die Link-URL ab.
Return
String
: die Link-URL oder null
, wenn das Element mehrere Werte für dieses Attribut enthält.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Ruft das nächste gleichgeordnete Element des Elements ab.
Das nächste gleichgeordnete Element hat das gleiche übergeordnete Element und folgt dem aktuellen Element.
Return
Element
: Das nächste gleichgeordnete Element.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Ruft das übergeordnete Element des Elements ab.
Das übergeordnete Element enthält das aktuelle Element.
Return
ContainerElement
: Das übergeordnete Element.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Ruft das vorherige gleichgeordnete Element des Elements ab.
Das vorherige gleichgeordnete Element hat das gleiche übergeordnete Element und steht dem aktuellen Element vor.
Return
Element
: Das vorherige gleichgeordnete Element.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Ruft den ElementType
des Elements ab.
Verwenden Sie getType()
, um den genauen Typ eines bestimmten Elements zu bestimmen.
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.'); }
Return
ElementType
: Der Elementtyp.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getWidth()
Ruft die Bildbreite in Pixeln ab.
Return
Integer
: die Breite des Bildes in Pixeln
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Bestimmt, ob sich das Element am Ende von Document
befindet.
Return
Boolean
: Gibt an, ob sich das Element am Ende des Dokuments befindet.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Führt das Element mit dem vorherigen gleichgeordneten Element desselben Typs zusammen.
Nur Elemente derselben ElementType
können zusammengeführt werden. Alle untergeordneten Elemente, die im aktuellen Element enthalten sind, werden in das vorherige gleichgeordnete Element verschoben.
Das aktuelle Element wird aus dem Dokument entfernt.
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();
Return
InlineImage
: Das zusammengeführte Element.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Entfernt das Element aus seinem übergeordneten Element.
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(); }
Return
InlineImage
: Das entfernte Element.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltDescription(description)
Legt die alternative Beschreibung des Bildes fest. Wenn der angegebene Titel null
lautet, wird für die Beschreibung ein leerer String festgelegt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
description | String | der alternative Titel |
Return
InlineImage
– das aktuelle Objekt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltTitle(title)
Legt den alternativen Titel des Bildes fest. Wenn der angegebene Titel null
lautet, wird der Titel auf den leeren String festgelegt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
title | String | der alternative Titel |
Return
InlineImage
– das aktuelle Objekt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Legt die Attribute des Elements fest.
Der angegebene Attributparameter muss ein Objekt sein, bei dem jeder Attributname ein Element in der DocumentApp.Attribute
-Aufzählung und jeder Attributwert der neue Wert ist, der angewendet werden soll.
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);
Parameter
Name | Typ | Beschreibung |
---|---|---|
attributes | Object | Die Attribute des Elements. |
Return
InlineImage
: Das aktuelle Element.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeight(height)
Legt die Höhe des Bildes in Pixeln fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
height | Integer | Die Höhe des Bildes in Pixeln |
Return
InlineImage
– das aktuelle Objekt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Legt die Link-URL fest. Wenn die angegebene URL null
oder ein leerer String ist, wird mit dieser Methode ein Link mit einer leeren URL erstellt, der in Google Docs als "Ungültiger Link" angezeigt werden kann.
Parameter
Name | Typ | Beschreibung |
---|---|---|
url | String | Die Link-URL |
Return
InlineImage
– das aktuelle Objekt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setWidth(width)
Legt die Breite des Bildes in Pixeln fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
width | Integer | Die Breite des Bildes in Pixeln |
Return
InlineImage
– das aktuelle Objekt
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents