Class InlineImage

Obraz w treści

Element reprezentujący umieszczony obraz. InlineImage może być zawarta w obrębie znaczników ListItem lub Paragraph, chyba że właściwość ListItem lub Paragraph znajduje się w obrębie elementu FootnoteSection. Element InlineImage nie może zawierać żadnych innych elementów. Więcej informacji o strukturze dokumentów znajdziesz w przewodniku dotyczącym rozszerzania 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 wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści.
getAttributes()ObjectPobiera atrybuty elementu.
getBlob()BlobZwraca dane wewnątrz tego obiektu jako blob.
getHeight()IntegerPobiera wysokość obrazu w pikselach.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera element potomny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera element potomny.
getType()ElementTypePobiera element ElementType.
getWidth()IntegerPobiera szerokość obrazu w pikselach.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu elementu Document.
merge()InlineImageScala element z poprzednim elementem tego samego typu.
removeFromParent()InlineImageUsuwa element z elementu nadrzędnego.
setAltDescription(description)InlineImageUstawia alternatywny opis obrazu.
setAltTitle(title)InlineImageUstawia alternatywny tytuł obrazu.
setAttributes(attributes)InlineImageUstawia atrybuty elementu.
setHeight(height)InlineImageUstawia wysokość obrazu w pikselach.
setLinkUrl(url)InlineImageUstawia URL linku.
setWidth(width)InlineImageUstawia szerokość obrazu w pikselach.

Szczegółowa dokumentacja

copy()

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

Wszystkie jego elementy podrzędne też zostaną skopiowane. Nowy element nie ma elementu nadrzędnego.

Zwróć

InlineImage – nowa kopia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

String – alternatywny tytuł lub null, jeśli element nie ma takiego tytułu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

String – alternatywny tytuł lub null, jeśli element nie ma takiego tytułu

Autoryzacja

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

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

getAs(contentType)

Zwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści. Ta metoda dodaje odpowiednie rozszerzenie do nazwy pliku, np. „"myfile.pdf&quot”. Zakładamy jednak, że część nazwy pliku po ostatnim okresie (jeśli w ogóle) jest rozszerzeniem, które należy zastąpić. W związku z tym "ShoppingList.12.25.2014" zmienia się w "ShoppingList.12.25.pdf".

Aby sprawdzić dzienne limity konwersji, zobacz Limity usług Google. Nowo utworzone domeny Google Workspace mogą podlegać tymczasowym ograniczeniom.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME, na który ma zostać przekonwertowane. W większości blobów 'application/pdf' jest jedyną prawidłową opcją. W przypadku obrazów w formacie BMP, GIF, JPEG lub PNG prawidłowy jest też każdy z tych formatów: 'image/bmp', 'image/gif', 'image/jpeg' lub 'image/png'.

Zwróć

Blob – dane jako obiekt blob.


getAttributes()

Pobiera atrybuty elementu.

W rezultacie obiekt zawiera właściwość dla każdego prawidłowego atrybutu elementu, gdzie każda nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute.

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

Zwróć

Object – atrybuty elementu

Autoryzacja

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

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

getBlob()

Zwraca dane wewnątrz tego obiektu jako blob.

Zwróć

Blob – dane jako obiekt blob.


getHeight()

Pobiera wysokość obrazu w pikselach.

Zwróć

Integer – wysokość obrazu w pikselach

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

String – adres URL linku lub null, jeśli element zawiera ten atrybut.

Autoryzacja

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

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

getNextSibling()

Pobiera element potomny.

Kolejne rodzeństwo ma tego samego elementu nadrzędnego i jednocześnie występuje w bieżącym elemencie.

Zwróć

Element – następny element potomny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Element nadrzędny zawiera bieżący element.

Zwróć

ContainerElement – element nadrzędny;

Autoryzacja

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

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

getPreviousSibling()

Pobiera element potomny.

Poprzednie rodzeństwo ma ten sam element nadrzędny i wyprzedza bieżący element.

Zwróć

Element – poprzedni element równorzędny.

Autoryzacja

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

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

getType()

Pobiera element ElementType.

Użyj właściwości getType(), aby dokładnie określić typ danego elementu.

var body = DocumentApp.getActiveDocument().getBody();

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

Zwróć

ElementType – typ elementu;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

Integer – szerokość obrazu w pikselach,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 elementu Document.

Zwróć

Boolean – określa, czy element jest na końcu dokumentu –

Autoryzacja

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

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

merge()

Scala element z poprzednim elementem tego samego typu.

Łączyć można tylko te same elementy ElementType. Wszystkie elementy podrzędne zawarte w bieżącym elemencie są przenoszone do elementu nadrzędnego.

Bieżący element zostanie usunięty z dokumentu.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
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();

Zwróć

InlineImage – scalony element;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

var body = DocumentApp.getActiveDocument().getBody();

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

Zwróć

InlineImage – usunięty element;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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, opis zostanie ustawiony na pusty ciąg znaków.

Parametry

NazwaTypOpis
descriptionStringalternatywny tytuł

Zwróć

InlineImage – bieżący obiekt

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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, tytuł jest pusty.

Parametry

NazwaTypOpis
titleStringalternatywny tytuł

Zwróć

InlineImage – bieżący obiekt

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Wskazany parametr musi być obiektem, w którym każda nazwa właściwości jest elementem w wyliczeniach DocumentApp.Attribute, a każda wartość właściwości to nowa wartość do zastosowania.

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

Parametry

NazwaTypOpis
attributesObjectAtrybuty elementu.

Zwróć

InlineImage – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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

Zwróć

InlineImage – bieżący obiekt

Autoryzacja

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

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

setLinkUrl(url)

Ustawia URL linku. Jeśli podany adres URL to null lub pusty ciąg znaków, ta metoda spowoduje utworzenie linku z pustym adresem URL, który może być wyświetlany w Dokumentach Google jako nieprawidłowy link.

Parametry

NazwaTypOpis
urlStringadres URL linku

Zwróć

InlineImage – bieżący obiekt

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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

Zwróć

InlineImage – bieżący obiekt

Autoryzacja

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

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