Célula - Com escopo, Global

Célula - Célula (número rowspan, número colspan)

Instancia um novo Célula objeto. Cria uma célula que usa uma quantidade personalizada de espaços de célula na tabela.

Nota:

Se você fornecer um número negativo para qualquer parâmetro, o valor será definido como 1.

Tabela 1. Parâmetros
Nome	Tipo	Descrição
rowspan	Número	Número de linhas que esta célula deve ocupar. Padrão: 0
colspan	Número	Número de colunas que esta célula deve ocupar. Padrão: 0

O exemplo a seguir mostra como criar um Célula objeto que abrange uma única linha e uma única coluna.

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

AddImage(Image image)

Adiciona uma imagem a uma célula da tabela.

Tabela 2. Parâmetros
Nome	Tipo	Descrição
imagem	Imagem	Imagem a ser adicionada a uma célula da tabela.

Tabela 3. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como instanciar um anexo de imagem existente e adicioná-lo a uma célula em uma tabela. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

var image = new Image("<attachment_sys_id>");

cell.addImage(image);

AddParagraph(parágrafo de parágrafo)

Adiciona texto a uma célula da tabela.

Tabela 4. Parâmetros
Nome	Tipo	Descrição
parágrafo	Parágrafo	Texto a ser adicionado a uma célula da tabela.

Tabela 5. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como instanciar objetos de parágrafo e adicionar as células de conteúdo em uma tabela. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);
var para = new sn_pdfgeneratorutils.Paragraph("Paragraph text.");
cell.addParagraph(para);

AddStyle(estilo de estilo)

Aplica um estilo predefinido às células da tabela.

Tabela 6. Parâmetros
Nome	Tipo	Descrição
estilo	Estilo	Estilo a ser aplicado a este elemento.

Tabela 7. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como aplicar um estilo a uma célula da tabela. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);
var style = new sn_pdfgeneratorutils.Style();
style.setBold();
     
cell.addStyle(style);

AddTable (tabela de tabela)

Adiciona uma tabela a uma célula.

Tabela 8. Parâmetros
Nome	Tipo	Descrição
tabela	Tabela	Tabela a ser adicionada a uma célula.

Tabela 9. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como instanciar um objeto de tabela e adicioná-lo a uma célula. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

var columnWidths = [100, 50, 50];

var table = new Table(columnWidths, false);

cell.addTable(table);

Célula – getColumn()

Obtém o número da coluna na qual a célula está localizada.

Tabela 10. Parâmetros
Nome	Tipo	Descrição
Nenhum

Tabela 11. Retorna
Tipo	Descrição
Número	Número da posição da coluna de uma célula.

O exemplo a seguir mostra como obter o número de uma posição de coluna para uma célula.

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

var columnWidths = [100, 50, 50];

var table = new sn_pdfgeneratorutils.Table(true, columnWidths, false);

table.addCell(cell);

var colNum = cell.getColumn();

gs.info("The column position for cell is " + colNum);

Saída:

The column position for cell is 1

Célula – getRow()

Obtém o número de linhas nas quais a célula está localizada.

Tabela 12. Parâmetros
Nome	Tipo	Descrição
Nenhum

Tabela 13. Retorna
Tipo	Descrição
Número	Número da posição da linha de uma célula.

O exemplo a seguir mostra como obter o número de uma posição de linha para uma célula.

var cell = new sn_pdfgeneratorutils.Cell(1, 1);

var rowWidths = [100, 50, 50];

var table = new sn_pdfgeneratorutils.Table(true, rowWidths, false);

table.addCell(cell);

var rowNum = cell.getRow();

gs.info("The row position for cell is " + rowNum);

Saída:

The row position for cell is 4927

Célula – setBackGroundColor(cor da cor)

Especifica uma cor de fundo para a célula.

Tabela 14. Parâmetros
Nome	Tipo	Descrição
cor	Cor	Cor de fundo.

Tabela 15. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir a cor de fundo da célula. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var color = new sn_pdfgeneratorutils.Color([1, 0.9, 0.9]); // provided as array of RGB float values

cell.setBackGroundColor(color);

SetBorder(largura numérica)

Define uma borda para todas as quatro bordas de uma célula.

Tabela 16. Parâmetros
Nome	Tipo	Descrição
largura	Número	Largura da borda da célula em pontos.

Tabela 17. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula de um ponto para todas as quatro bordas de uma célula. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setBorder(width);

SetBorderBottom(largura numérica)

Define uma borda para o limite inferior de uma célula.

