Class InlineImage

Obrazw treści

Element reprezentujący umieszczony obraz. Element InlineImage może znajdować się w elemencie ListItem lub Paragraph, chyba że element ListItem lub Paragraph znajduje się 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

MetodaZwracany typKrótki opis
copy()InlineImageZwraca odłączoną, głęboką kopię bieżącego elementu.
getAltDescription()StringZwraca alternatywny opis obrazu.
getAltTitle()StringZwraca alternatywny tytuł obrazu.
getAs(contentType)BlobZwraca dane w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści.
getAttributes()ObjectPobiera atrybuty elementu.
getBlob()BlobZwraca dane w tym obiekcie jako obiekt blob.
getHeight()IntegerPobiera wysokość obrazu w pikselach.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera ElementType elementu.
getWidth()IntegerPobiera szerokość obrazu w pikselach.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()InlineImageŁączy element z poprzednim elementem tego samego typu.
removeFromParent()InlineImageUsuwa element z elementu nadrzędnego.
setAltDescription(description)InlineImageUstawia opis alternatywny obrazu.
setAltTitle(title)InlineImageUstawia alternatywny tytuł obrazu.
setAttributes(attributes)InlineImageUstawia atrybuty elementu.
setHeight(height)InlineImageUstawia wysokość obrazu w pikselach.
setLinkUrl(url)InlineImageUstawia adres URL linku.
setWidth(width)InlineImageUstawia szerokość obrazu w pikselach.

Szczegółowa dokumentacja

copy()

Zwraca odłączoną, głęboką kopię bieżącego elementu.

Kopiowane są też wszystkie elementy podrzędne znajdujące się w elemencie. Nowy element nie ma elementu nadrzędnego.

Powrót

InlineImage – nowy tekst.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 – opis alternatywny lub null, jeśli element nie ma opisu alternatywnego.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getAs(contentType)

Zwraca dane w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści. Ta metoda dodaje do nazwy pliku odpowiednie rozszerzenie, np. „mójplik.pdf”. Zakłada jednak, że część nazwy pliku, która następuje po ostatniej kropce (jeśli występuje), jest istniejącym rozszerzeniem, które należy zastąpić. W konsekwencji nazwa „ShoppingList.12.25.2014” zmieni się na „ShoppingList.12.25.pdf”.

Aby wyświetlić dzienne limity konwersji, zapoznaj się z artykułem Limity usług Google. Nowo utworzone domeny Google Workspace mogą być tymczasowo objęte bardziej rygorystycznymi limitami.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME, na który ma zostać przekonwertowany plik. W przypadku większości obiektów blob jedyną prawidłową opcją jest 'application/pdf'. W przypadku obrazów w formacie BMP, GIF, JPEG lub PNG prawidłowe są też znaki 'image/bmp', 'image/gif', 'image/jpeg' i 'image/png'. W przypadku dokumentu w Dokumentach Google 'text/markdown' jest również prawidłowe.

Powrót

Blob – dane w formie obiektu blob.

getAttributes()

Pobiera atrybuty elementu.

Wynikiem jest obiekt zawierający właściwość dla każdego prawidłowego atrybutu elementu, przy czym nazwa każdej 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getBlob()

Zwraca dane w tym obiekcie jako obiekt blob.

Powrót

Blob – dane w formie obiektu blob.

getHeight()

Pobiera wysokość obrazu w pikselach.

Powrót

Integer – wysokość obrazu w pikselach.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getNextSibling()

Pobiera następny element równorzędny elementu.

Następny element równorzędny ma tego samego elementu nadrzędnego i występuje po bieżącym elemencie.

Powrót

Element – następny element równorzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getParent()

Pobiera element nadrzędny elementu.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement – element nadrzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getPreviousSibling()

Pobiera poprzedni element równorzędny elementu.

Poprzedni element równorzędny ma tego samego rodzica i występuje przed bieżącym elementem.

Powrót

Element – poprzedni element równorzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getType()

Pobiera ElementType elementu.

Użyj getType(), aby określić dokładny typ danego elementu. 

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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 – czy element znajduje się na końcu karty.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 są przenoszone do poprzedniego elementu równorzę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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

removeFromParent()

Usuwa element z 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

setAltDescription(description)

Ustawia opis alternatywny obrazu. Jeśli podany tytuł to null, ustawia opis na pusty ciąg znaków.

Parametry

NazwaTypOpis
descriptionStringOpis alternatywny.

Powrót

InlineImage – bieżący obiekt.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

setAltTitle(title)

Ustawia alternatywny tytuł obrazu. Jeśli podany tytuł to null, ustawia tytuł na pusty ciąg znaków.

Parametry

NazwaTypOpis
titleStringTytuł alternatywny.

Powrót

InlineImage – bieżący obiekt.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

setAttributes(attributes)

Ustawia atrybuty elementu.

Parametr specifiedAttributes musi być obiektem, w którym każda nazwa właściwości jest elementem 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

NazwaTypOpis
attributesObjectAtrybuty elementu.

Powrót

InlineImage – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

setHeight(height)

Ustawia wysokość obrazu w pikselach.

Parametry

NazwaTypOpis
heightIntegerwysokość obrazu w pikselach;

Powrót

InlineImage – bieżący obiekt

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

setLinkUrl(url)

Ustawia adres URL linku. Gdy podany adres URL to null lub pusty ciąg znaków, ta metoda tworzy link z pustym adresem URL, który w Dokumentach Google może być wyświetlany jako „Nieprawidłowy link”.

Parametry

NazwaTypOpis
urlStringAdres URL linku.

Powrót

InlineImage – bieżący obiekt.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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

NazwaTypOpis
widthIntegerszerokość obrazu w pikselach;

Powrót

InlineImage – bieżący obiekt

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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