nginstack

Class: Footer

@nginstack/web-framework/lib/simple-layout/Footer~ Footer

Objeto responsável por montar visualmente o rodapé de visualizações e relatórios.

Members

autoSanitize :boolean

Determina se os textos escritos no rodapé são tratados para remover tags que possam ser utilizadas com o objetivo de injetar scripts maliciosos em ataques do tipo Cross Site Scripting (XSS).

Ao desativar esta propriedade, é de crítica importância que algum tipo de validação ou sanitização seja realizada no conteúdo a ser escrito na tela.

Type:
  • boolean

complement :string

Texto extra a ser exibido no rodapé.

Type:
  • string
Default Value:
  • ''

<nullable> image :number

A chave de uma imagem a ser exibida no rodapé.

Type:
  • number

mustIncludeCssFiles :boolean

Determina se o rodapé deve incluir as tags link ou style, carregando os arquivos CSS.

Type:
  • boolean

showPath :boolean

Indica se o caminho até o relatório ou visualização deve ser exibido.

Type:
  • boolean
Default Value:
  • true

visible :boolean

Indica se o rodapé deve ser exibido.

Type:
  • boolean
Default Value:
  • true

Methods

writeHtml(sender, outputObj [, options])

Escreve o rodapé em formato HTML.

Parameters:
Name Type Argument Description
sender Visualization | SimpleLayout

O relatório cujas informações devem ser impressas no rodapé.
outputObj Object

Objeto de output no qual o texto será escrito.
options Object <optional>

Opções que podem ser passadas para a função, para controlar a forma como o rodapé é montado.

Properties
Name Type Argument Description
colspan number <optional>

A quantidade de colunas sobre o rodapé.
mailObject Email <optional>

Objeto de email no qual o conteúdo do rodapé deve ser escrito.
path string <optional>

O caminho da consulta automatizada ou relatório.

writePlain(outputObj, options)

Escreve o rodapé em um formato de texto plano.

Parameters:
Name Type Description
outputObj Object

Objeto de output no qual o texto será escrito.
options Object

Opções a serem utilizadas na escrita.

Properties
Name Type Description
path string

O caminho da consulta automatizada ou relatório.
leftMargin number

O tamanho da margem esquerda do texto.
calculatedWidth number

A largura calculada do texto.