Class InlineImage

InlineBild

Ein Element, das ein eingebettetes Bild darstellt. Ein InlineImage kann in einem ListItem oder Paragraph enthalten sein, es sei denn, das ListItem oder Paragraph befindet sich in einem FootnoteSection. Ein InlineImage-Element darf selbst kein anderes Element enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

Methoden

MethodeRückgabetypKurzbeschreibung
copy()InlineImageGibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
getAltDescription()StringGibt die alternative Beschreibung des Bildes zurück.
getAltTitle()StringGibt den alternativen Titel des Bildes zurück.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getAttributes()ObjectRuft die Attribute des Elements ab.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getHeight()IntegerRuft die Höhe des Bildes in Pixeln ab.
getLinkUrl()StringRuft die Link-URL ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
getWidth()IntegerRuft die Breite des Bildes in Pixeln ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende von Document befindet.
merge()InlineImageFührt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.
removeFromParent()InlineImageEntfernt das Element aus dem übergeordneten Element.
setAltDescription(description)InlineImageLegt die alternative Beschreibung des Bildes fest.
setAltTitle(title)InlineImageLegt den alternativen Titel des Bildes fest.
setAttributes(attributes)InlineImageLegt die Attribute des Elements fest.
setHeight(height)InlineImageLegt die Höhe des Bildes in Pixeln fest.
setLinkUrl(url)InlineImageLegt die Link-URL fest.
setWidth(width)InlineImageLegt die Breite des Bilds in Pixeln fest.

Detaillierte Dokumentation

copy()

Gibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.

Alle untergeordneten Elemente des Elements werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.

Rückflug

InlineImage: Der neue Text.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getAltDescription()

Gibt die alternative Beschreibung des Bildes zurück.

Rückflug

String: Die alternative Beschreibung oder null, wenn das Element keine alternative Beschreibung hat.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getAltTitle()

Gibt den alternativen Titel des Bildes zurück.

Rückflug

String: Der alternative Titel oder null, wenn das Element keinen alternativen Titel hat.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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. „meine_datei.pdf“. Dabei wird jedoch davon ausgegangen, dass der Teil des Dateinamens, der auf den letzten Punkt folgt (falls vorhanden), eine vorhandene Erweiterung ist, die ersetzt werden soll. Folglich wird aus „ShoppingList.12.25.2014“ „ShoppingList.12.25.pdf“.

Die täglichen Kontingente 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

NameTypBeschreibung
contentTypeStringDer 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. Für ein Google Docs-Dokument ist auch 'text/markdown' gültig.

Rückflug

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. Jeder Attributname entspricht einem Element in der DocumentApp.Attribute-Aufzählung. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Rückflug

Object: Die Attribute des Elements.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getBlob()

Gibt die Daten in diesem Objekt als Blob zurück.

Rückflug

Blob: Die Daten als Blob.

getHeight()

Ruft die Höhe des Bildes in Pixeln ab.

Rückflug

Integer – die Höhe des Bildes in Pixeln

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getLinkUrl()

Ruft die Link-URL ab.

Rückflug

String: Die Link-URL oder null, wenn das Element mehrere Werte für dieses Attribut enthält.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 dasselbe übergeordnete Element und folgt auf das aktuelle Element.

Rückflug

Element: Das nächste gleichgeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

Rückflug

ContainerElement: Das übergeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 dasselbe übergeordnete Element und geht dem aktuellen Element voraus.

Rückflug

Element: Das vorherige gleichgeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getType()

Ruft den ElementType des Elements ab.

Mit getType() können Sie den genauen Typ eines bestimmten Elements ermitteln. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const 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.');
}

Rückflug

ElementType: Der Elementtyp.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getWidth()

Ruft die Breite des Bildes in Pixeln ab.

Rückflug

Integer: die Breite des Bildes in Pixeln

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

isAtDocumentEnd()

Gibt an, ob sich das Element am Ende von Document befindet.

Rückflug

Boolean: Gibt an, ob sich das Element am Ende des Tabs befindet.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

merge()

Führt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen.

Es können nur Elemente desselben ElementType zusammengeführt werden. Alle untergeordneten Elemente des aktuellen Elements werden in das vorhergehende gleichgeordnete Element verschoben.

Das aktuelle Element wird aus dem Dokument entfernt. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Rückflug

InlineImage: Das zusammengeführte Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

removeFromParent()

Entfernt das Element aus dem übergeordneten Element. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Rückflug

InlineImage: Das entfernte Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 ist, wird die Beschreibung auf einen leeren String gesetzt.

Parameter

NameTypBeschreibung
descriptionStringDie alternative Beschreibung.

Rückflug

InlineImage: Das aktuelle Objekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 ist, wird der Titel auf den leeren String gesetzt.

Parameter

NameTypBeschreibung
titleStringDer alternative Titel.

Rückflug

InlineImage: Das aktuelle Objekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setAttributes(attributes)

Legt die Attribute des Elements fest.

Der angegebene Parameter „attributes“ muss ein Objekt sein, in dem jeder Attributname ein Element in der Aufzählung DocumentApp.Attribute ist und jeder Attributwert der neue Wert ist, der angewendet werden soll. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const 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.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parameter

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Rückflug

InlineImage: Das aktuelle Element.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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

NameTypBeschreibung
heightIntegerDie Höhe des Bildes in Pixeln

Rückflug

InlineImage – das aktuelle Objekt

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • 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 möglicherweise als „Ungültiger Link“ angezeigt wird.

Parameter

NameTypBeschreibung
urlStringDie Link-URL

Rückflug

InlineImage: Das aktuelle Objekt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setWidth(width)

Legt die Breite des Bilds in Pixeln fest.

Parameter

NameTypBeschreibung
widthIntegerDie Breite des Bildes in Pixeln

Rückflug

InlineImage – das aktuelle Objekt

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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