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


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
Default Value:
  • false

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 [, opt_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.

opt_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é.

css string <optional>

Folha de estilo a ser utilizada pelo rodapé.

mailObject Mail <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.