Class InlineImage

InlineImage

Ein Element, das ein eingebettetes Bild darstellt. Ein InlineImage kann in einem ListItem oder Paragraph, es sei denn, ListItem oder Paragraph befinden sich innerhalb FootnoteSection. Ein InlineImage selbst kann kein anderes Element enthalten. Für 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()StringGibt die alternative Beschreibung des Bilds zurück.
getAltTitle()StringGibt den alternativen Titel des Bilds 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 Bildbreite in Pixeln ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()InlineImageFührt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
removeFromParent()InlineImageEntfernt das Element aus dem übergeordneten Element.
setAltDescription(description)InlineImageLegt die alternative Beschreibung des Bilds fest.
setAltTitle(title)InlineImageLegt den alternativen Titel des Bilds 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 Bildes in Pixeln fest.

Detaillierte Dokumentation

copy()

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

Alle im Element vorhandenen untergeordneten Elemente werden ebenfalls kopiert. Das neue Element hat kein Parent.

Rückflug

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 Bilds zurück.

Rückflug

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 Bilds zurück.

Rückflug

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. Dieses fügt dem Dateinamen die entsprechende Erweiterung hinzu, beispielsweise "meinedatei.pdf". Allerdings geht davon aus, dass der Teil des Dateinamens, der auf den letzten Punkt folgt (falls vorhanden), ein vorhandener die ersetzt werden soll. Daher lautet „Einkaufsliste.12.25.2014“. wird zu „Einkaufsliste.12.25.pdf“.

Die Tageskontingente für Conversions finden Sie unter Kontingente für Google Dienste. Neu erstellte Google Workspace-Domains unterliegen möglicherweise vorübergehend strengeren Richtlinien. Kontingenten.

Parameter

NameTypBeschreibung
contentTypeStringDer MIME-Typ, in den konvertiert werden soll. Für die meisten Blobs ist 'application/pdf' ist die einzige gültige Option. Für Bilder im BMP-, GIF-, JPEG- oder PNG-Format gilt auch Folgendes: 'image/bmp', 'image/gif', 'image/jpeg' oder 'image/png' gültig sein. Bei einem Google Docs-Dokument ist 'text/markdown' ebenfalls gültig.

Rückflug

Blob: Die Daten als Blob.


getAttributes()

Ruft die Attribute des Elements ab.

Das Ergebnis ist ein -Objekt, das eine -Eigenschaft für jedes gültige Elementattribut enthält, wobei jeder Eigenschaftsname entspricht einem Element in der DocumentApp.Attribute-Aufzählung.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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]);
}

Rückflug

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

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

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.

Rückflug

String: die Link-URL oder null, wenn das Element mehrere Werte für dieses .

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

Rückflug

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.

Rückflug

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 dasselbe übergeordnete Element und ist dem aktuellen Element vorangestellt.

Rückflug

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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's 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.');
}

Rückflug

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.

Rückflug

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.

Rückflug

Boolean: gibt an, ob sich das Element am Ende des Tabs 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 vorangehenden gleichgeordneten Element desselben Typs zusammen.

Nur Elemente derselben ElementType können zusammengeführt werden. Alle untergeordneten Elemente, die in werden zum vorherigen gleichgeordneten Element verschoben.

Das aktuelle Element wird aus dem Dokument entfernt.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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();

Rückflug

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 dem übergeordneten Element.

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

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

Rückflug

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 Bilds fest. Wenn der angegebene Titel null lautet, wird der Wert für description in den leeren String ein.

Parameter

NameTypBeschreibung
descriptionStringder alternative Titel

Rückflug

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 Bilds fest. Wenn der angegebene Titel null ist, wird der Titel auf den Leerer String.

Parameter

NameTypBeschreibung
titleStringder alternative Titel

Rückflug

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, in dem jeder Eigenschaftsname ein Element in DocumentApp.Attribute und jeder Attributwert ist der neue Wert, angewendet.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Rückflug

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

NameTypBeschreibung
heightIntegerDie Höhe des Bildes in Pixeln

Rückflug

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, erstellt diese Methode Link mit einer leeren URL, die möglicherweise als „Ungültiger Link“ angezeigt wird in Google Docs.

Parameter

NameTypBeschreibung
urlStringDie Link-URL

Rückflug

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

NameTypBeschreibung
widthIntegerdie Breite des Bildes in Pixeln

Rückflug

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