Tabela 18. Parâmetros
Nome	Tipo	Descrição
largura	Número	Largura da borda da célula em pontos.

Tabela 19. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setBorder(width);

SetBorderLeft(largura numérica)

Define uma borda para o limite esquerdo de uma célula.

Tabela 20. Parâmetros
Nome	Tipo	Descrição
largura	Número	Largura da borda da célula em pontos.

Tabela 21. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula do lado esquerdo. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setLeftBorder(width);

SetBorderRight(largura numérica)

Define uma borda para o limite direito de uma célula.

Tabela 22. Parâmetros
Nome	Tipo	Descrição
largura	Número	Largura da borda da célula em pontos.

Tabela 23. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula do lado direito. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setRightBorder(width);

SetBorderTop(largura numérica)

Define uma borda para o limite superior de uma célula.

Tabela 24. Parâmetros
Nome	Tipo	Descrição
largura	Número	Largura da borda da célula em pontos.

Tabela 25. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula superior. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1.0;

cell.setBorderTop(width);

SetColoredOrder(cor, largura numérica)

Define uma borda colorida para todas as quatro bordas de uma célula.

Tabela 26. Parâmetros
Nome	Tipo	Descrição
cor	Cor	Cor da borda da célula.
largura	Número	Largura da borda da célula em pontos.

Tabela 27. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula colorida. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorder(borderColor, width);

SeColoredBorderBottom (cor, largura numérica)

Define uma borda colorida para o limite inferior de uma célula.

Tabela 28. Parâmetros
Nome	Tipo	Descrição
cor	Cor	Cor da borda da célula.
largura	Número	Largura da borda da célula em pontos.

Tabela 29. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula inferior colorida. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorderBottom(borderColor, width);

SetColoredBorderLeft(Cor, largura numérica)

Define uma borda colorida para o limite esquerdo de uma célula.

Tabela 30. Parâmetros
Nome	Tipo	Descrição
cor	Cor	Cor da borda da célula.
largura	Número	Largura da borda da célula em pontos.

Tabela 31. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula esquerda colorida. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorderLeft(borderColor, width);

SeColoredBorderRight(Cor, largura do número)

Define uma borda colorida para o limite direito de uma célula.

Tabela 32. Parâmetros
Nome	Tipo	Descrição
cor	Cor	Cor da borda da célula.
largura	Número	Largura da borda da célula em pontos.

Tabela 33. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula direita colorida. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorderRight(borderColor, width);

SetColoredBorderTop (Cor, largura numérica)

Define uma borda colorida para o limite superior de uma célula.

Tabela 34. Parâmetros
Nome	Tipo	Descrição
cor	Cor	Cor da borda da célula.
largura	Número	Largura da borda da célula em pontos.

Tabela 35. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma borda de célula superior colorida. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var width = 1.0;

cell.setColoredBorderTop(borderColor, width);

SetHeight(altura numérica)

Define a altura de uma célula.

Tabela 36. Parâmetros
Nome	Tipo	Descrição
valor	Número	Altura da célula em pontos.

Tabela 37. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma altura de célula de 10 pontos. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var height = 10;

cell.setHeight(height);

SetHorizontalAlignment(alinhamento de cadeia de caracteres)

Define o alinhamento horizontal desta célula.

Tabela 38. Parâmetros
Nome	Tipo	Descrição
alinhamento	Cadeia de caracteres	Configuração de alinhamento horizontal. Valores válidos: Centro: Alinha o conteúdo ao centro. À esquerda: Alinha o conteúdo à esquerda. À direita: Alinha o conteúdo à direita.

Tabela 39. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o alinhamento horizontal em uma célula. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var alignment = "center";

cell.setHorizontalAlignment(alignment);

SetMaxHeight(valor numérico)

Define a altura máxima de uma célula.

Tabela 40. Parâmetros
Nome	Tipo	Descrição
valor	Número	Altura máxima da célula em pontos.

Tabela 41. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma altura máxima da célula de 409 pontos. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var height = 409;

cell.setMaxHeight(height);

SetMaxWidth (valor flutuante)

Define a largura máxima de uma célula.

Tabela 42. Parâmetros
Nome	Tipo	Descrição
valor	Número	Largura máxima da célula em pontos.

Tabela 43. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma largura máxima de célula de 1530 pontos. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 1530;

cell.setMaxWidth(width);

SetMinHeight(valor numérico)

Define a altura mínima de uma célula.

