Class InlineDrawing

Rysowaniew tekście

Element reprezentujący osadzony rysunek. Element InlineDrawing może być zawarty w elemencie ListItem lub Paragraph, chyba że element ListItem lub Paragraph jest zawarty w elemencie FootnoteSection. Element InlineDrawing 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()InlineDrawingZwraca odłączoną, głęboką kopię bieżącego elementu.
getAltDescription()StringZwraca alternatywny opis rysunku.
getAltTitle()StringZwraca alternatywny tytuł rysunku.
getAttributes()ObjectPobiera atrybuty elementu.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()InlineDrawingŁączy element z poprzednim elementem tego samego typu.
removeFromParent()InlineDrawingUsuwa element z jego elementu nadrzędnego.
setAltDescription(description)InlineDrawingUstawia alternatywny opis rysunku.
setAltTitle(title)InlineDrawingUstawia alternatywny tytuł rysunku.
setAttributes(attributes)InlineDrawingUstawia atrybuty elementu.

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

InlineDrawing – 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 rysunku.

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ł rysunku.

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

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

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

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

InlineDrawing – 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

InlineDrawing – 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 rysunku. Jeśli podany tytuł to null, ustawia opis na pusty ciąg znaków.

Parametry

NazwaTypOpis
descriptionStringalternatywny tytuł.

Powrót

InlineDrawing – 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 alternatywny tytuł rysunku. Jeśli podany tytuł to null, ustawia tytuł jako pusty ciąg znaków.

Parametry

NazwaTypOpis
titleStringalternatywny tytuł.

Powrót

InlineDrawing – 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

NazwaTypOpis
attributesObjectatrybuty elementu,

Powrót

InlineDrawing – 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