Configurações Avançadas

Interface

Nesta interface podemos definir o layout de exibição das células, que contém os valores dos campos, no Corpo do Relatório.

Interface de configuração do Layout do PDF.

• Atributos
  • Seq : Número sequencial das células (Ordem Crescente).
  • Célula : Nome da célula.
  • Pos X : Define a abscissa da célula.
  • Pos Y : Define a ordenada da célula.
  • Largura : Define a largura de uma célula.
  • Alinhamento : Nesta caixa de seleção podemos informar o alinhamento da célula.
  • Campo : Informa o campo que será exibido na célula.

Código

A sessão “LayoutPDF - Código” permite ao usuário assumir o código php de criação do PDF

Interface de configuração do Código do PDF.

A aplicação Report PDF foi desenvolvida baseada na classe TCPDF, de forma que você pode utilziar os métodos disponíveis de classe ou uma macro correspondente na tabela abaixo. Para utilizar algum método, deve ser utilizado o objeto $pdf, por exemplo: $pdf->AcceptPageBreak(parametros).

Para acessar a documentação do TCPDF Clique aqui

Macros ReportPDF

sc_pdf_text

Descrição:

Este método permite colocar uma string precisamente na página.

Parâmetros:

y: eixo y
txt: texto
link: URL

Exemplo:

sc_pdf_text("1","1","Your Text Here");

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_write

Descrição:

Este método imprime o texto da posição atual. Quando a margem direita é alcançada (ou o caractere \n é encontrado), ocorre uma quebra de linha e o texto continua a partir da margem esquerda. Ao sair do método, a posição atual é deixada apenas no final do texto. É possível por um link no texto para redirecionamento.

Parâmetros:

h: altura
txt: texto
link: URL

Exemplo:

sc_pdf_write(150,'Your Text Here','https://www.scriptcase.net');

Escopo: Layout PDf > Código > Layout e Corpo

sc_pdf_set_y

Descrição:

Define a posição atual do eixo y.

Parâmetros:

y: valor do eixo y

Exemplo:

sc_pdf_set_y(180,true);

Escopo: Layout PDf > Código > Layout e Corpo

sc_pdf_set_x

Descrição:

Define a posição atual do eixo x.

Parâmetros:

x: valor do eixo x

Exemplo:

sc_pdf_set_x(180);

Escopo: Layout PDf > Código > Layout e Corpo

sc_pdf_set_xy

Descrição:

Define a posição atual do eixo x e do eixo y.

Parâmetros:

x: valor do eixo x
y: valor do eixo y

Exemplo:

sc_pdf_set_x(180,180);

Escopo: Layout PDf > Código > Layout e Corpo

sc_pdf_set_top_margin

Descrição:

Define o topo do margin. Esse método pode ser chamado antes da criação da primeira página.

Parâmetros:

margin: valor da margem

Exemplo:

sc_pdf_set_top_margin(1000);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_right_margin

Descrição:

Define a margem direta. Esse método pode ser chamado antes da criação da primeira página.

Exemplo:

sc_pdf_set_right_margin(1000);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_left_margin

Descrição:

Define a margem esquerda. Esse método pode ser chamado antes da criação da primeira página.

Exemplo:

sc_pdf_set_left_margin(1000);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_margins

Descrição:

Define a margem esquerda, do topo e da direita.

Parâmetros:

left: valor da margem esquerda
top: valor da margem do topo
right: valor da margem direita

Exemplo:

sc_pdf_set_margins(200, 200, 200);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_title

Descrição:

Define o título do documento.

Parâmetro:

título: título do documento

Exemplo:

sc_pdf_set_title("Your Title Here");

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_text_color

Descrição:

Define a cor a ser usada no texto. As cores podem ser passadas através da escala RGB ou a escala cinza. A macro pode ser utilizada antes da criação da primeira página e o valor é de página por página.

Exemplo:

sc_pdf_set_text_color(106,13,173);
sc_pdf_write(150,'Your Text Here','https://www.scriptcase.net');

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_subject

Descrição:

Define o assunto do documento.

Exemplo:

sc_pdf_set_subject("Your Subject here");

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_line_width

Descrição:

Define o cumprimento da linha do pdf.

Parâmetros:

width: a largura da linha

Exemplo:

sc_pdf_set_line_width(1500);
sc_pdf_line(50,25,70,35);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_line

Descrição:

Desenha uma linha entre dois pontos.

Exemplo:

sc_pdf_line(50,25,70,35);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_keywords

Descrição:

Associa palavras-chave com o domcumento. Geralmente em forma de ‘keyword1 keyword2 …’.

Parâmetros:

keywords: lista de palavras-chave

Exemplo:

sc_pdf_set_keywords(test test2, true);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_font

Descrição:

Define o tamanho da fonte atual.

Parâmetros:

family

Fonte a ser definida.

• Courier (fixed-width)
• Helvetica or Arial (synonymous; sans serif)
• Times (serif)
• Symbol (symbolic)
• ZapfDingbats (symbolic)

style

