Um elemento que representa uma nota de rodapé. Cada Footnote
está contido em um List
ou Paragraph
e tem um elemento Footnote
correspondente para o conteúdo da
nota de rodapé. O Footnote
não pode conter nenhum outro elemento. Para mais informações sobre a estrutura de documentos, consulte o guia para estender os Documentos Google.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | Footnote | Retorna uma cópia detalhada e separada do elemento atual. |
get | Object | Recupera os atributos do elemento. |
get | Footnote | Recupera o conteúdo do elemento de nota de rodapé. |
get | Element | Recupera o próximo elemento irmão do elemento. |
get | Container | Recupera o elemento pai do elemento. |
get | Element | Recupera o elemento irmão anterior do elemento. |
get | Element | Recupera o Element do elemento. |
is | Boolean | Determina se o elemento está no final da Document . |
remove | Footnote | Remove o elemento do pai. |
set | Footnote | Define os atributos do elemento. |
Documentação detalhada
copy()
Retorna uma cópia detalhada e separada do elemento atual.
Todos os elementos filhos presentes no elemento também são copiados. O novo elemento não tem um elemento pai.
Retornar
Footnote
: a nova cópia.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Attributes()
Recupera os atributos do elemento.
O resultado é um objeto que contém uma propriedade para cada atributo de elemento válido, em que cada
nome de propriedade corresponde a um item na enumeração Document
.
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]}`); }
Retornar
Object
: os atributos do elemento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Footnote Contents()
Recupera o conteúdo do elemento de nota de rodapé.
Retornar
Footnote
: a seção de notas de rodapé
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Next Sibling()
Recupera o próximo elemento irmão do elemento.
O próximo irmão tem o mesmo pai e segue o elemento atual.
Retornar
Element
: o próximo elemento irmão.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Parent()
Recupera o elemento pai do elemento.
O elemento pai contém o elemento atual.
Retornar
Container
: o elemento pai.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
Recupera o elemento irmão anterior do elemento.
O irmão anterior tem o mesmo pai e precede o elemento atual.
Retornar
Element
: o elemento irmão anterior.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Type()
Recupera o Element
do elemento.
Use get
para determinar o tipo exato de um determinado elemento.
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.'); }
Retornar
Element
: o tipo de elemento.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is At Document End()
Determina se o elemento está no final da Document
.
Retornar
Boolean
: se o elemento está no final da guia.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove From Parent()
Remove o elemento do pai.
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(); }
Retornar
Footnote
: o elemento removido.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Attributes(attributes)
Define os atributos do elemento.
O parâmetro de atributos especificado precisa ser um objeto em que cada nome de propriedade seja um item na
enumeração Document
e cada valor de propriedade seja o novo valor a ser
aplicado.
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);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
attributes | Object | Os atributos do elemento. |
Retornar
Footnote
: o elemento atual.
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents