Class InlineImage

InlineImage

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 darf kein anderes Element enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

Methoden

MethodeRückgabetypKurzbeschreibung
copy()InlineImageGibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
getAltDescription()StringDie alternative Beschreibung des Bilds.
getAltTitle()StringGibt den alternativen Titel des Bildes zurück.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, der 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()IntegerDie Höhe des Bildes in Pixeln.
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()IntegerDie Breite des Bilds in Pixeln.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende des Document befindet.
merge()InlineImageDas Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.
removeFromParent()InlineImageEntfernt das Element aus dem übergeordneten Element.
setAltDescription(description)InlineImageHier legen Sie die alternative Beschreibung des Bildes fest.
setAltTitle(title)InlineImageLegt den alternativen Titel des Bildes fest.
setAttributes(attributes)InlineImageHiermit werden die Attribute des Elements festgelegt.
setHeight(height)InlineImageHiermit wird die Höhe des Bildes in Pixeln festgelegt.
setLinkUrl(url)InlineImageLegt die URL des Links fest.
setWidth(width)InlineImageHiermit wird die Breite des Bilds in Pixeln festgelegt.

Detaillierte Dokumentation

copy()

Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.

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

Rückflug

InlineImage – die neue Kopie.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getAltDescription()

Die alternative Beschreibung des Bilds.

Rückflug

String – der alternative Titel oder null, wenn das Element keinen alternativen Titel hat

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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.

Rückflug

String – der alternative Titel oder null, wenn das Element keinen alternativen Titel hat

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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, der in den angegebenen Inhaltstyp konvertiert wurde. Bei dieser Methode wird dem Dateinamen die entsprechende Erweiterung hinzugefügt, z. B. „meinedatei.pdf“. Es wird jedoch davon ausgegangen, dass der Teil des Dateinamens, der auf den letzten Punkt (falls vorhanden) folgt, eine vorhandene Erweiterung ist, die ersetzt werden soll. Daraus wird „Einkaufsliste.25.12.2014“ zu „Einkaufsliste.25.12.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. Bei Bildern im BMP-, GIF-, JPEG- oder PNG-Format sind auch 'image/bmp', 'image/gif', 'image/jpeg' oder 'image/png' zulässig. Für ein Google Docs-Dokument ist auch 'text/markdown' zulässig.

Rückflug

Blob – Die Daten als Blob.


getAttributes()

Ruft die Attribute des Elements ab.

Das Ergebnis ist ein Objekt mit einer Property für jedes gültige Elementattribut, wobei jeder Property-Name einem Element in der DocumentApp.Attribute-Aufzählung entspricht.

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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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()

Die Höhe des Bildes in Pixeln.

Rückflug

Integer: Höhe des Bildes in Pixeln

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, erfordern eine Autorisierung für einen oder mehrere 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 dasselbe übergeordnete Element und folgt dem aktuellen Element.

Rückflug

Element: Das nächste gleichgeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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.

Rückflug

ContainerElement: Das übergeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 dasselbe übergeordnete Element und geht dem aktuellen Element voraus.

Rückflug

Element: Das vorherige gleichgeordnete Element.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getWidth()

Die Breite des Bilds in Pixeln.

Rückflug

Integer: Die Breite des Bildes in Pixeln

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isAtDocumentEnd()

Bestimmt, ob sich das Element am Ende des Document befindet.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

merge()

Das Element wird mit dem vorhergehenden Geschwisterelement desselben Typs zusammengeführt.

Es können nur Elemente desselben ElementType zusammengeführt werden. Alle untergeordneten Elemente, die sich im aktuellen Element befinden, werden zum übergeordneten 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setAltDescription(description)

Hier legen Sie die alternative Beschreibung des Bildes fest. Wenn der angegebene Titel null ist, wird die Beschreibung auf den leeren String gesetzt.

Parameter

NameTypBeschreibung
descriptionStringden alternativen Titel

Rückflug

InlineImage – das aktuelle Objekt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 ist, wird der Titel auf den leeren String gesetzt.

Parameter

NameTypBeschreibung
titleStringden alternativen Titel

Rückflug

InlineImage – das aktuelle Objekt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setAttributes(attributes)

Hiermit werden die Attribute des Elements festgelegt.

Der angegebene Attributparameter muss ein Objekt sein, bei 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setHeight(height)

Hiermit wird die Höhe des Bildes in Pixeln festgelegt.

Parameter

NameTypBeschreibung
heightIntegerdie Höhe des Bildes in Pixeln

Rückflug

InlineImage – das aktuelle Objekt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setLinkUrl(url)

Legt die URL des Links 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setWidth(width)

Hiermit wird die Breite des Bilds in Pixeln festgelegt.

Parameter

NameTypBeschreibung
widthIntegerdie Breite des Bildes in Pixeln

Rückflug

InlineImage – das aktuelle Objekt

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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