Estilo da fonte a ser definida

• empty string: regular
• B: bold
• I: italic
• U: underline

size

Tamanho da fonte a ser definido

Exemplo:

sc_pdf_set_font('Arial', 'B', 14)

Escopo: Layout PDf > Código > Layout e Corpo

sc_pdf_add_font

Descrição:

Define o qual font será utilizada no texto. É possível passar os parâmetros para font- family, font-style e font-size.

Parâmetros:

family

Fonte a ser definida.

• Courier (fixed-width)
• Helvetica or Arial (synonymous; sans serif)
• Times (serif)
• Symbol (symbolic)
• ZapfDingbats (symbolic)

style

Estilo da fonte a ser definida

• empty string: regular
• B: bold
• I: italic
• U: underline

size

Tamanho da fonte a ser definido

file

O arquivo da fonte

Por padrão, o nome é construído a partir da família e do estilo, em letras minúsculas sem espaço.

Exemplo:

sc_pdf_add_font('Comic', 'I', 'comici.php');

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_close

Descrição:

Define o fechamento do documento pdf. Não é necessário a chamada desse método explicitamente pois o fechamdo do documento é feito automaticamente.

Exemplo:

sc_pdf_close();

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_error

Descrição:

Este métido é automáticamente chamado em caso de um fatal error Ele irá exibir uma mensagem de exceção.

Exemplo:

sc_pdf_error(“Your Text Here”);

Escopo: Layout PDf > Código > Layout e Corpo

sc_pdf_add_page

Descrição:

Adiciona uma nova página ao documento pdf.

Exemplo:

sc_pdf_add_page('Portrait','A4',0);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_footer

Descrição:

Este método é responsável por renderizar o rodapé do documento pdf. O rodapé é automáticamente chamado pelos métodos sc_pdf_add_page() e sc_pdf_close() e não deve ser chamado diretamente na aplicação.

Exemplo:

sc_pdf_footer();

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_header

Descrição:

Este método é responsável por renderizar o cabeçalho do documento pdf. O cabeçalho é automáticamente chamado pelos métodos sc_pdf_add_page() e sc_pdf_close() e não deve ser chamado diretamente na aplicação.

Exemplo:

sc_pdf_header();

Escopo: Layout PDf > Código > Layout e Corpo

sc_pdf_get_string_length

Descrição:

Retorna o cumprimento de uma string.

Exemplo:

sc_pdf_get_string_length("Text To Be Measured");

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_get_y

Descrição:

Retorna a posição atual do eixo y.

Exemplo:

sc_pdf_get_y();

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_get_x

Descrição:

Retorna a posição atual do eixo x.

Exemplo:

sc_pdf_get_x();

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_link

Descrição:

Adiciona o link em uma área retangular da página. Link de texto ou imagem, geralmente é posto via Cel(), Write() ou Image() mas esse método pode ser usado uma área clicável dentro de uma imagem.

Parâmetros:

x : eixo x
y : eixo y
w : largura
h : altura
link : url

Exemplo:

sc_pdf_link(100,100,10,10,'https://scriptcase.com.br');

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_image

Descrição:

Encorpora uma imagem ao documento. O tamanho da imagem pode ser definido de várias formas. Formatos suportados: JPEG, PNG and GIF, a extensão GD deverá estar habilitada para a utilização de GIF

Parâmetros:

link : caminho do arquivo ou url
x : eixo x
y : eixo y
w : largura
h : altura
tipo : formato da imagem

Exemplo:

sc_pdf_image('http://chart.googleapis.com/chart?cht=p3&chd=t:60,40&chs=250x100&chl=HelloWorld', 60, 30, 90, 0,'PNG');

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_author

Descrição:

Define o autor do documento

Exemplo:

sc_pdf_set_author("Scriptcase");

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_auto_page_break

Descrição:

Habilita ou desabilita o modo de quebra automática. Quando habilitado, o segundo parâmetro definirá a distância da parte inferior da página em que será ativada a quebra. Por padrão, o modo está ativado e a margem é de 2cm.

Exemplo:

sc_pdf_set_auto_page_break(true, 10);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_compression

Descrição:

Ativa ou desativa a compactação da página. Quando ativada, a representação interna de cada página é compactada. Por padrão a compactação está ativa.
Nota: a extensão zlib deverá estar ativada, se não estiver essa opção, por padrão, estará desativada.

Exemplo:

sc_pdf_set_compression(true);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_output

Descrição:

Envia o documento para um dado destino: navegador, arquivo ou uma string. No caso do navegador, a visualização do pdf poderá ser usada ou o download poderá ser forçado.

Parâmetros:

• I: Envia o arquivo para o navegador
• D: Envia para o navegador e força o download
• F: Salva em um local específico
• S: Retorna o documento em uma string

Exemplo 1: Salva o documento em um diretório local:

$pdf->Output('F', 'reports/report.pdf');

Exemplo 2: Força o download:

$pdf->Output('D', 'report.pdf');

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_creator

Descrição:

Define o nome do criador do documento. Esse é o nome da aplicação gerada pelo pdf.

