Element reprezentujący osadzony obraz. Element InlineImage
może być zawarty w elemencie ListItem
lub Paragraph
, chyba że element ListItem
lub Paragraph
jest zawarty w elemencie FootnoteSection
. Element InlineImage
nie może zawierać żadnego innego elementu. Więcej informacji o strukturze dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | InlineImage | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAltDescription() | String | Zwraca alternatywny opis obrazu. |
getAltTitle() | String | Zwraca alternatywny tytuł obrazu. |
getAs(contentType) | Blob | Zwraca dane z tego obiektu jako blob przekonwertowany na określony typ treści. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getBlob() | Blob | Zwraca dane z tego obiektu jako blob. |
getHeight() | Integer | Pobiera wysokość obrazu w pikselach. |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera następny element nadrzędny. |
getParent() | ContainerElement | Pobiera element nadrzędny. |
getPreviousSibling() | Element | Pobiera poprzedni element nadrzędny. |
getType() | ElementType | Pobiera wartość atrybutu ElementType elementu. |
getWidth() | Integer | Pobiera szerokość obrazu w pikselach. |
isAtDocumentEnd() | Boolean | Określa, czy element znajduje się na końcu Document . |
merge() | InlineImage | Łączy element z poprzednim elementem tego samego typu. |
removeFromParent() | InlineImage | Usuwa element z jego elementu nadrzędnego. |
setAltDescription(description) | InlineImage | Ustawia alternatywny opis obrazu. |
setAltTitle(title) | InlineImage | Ustawia tytuł alternatywny obrazu. |
setAttributes(attributes) | InlineImage | Ustawia atrybuty elementu. |
setHeight(height) | InlineImage | Określa wysokość obrazu w pikselach. |
setLinkUrl(url) | InlineImage | Ustawia adres URL linku. |
setWidth(width) | InlineImage | Ustawia szerokość obrazu w pikselach. |
Szczegółowa dokumentacja
copy()
Zwraca odłączoną, głęboką kopię bieżącego elementu.
Skopiowane zostaną też wszystkie elementy podrzędne obecne w danym elemencie. Nowy element nie ma rodzica.
Powrót
InlineImage
– nowa kopia.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltDescription()
Zwraca alternatywny opis obrazu.
Powrót
String
– tytuł alternatywny lub null
, jeśli element nie ma tytułu alternatywnego.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltTitle()
Zwraca alternatywny tytuł obrazu.
Powrót
String
– tytuł alternatywny lub null
, jeśli element nie ma tytułu alternatywnego.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
Zwraca dane z tego obiektu jako blob przekonwertowany na określony typ treści. Ta metoda dodaje odpowiednie rozszerzenie do nazwy pliku, np. „mójplik.pdf”. Zakłada ona jednak, że część nazwy pliku, która następuje po ostatnim okresie (jeśli w ogóle występuje), to istniejące rozszerzenie, które należy zastąpić. W rezultacie plik „ShoppingList.12.25.2014” zmieni nazwę na „ShoppingList.12.25.pdf”.
Informacje o limitach dziennych konwersji znajdziesz w artykule Limity dotyczące usług Google. Nowo utworzone domeny Google Workspace mogą być tymczasowo objęte bardziej rygorystycznymi limitami.
Parametry
Nazwa | Typ | Opis |
---|---|---|
contentType | String | Typ MIME, na który ma nastąpić konwersja. W przypadku większości blobów opcja 'application/pdf' jest jedyną prawidłową opcją. W przypadku obrazów w formacie BMP, GIF, JPEG lub PNG prawidłowe są również wartości 'image/bmp' , 'image/gif' , 'image/jpeg' lub 'image/png' . W przypadku dokumentu w Dokumentach Google możesz też użyć 'text/markdown' . |
Powrót
Blob
– dane w postaci bloba.
getAttributes()
Pobiera atrybuty elementu.
Wynikiem jest obiekt zawierający właściwość dla każdego prawidłowego atrybutu elementu, przy czym każda nazwa właściwości odpowiada elementowi w wyliczeniu DocumentApp.Attribute
.
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]}`); }
Powrót
Object
– atrybuty elementu.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBlob()
getHeight()
Pobiera wysokość obrazu w pikselach.
Powrót
Integer
– wysokość obrazu w pikselach.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
Pobiera adres URL linku.
Powrót
String
– adres URL linku lub null
, jeśli element zawiera wiele wartości tego atrybutu.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Pobiera następny element nadrzędny.
Następny element równego rzędu ma tego samego rodzica i następuje po bieżącym elemencie.
Powrót
Element
– następny element równorzędny.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Pobiera element nadrzędny.
Element nadrzędny zawiera bieżący element.
Powrót
ContainerElement
– element nadrzędny.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Pobiera poprzedni element nadrzędny elementu.
Poprzedni element ma tego samego rodzica i poprzedza bieżący element.
Powrót
Element
– poprzedni równorzędny element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Pobiera wartość atrybutu ElementType
elementu.
Aby określić dokładny typ danego elementu, użyj właściwości getType()
.
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.'); }
Powrót
ElementType
– typ elementu.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getWidth()
Pobiera szerokość obrazu w pikselach.
Powrót
Integer
– szerokość obrazu w pikselach.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Określa, czy element znajduje się na końcu Document
.
Powrót
Boolean
– określa, czy element znajduje się na końcu karty.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Łączy element z poprzednim elementem tego samego typu.
Można scalać tylko elementy tego samego ElementType
. Wszystkie elementy podrzędne zawarte w bieżącym elemencie zostaną przeniesione do poprzedniego elementu nadrzędnego.
Bieżący element zostanie usunięty z dokumentu.
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();
Powrót
InlineImage
– scalony element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Usuwa element z jego elementu nadrzędnego.
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(); }
Powrót
InlineImage
– usunięty element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltDescription(description)
Ustawia alternatywny opis obrazu. Jeśli podany tytuł to null
, ustawia opis na pusty ciąg znaków.
Parametry
Nazwa | Typ | Opis |
---|---|---|
description | String | alternatywny tytuł. |
Powrót
InlineImage
– bieżący obiekt
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltTitle(title)
Ustawia tytuł alternatywny obrazu. Jeśli podany tytuł to null
, ustawia tytuł jako pusty ciąg znaków.
Parametry
Nazwa | Typ | Opis |
---|---|---|
title | String | alternatywny tytuł. |
Powrót
InlineImage
– bieżący obiekt
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Ustawia atrybuty elementu.
Parametr specified attributes musi być obiektem, w którym każda nazwa właściwości jest elementem zbioru wyliczenia DocumentApp.Attribute
, a każda wartość właściwości jest nową wartością do zastosowania.
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);
Parametry
Nazwa | Typ | Opis |
---|---|---|
attributes | Object | atrybuty elementu, |
Powrót
InlineImage
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeight(height)
Określa wysokość obrazu w pikselach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
height | Integer | wysokość obrazu w pikselach. |
Powrót
InlineImage
– bieżący obiekt
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Ustawia adres URL linku. Jeśli podany adres URL to null
lub pusty ciąg znaków, ta metoda utworzy link z pustym adresem URL, który może być wyświetlany w Dokumentach Google jako „Nieprawidłowy link”.
Parametry
Nazwa | Typ | Opis |
---|---|---|
url | String | adres URL linku, |
Powrót
InlineImage
– bieżący obiekt
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setWidth(width)
Ustawia szerokość obrazu w pikselach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
width | Integer | szerokość obrazu w pikselach. |
Powrót
InlineImage
– bieżący obiekt
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents