Class InlineImage

InlineImage

Element reprezentujący osadzony obraz. Element InlineImage może być zawarty w elemencie ListItem lub Paragraph, chyba że ListItem lub Paragraph znajduje się w FootnoteSection. Element InlineImage nie może zawierać żadnego innego elementu. Dla: więcej informacji o strukturze dokumentów znajdziesz w przewodniku po rozszerzeniach 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 obiekt blob.
getHeight()IntegerPobiera wysokość obrazu w pikselach.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
getWidth()IntegerPobiera szerokość obrazu w pikselach.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()InlineImageScala element z poprzednim elementem potomnym 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 adres URL linku.
setWidth(width)InlineImageUstawia szerokość obrazu w pikselach.

Szczegółowa dokumentacja

copy()

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

Skopiowane są też wszystkie elementy podrzędne zawarte w elemencie. Nowy element nie ma elementu nadrzędnego.

Powrót

InlineImage – nowa wersja,

Autoryzacja

Skrypty korzystające 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 innego tytułu;

Autoryzacja

Skrypty korzystające 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 innego tytułu;

Autoryzacja

Skrypty korzystające 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 wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści. Ten dodaje do nazwy pliku odpowiednie rozszerzenie, na przykład „mojplik.pdf”. Jednak zakłada, że część nazwy pliku, która następuje po ostatnim kropce (jeśli występuje), jest już , które należy zastąpić. W rezultacie „ShoppingList.12.25.2014” zmienia się w „ShoppingList.12.25.pdf”.

Aby wyświetlić dzienne limity konwersji, zobacz Limity dla Google Usługi. Nowo utworzone domeny Google Workspace mogą być tymczasowo bardziej rygorystyczne limity.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME do skonwertowania. W przypadku większości blobów atrybut 'application/pdf' to jedyną prawidłową opcją. W przypadku zdjęć w formacie BMP, GIF, JPEG lub PNG możesz też użyć dowolnego z tych atrybutów: 'image/bmp', 'image/gif', 'image/jpeg' lub 'image/png'. prawidłowe. W przypadku dokumentów w Dokumentach Google prawidłowa jest też wartość 'text/markdown'.

Powrót

Blob – dane w postaci obiektu blob.


getAttributes()

Pobiera atrybuty elementu.

Wynikiem jest obiekt zawierający właściwość każdego prawidłowego atrybutu elementu, nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute.

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]);
}

Powrót

Object – atrybuty elementu.

Autoryzacja

Skrypty korzystające 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()

Zwraca dane wewnątrz tego obiektu jako obiekt blob.

Powrót

Blob – dane w postaci 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 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 kilka wartości tego atrybutu .

Autoryzacja

Skrypty korzystające 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 kolejny element równorzędny elementu.

Następne elementy równorzędne mają tego samego elementu nadrzędnego i następują po bieżącym elemencie.

Powrót

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

Autoryzacja

Skrypty korzystające 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 elementu.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement – element nadrzędny.

Autoryzacja

Skrypty korzystające 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 równorzędny elementu.

Poprzednie elementy nadrzędne mają tego samego elementu nadrzędnego i wyprzedzają bieżący element.

Powrót

Element – poprzedni element równorzędny.

Autoryzacja

Skrypty korzystające 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ść ElementType elementu.

Aby określić dokładny typ danego elementu, użyj właściwości getType().

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.');
}

Powrót

ElementType – typ elementu.

Autoryzacja

Skrypty korzystające 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 korzystające 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 jest na końcu Document.

Powrót

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

Autoryzacja

Skrypty korzystające 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()

Scala element z poprzednim elementem potomnym tego samego typu.

Można scalać tylko elementy o tej samej wartości ElementType. Wszystkie elementy podrzędne zawarte w bieżący element jest przenoszony do poprzedniego elementu równorzędnego.

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

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

Powrót

InlineImage – scalony element.

Autoryzacja

Skrypty korzystające 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 elementu nadrzędnego.

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

Powrót

InlineImage – usunięty element.

Autoryzacja

Skrypty korzystające 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 do pustego ciągu.

Parametry

NazwaTypOpis
descriptionStringalternatywny tytuł

Powrót

InlineImage – bieżący obiekt,

Autoryzacja

Skrypty korzystające 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 alternatywny tytuł obrazu. Jeśli podany tytuł to null, ustawia go na pusty ciąg znaków.

Parametry

NazwaTypOpis
titleStringalternatywny tytuł

Powrót

InlineImage – bieżący obiekt,

Autoryzacja

Skrypty korzystające 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.

Określony parametr atrybutów musi być obiektem, w którym każda nazwa właściwości jest elementem w wyliczenie DocumentApp.Attribute, a każda wartość właściwości jest nową wartością do zastosowano.

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

Parametry

NazwaTypOpis
attributesObjectAtrybuty elementu.

Powrót

InlineImage – bieżący element.

Autoryzacja

Skrypty korzystające 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)

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 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 wyświetlać się jako „Nieprawidłowy link”. w Dokumentach Google.

Parametry

NazwaTypOpis
urlStringadres URL linku

Powrót

InlineImage – bieżący obiekt,

Autoryzacja

Skrypty korzystające 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

NazwaTypOpis
widthIntegerszerokość obrazu w pikselach

Powrót

InlineImage – bieżący obiekt,

Autoryzacja

Skrypty korzystające 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