Tabela 44. Parâmetros
Nome	Tipo	Descrição
valor	Número	Altura mínima da célula em pontos.

Tabela 45. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma altura mínima da célula de 12,75 pontos. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var height = 12.75;

cell.setMinHeight(height);

SetMinWidth(valor numérico)

Define a largura mínima de uma célula.

Tabela 46. Parâmetros
Nome	Tipo	Descrição
valor	Número	Largura mínima da célula em pontos.

Tabela 47. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir uma largura mínima de célula de 50,58 pontos. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var width = 50.58;

cell.setMinWidth(width);

SetOpacity (opacidade numérica)

Define a opacidade do conteúdo da célula, bordas e plano de fundo.

Nota:

Esta configuração afeta todos os elementos secundários da célula.

Tabela 48. Parâmetros
Nome	Tipo	Descrição
opacidade	Número	Valor decimal flutuante de 0 a 1, no qual 0 é transparente e 1 é totalmente opaco. Padrão: 0

Tabela 49. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir a opacidade de uma célula.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var opacity = 0.5;

cell.setOpacity(opacity);

SetPadding (preenchimento numérico)

Define o preenchimento de todos os quatro lados de uma célula com a mesma largura.

Consulte também:

Tabela 50. Parâmetros
Nome	Tipo	Descrição
preenchimento	Número	Largura de preenchimento em pontos como um valor decimal.

Tabela 51. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir a célula inferior como um ponto. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPadding(padding);

Célula – setPaddingBottom(preenchimento numérico)

Define o valor da largura de preenchimento inferior de uma célula.

Consulte também:

Tabela 52. Parâmetros
Nome	Tipo	Descrição
preenchimento	Número	Largura de preenchimento em pontos como um valor decimal.

Tabela 53. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o preenchimento da célula inferior como um ponto. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPaddingBottom(padding);

Célula – setPaddingLeft(preenchimento numérico)

Define o valor da largura de preenchimento esquerdo de uma célula.

Consulte também:

Tabela 54. Parâmetros
Nome	Tipo	Descrição
preenchimento	Número	Largura de preenchimento em pontos como um valor decimal.

Tabela 55. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o preenchimento da célula esquerda como um ponto. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPaddingLeft(padding);

Célula – setPaddingRight (preenchimento de número)

Define o valor da largura de preenchimento direita de uma célula.

Consulte também:

Tabela 56. Parâmetros
Nome	Tipo	Descrição
preenchimento	Número	Largura de preenchimento em pontos como um valor decimal.

Tabela 57. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o preenchimento da célula direita como um ponto. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPaddingRight(padding);

Célula – setPaddingTop (preenchimento numérico)

Define o valor da largura de preenchimento superior de uma célula.

Consulte também:

Tabela 58. Parâmetros
Nome	Tipo	Descrição
preenchimento	Número	Largura de preenchimento em pontos como um valor decimal.

Tabela 59. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o preenchimento da célula superior como um ponto. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var padding = 1.0;

cell.setPaddingTop(padding);

SetTextAlignment(alinhamento de cadeia de caracteres)

Define o alinhamento de texto desta célula.

Tabela 60. Parâmetros
Nome	Tipo	Descrição
alinhamento	Cadeia de caracteres	Posição de alinhamento do texto. Valores válidos: Text-center: Alinha o texto ao centro. Texto justificado: Modifica o espaço entre caracteres para preencher completamente o texto entre os lados esquerdo e direito. A linha final é alinhada à esquerda. Text-justified-all: Justifica o alinhamento do texto, incluindo a linha final. Text-left: Alinha o texto à esquerda. Text-right: Alinha o texto à direita.

Tabela 61. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o texto da célula para alinhamento à esquerda.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var alignment = "text-left";

cell.setTextAlignment(alignment);

SetVerticalAlignment(alinhamento de cadeia de caracteres)

Define o alinhamento vertical desta célula.

Tabela 62. Parâmetros
Nome	Tipo	Descrição
alinhamento	Cadeia de caracteres	Configuração de alinhamento vertical. Valores válidos: Inferior: Alinha o conteúdo à parte inferior. Mid: Alinha o conteúdo ao centro. Superior: Alinha o conteúdo à parte superior.

Tabela 63. Retornos
Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como definir o alinhamento vertical em uma célula. Para obter um exemplo de uso de documento, consulte Documento API.

var cell = new sn_pdfgeneratorutils.Cell(1, 3);

var alignment = "mid";

cell.setVerticalAlignment(alignment);