Exemplo:

sc_pdf_set_creator(“X Creator”,”true”);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_display_mode

Descrição:

Define a forma como o documento será exibido pelo visualizador.

Parâmetros:

zoom:

• fullpage: exibe a página inteira na tela
• fullwidth: usa a largura máxima da tela
• real: usa o tamanho real(100% do zoom)
• default: usa o modo de visualização padrão

layout:

• single: exibe uma página de cada vez
• continuous: exibe páginas continuamente
• two: exibe duas páginas em duas colunas
• default: usa o modo de visualização padrão

Exemplo:

sc_pdf_set_display_mode("fullpage", "");

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_accept_page_break

Descrição:

Sempre que uma condição de quebra de página é atendida, o método é chamado e a quebra é emitida ou não, dependendo do valor retornado. Este método é chamado automaticamente e não deve ser chamado diretamente pelo aplicativo.

Exemplo:

sc_pdf_accept_page_break();

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_ln

Descrição:

Gera uma quebra de linha. É possível definir a altura da quebra de linha através do parâmetro passado. Esse parâmetro é opcional.

Exemplo:

sc_pdf_ln();

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_rect

Descrição:

Gera um retângulo. Pode ser desenhado (somente com borda), preenchido (sem borda) ou ambos.

Parâmetros:

• x : eixo x
• y : eixo y
• w : largura
• h : altura

Estilo de renderização:

D ou string vazia: Desenha; é o valor padrão. F: Preenche DF ou FD: Desenha e preenche

Exemplo:

sc_pdf_rect($x, $y, $w, $h, 'D');

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_draw_color

Descrição:

Define a cor usada para todas as operações de desenho (linhas, retângulos e bordas de células). Pode ser expresso em componentes RGB ou escala de cinza. O método pode ser chamado antes que a primeira página seja criada e o valor seja retido de página para página.

Exemplo:

sc_pdf_set_draw_color(245, 232, 125);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_fill_color

Descrição:

Define a cor usada para todas as operações de preenchimento (retângulos preenchidos e planos de fundo das células). Pode ser expresso em componentes RGB ou escala de cinza. O método pode ser chamado antes que a primeira página seja criada e o valor seja retido de página para página.

Exemplo:

sc_pdf_set_fill_color(245, 232, 125);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_multi_cell

Descrição:

Define a cor usada para todas as operações de preenchimento (retângulos preenchidos e planos de fundo das células). Pode ser expresso em componentes RGB ou escala de cinza. O método pode ser chamado antes que a primeira página seja criada e o valor seja retido de página para página.

Parâmetros:

• w: largura da célula
• h: Altura da célula
• txt: Texto a ser impresso
• border: Indica se a borda deve ser gerada ao redor da celula.
• align: Define o alinhamento do texto. Possíveis valores são:
  L: alinhamento à esquerda
  C: centero
  R: alinhamento à direita
  J: justification (valor padrão)
  fill: Idica se o background da célula deve ser pintado (true) ou transparente (false). Valor padrão: false.

Exemplo:

_sc_pdf_multi_cell(63, 10, "YourText", 1);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_cell

Descrição:

Imprime uma célula (área retangular) com bordas opcionais, cor de fundo e cadeia de caracteres. O canto superior esquerdo da célula corresponde à posição atual. O texto pode ser alinhado ou centralizado. Após a chamada, a posição atual se move para a direita ou para a próxima linha. É possível colocar um link no texto.

Se a quebra de página automática estiver habilitada e a célula ultrapassar o limite, uma quebra de página será feita antes da saída.

Parâmetros:

• w: largura da célula
• h: Altura da célula
• txt: Texto a ser impresso
• border: Indica se a borda deve ser gerada ao redor da celula.
• align: Define o alinhamento do texto. Possíveis valores são:
  L: alinhamento à esquerda
  C: centero
  R: alinhamento à direita
  fill: Idica se o background da célula deve ser pintado (true) ou transparente (false). Valor padrão: false.
  
• link: URL

Exemplo:

sc_pdf_cell(60, 6, 'Your Text', 0);

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_add_link

Descrição:

Cria um novo link interno e retorna o seu identifcador. Um link interno é uma área clicável na qual te direcional para outra área no documento.

Exemplo:

sc_pdf_add_link();

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_alias_nb_pages

Descrição:

Define um alias para o total de número de páginas. Isso será substituído quando o documento for fechado.

Exemplo:

sc_pdf_cell(0, 10, 'Page','{nb}', 0, 0, 'C')
sc_pdf_alias_nb_pages();

Escopo:

Layout PDf > Código > Layout e Corpo

sc_pdf_set_link

Descrição:

Define a página e a posição para a qual um link aponta.

Exemplo:

sc_pdf_set_link($link);

Escopo:

Layout PDf > Código > Layout e Corpo

Posicionamento

Nesta interface definimos a ordem de exibição dos campos (selecionando através das setas ao lado do quadro direito).

Interface de configuração do posicionamento dos campos do PDF.