テーブル - スコープ対象、グローバル

Yokohama API リファレンス

Release

yokohama

ft:locale

ja-JP

ft:publication_title

Yokohama API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

テーブル - スコープ対象、グローバル

リリースバージョン: Yokohama

更新日 2025年01月30日

所要時間：47分

PDF ドキュメントに追加するテーブルオブジェクトを作成します。各セルで使用するデータを定義し、スタイル、余白、配置を設定します。

この API は ServiceNow PDF 生成ユーティリティプラグイン (com.snc.apppdfgenerator) の一部であり、 sn_pdfgeneratorutils 名前空間内で提供されます。このプラグインはデフォルトでアクティブ化されています。

この API は、PDF を生成するためにドキュメント API で使用されるコンポーネントです。

このクラスのメソッドを使用して Table オブジェクトを構築します。次の追加クラスを使用して、セル、段落、およびスタイルをテーブルに追加できます。

セル API

セル API を使用してセルを作成します。次に、次のいずれかの方法を使用して、セルをテーブルに追加します。

Table.addCell()
Table.addCellWithStyle()
Table.addHeaderCell()
Table.addImageCell()
Table.addParagraphCell()
Table.addTextCell()

パラグラフ API

段落 API を使用して段落を作成します。Cell.addParagraph() を使用して、テーブル内のセルに段落を追加します。

スタイル API

スタイル API を使用して、スタイル、色、および境界線を設定します。次のいずれかの方法を使用して、スタイルをテーブルに追加します。

Table.setDefaultStyle()
Table.setHeaderStyle()

その後、次のクラスとメソッドを使用して、Table オブジェクトを PDF ドキュメントに適用できます。

Document API: Document.addTable() メソッドを使用して、テーブルを PDF ドキュメントに追加します。Document.saveAsAttachment() メソッドを使用して、ドキュメントをレコードに添付できます。

Table - Table(ブール値 ltr, アレイ columnWidths, ブール値 largeTable)

テキストの方向、列幅、およびレイアウト設定を使用して、新しい Table オブジェクトをインスタンス化します。

表 : 1. パラメーター
名前	タイプ	説明
ltr	ブール	テーブル内の言語のテキストの向きを示すフラグ。詳細については、「 W3C:スクリプトの方向と言語」を参照してください。有効な値： true:テキストの向きは左から右です。 false:テキストの向きは右から左です。
columnWidth	アレイ	テーブル内の各列の幅を指定する数値。サイズは比例ベースです。たとえば、 `var columnWidths = [2, 1, 1];` は、最初の列が他の 2 列の 2 倍の大きさを持つ 3 列のテーブルです。デフォルト:各列の幅は同じです。
largeTable	ブール	100% 幅と固定レイアウトが暗黙的に設定されているかどうかを示すフラグ。有効な値： true:テーブルは固定レイアウトで 100% の幅を使用します。true の場合、すべてのコンテンツが追加されたときに complete() メソッドを使用して、テーブルが完了したことを示します。 false:自動テーブルサイズ。デフォルト値：false

次の例は、2 列の Table オブジェクトを作成する方法を示しています。

var table = new sn_pdfgeneratorutils.Table(true, [70,200], false);

テーブル – addCell(Cell cell)

テーブルにセル要素を追加します。

表 : 2. パラメーター
名前	タイプ	説明
セル	セル	テーブルに追加するセル要素。

表 : 3. 戻り値
タイプ	説明
なし

この例では、インシデントテーブルからテーブルオブジェクトを作成し、各行に番号と簡単な説明のセルを追加する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
var whiteColor =  sn_pdfgeneratorutils.Color([1,1,1]);
var greyColor =  sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var headerBgColor = new sn_pdfgeneratorutils.Color([0.4,0.6,0.8]);
 
// Query Incident
var gr = new GlideRecord("incident");
gr.query();
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [70,200], false);
 
var headerStyle = new sn_pdfgeneratorutils.Style;
headerStyle.setBackgroundColor(headerBgColor);
headerStyle.setTextAlignment("text-center");
headerStyle.setBold();
headerStyle.setFontColor(whiteColor);
 
table.setHeaderStyle(headerStyle);
 
var nParagraph = new sn_pdfgeneratorutils.Paragraph("Number");
var sParagraph = new sn_pdfgeneratorutils.Paragraph("Short Description");
 
var hdrCell1 = new sn_pdfgeneratorutils.Cell;
var hdrCell2 = new sn_pdfgeneratorutils.Cell;
 
hdrCell1.addParagraph(nParagraph);
hdrCell2.addParagraph(sParagraph);
 
table.addHeaderCell(hdrCell1);
table.addHeaderCell(hdrCell2);
 
var row = 0;
 
while(gr.next()) {
   var numCell = new sn_pdfgeneratorutils.Cell;
   var sdCell = new sn_pdfgeneratorutils.Cell;
 
   var numberParagraph = new sn_pdfgeneratorutils.Paragraph(gr.number);
   var sdParagraph = new sn_pdfgeneratorutils.Paragraph(gr.short_description);
  
   numCell.addParagraph(numberParagraph);
   sdCell.addParagraph(sdParagraph);
 
   if (row % 2 == 1) {
      table.setDefaultbackGroundColor(greyColor);
   } else {
      table.setDefaultbackGroundColor(whiteColor);
   }
 
   table.addCell(numCell);
   table.addCell(sdCell);
 
   row = row + 1;
 
}
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – addCellWithStyle(セルセル、スタイルスタイル)

スタイルが適用されたセル要素をテーブルに追加します。

表 : 4. パラメーター
名前	タイプ	説明
セル	セル	テーブルに追加するセルオブジェクト。
style	スタイル	セルに適用するスタイル。

表 : 5. 戻り値
タイプ	説明
なし

この例では、指定したセルオブジェクトにスタイルを適用し、ドキュメントを添付ファイルとしてレコードに保存する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
var whiteColor =  sn_pdfgeneratorutils.Color([1,1,1]);
var greyColor =  sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var cellBgColor = new sn_pdfgeneratorutils.Color([0.4,0.6,0.8]);
 
// Query Incident
var gr = new GlideRecord("incident");
gr.query();
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [70,200], false);
 
var cellStyle = new sn_pdfgeneratorutils.Style;
cellStyle.setBackgroundColor(cellBgColor);
cellStyle.setTextAlignment("text-center");
cellStyle.setBold();
cellStyle.setFontColor(whiteColor);
 
var nParagraph = new sn_pdfgeneratorutils.Paragraph("Number");
var sParagraph = new sn_pdfgeneratorutils.Paragraph("Short Description");
 
var hdrCell1 = new sn_pdfgeneratorutils.Cell;
var hdrCell2 = new sn_pdfgeneratorutils.Cell;
 
hdrCell1.addParagraph(nParagraph);
hdrCell2.addParagraph(sParagraph);
 
table.addHeaderCell(hdrCell1);
table.addHeaderCell(hdrCell2);
 
var row = 0;
 
while(gr.next()) {
   var numCell = new sn_pdfgeneratorutils.Cell;
   var sdCell = new sn_pdfgeneratorutils.Cell;
 
   var numberParagraph = new sn_pdfgeneratorutils.Paragraph(gr.number);
   var sdParagraph = new sn_pdfgeneratorutils.Paragraph(gr.short_description);
  
   numCell.addParagraph(numberParagraph);
   sdCell.addParagraph(sdParagraph);
 
   if (row % 2 == 1) {
      table.setDefaultbackGroundColor(greyColor);
   } else {
      table.setDefaultbackGroundColor(whiteColor);
   }
 
   table.addCellWithStyle(numCell, cellStyle);
   table.addCell(sdCell);
 
   row = row + 1;
 
}
 
document.addTable(table);
document.saveAsAttachment("incident", "sys_id", "filename.pdf");

テーブル – addHeaderCell(セルセル)

ヘッダーセルオブジェクトをテーブルに追加します。

表 : 6. パラメーター
名前	タイプ	説明
セル	セル	テーブルに追加するヘッダーセル。

表 : 7. 戻り値
タイプ	説明
なし

この例では、Paragraph オブジェクトを含むテーブルにヘッダーセルを追加する方法を示します。Paragraph オブジェクトの詳細については、 Paragraph API を参照してください。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
var whiteColor =  sn_pdfgeneratorutils.Color([1,1,1]);
var greyColor =  sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var headerBgColor = new sn_pdfgeneratorutils.Color([0.4,0.6,0.8]);
 
// Query Incident
var gr = new GlideRecord("incident");
gr.query();
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [70,200], false);
 
var headerStyle = new sn_pdfgeneratorutils.Style;
headerStyle.setBackgroundColor(headerBgColor);
headerStyle.setTextAlignment("text-center");
headerStyle.setBold();
headerStyle.setFontColor(whiteColor);
 
table.setHeaderStyle(headerStyle);
 
var nParagraph = new sn_pdfgeneratorutils.Paragraph("Number");
var sParagraph = new sn_pdfgeneratorutils.Paragraph("Short Description");
 
var hdrCell1 = new sn_pdfgeneratorutils.Cell;
var hdrCell2 = new sn_pdfgeneratorutils.Cell;
 
hdrCell1.addParagraph(nParagraph);
hdrCell2.addParagraph(sParagraph);
 
table.addHeaderCell(hdrCell1);
table.addHeaderCell(hdrCell2);
 
var row = 0;
 
while(gr.next()) {
   var numCell = new sn_pdfgeneratorutils.Cell;
   var sdCell = new sn_pdfgeneratorutils.Cell;
 
   var numberParagraph = new sn_pdfgeneratorutils.Paragraph(gr.number);
   var sdParagraph = new sn_pdfgeneratorutils.Paragraph(gr.short_description);
  
   numCell.addParagraph(numberParagraph);
   sdCell.addParagraph(sdParagraph);
 
   if (row % 2 == 1) {
      table.setDefaultbackGroundColor(greyColor);
   } else {
      table.setDefaultbackGroundColor(whiteColor);
   }
 
   table.addCell(numCell);
   table.addCell(sdCell);
 
   row = row + 1;
 
}
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – addImageCell(画像画像)

画像を含むセルをテーブルに追加します。

表 : 8. パラメーター
名前	タイプ	説明
イメージ	画像	セルに追加する画像オブジェクト。

表 : 9. 戻り値
タイプ	説明
なし

この例では、2 つの画像セルを含むテーブルを作成し、そのドキュメントをレコードに添付する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [70,200], false);
 
var icon = new sn_pdfgeneratorutils.Image("<sys_id>");
var picture = new sn_pdfgeneratorutils.Image("<sys_id>");
 
table.addImageCell(icon);
table.addImageCell(picture);
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – addParagraphCell(段落 p)

段落を含むセルをテーブルに追加します。

表 : 10. パラメーター
名前	タイプ	説明
p	パラグラフ	セルに追加する段落オブジェクト。

表 : 11. 戻り値
タイプ	説明
なし

この例では、段落の内容を含む単一のセルを持つテーブルを作成する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
var paragraph = new sn_pdfgeneratorutils.Paragraph("Content to add to the cell");
 
table.addParagraphCell(paragraph);
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – addTextCell(文字列テキスト)

文字列を含むセルをテーブルに追加します。

表 : 12. パラメーター
名前	タイプ	説明
テキスト	文字列	セルに追加するテキスト。

表 : 13. 戻り値
タイプ	説明
なし

この例では、文字列を含む単一のセルを持つテーブルを作成する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
 
document.addTable(table);
document.saveAsAttachment("incident", "record_sys_id", "filename.pdf");

テーブル – complete()

意図したすべてのコンテンツが大きなテーブルに追加されたことを示します。

Table.flush() メソッドとともに使用して、すでにドキュメントに追加されているテーブルにコンテンツを追加します。このメソッドは、コンストラクターの largeTable パラメーターが true に設定されている場合にのみ適用されます。

表 : 14. パラメーター
名前	タイプ	説明
なし

表 : 15. 戻り値
タイプ	説明
なし

この例は、ドキュメントに既に追加されているテーブルへのコンテンツの追加が完了したことを示す方法を示しています。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
var whiteColor =  sn_pdfgeneratorutils.Color([1,1,1]);
var greyColor =  sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var headerBgColor = new sn_pdfgeneratorutils.Color([0.4,0.6,0.8]);
 
// Query Incident
var gr = new GlideRecord("incident");
gr.query();
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1,2,1,1], true);
 
var headerStyle = new sn_pdfgeneratorutils.Style;
headerStyle.setBackgroundColor(headerBgColor);
headerStyle.setTextAlignment("text-center");
headerStyle.setBold();
headerStyle.setFontColor(whiteColor);
 
table.setHeaderStyle(headerStyle);
 
var numberParagraph = new sn_pdfgeneratorutils.Paragraph("Number");
var descParagraph = new sn_pdfgeneratorutils.Paragraph("Short Description");
var stateParagraph = new sn_pdfgeneratorutils.Paragraph("State");
var assignedParagraph = new sn_pdfgeneratorutils.Paragraph("Assigned to");

 
var hdrCell1 = new sn_pdfgeneratorutils.Cell;
var hdrCell2 = new sn_pdfgeneratorutils.Cell;
var hdrCell3 = new sn_pdfgeneratorutils.Cell;
var hdrCell4 = new sn_pdfgeneratorutils.Cell;
 
hdrCell1.addParagraph(numberParagraph);
hdrCell2.addParagraph(descParagraph);
hdrCell3.addParagraph(stateParagraph);
hdrCell4.addParagraph(assignedParagraph);
 
table.addHeaderCell(hdrCell1);
table.addHeaderCell(hdrCell2);
table.addHeaderCell(hdrCell3);
table.addHeaderCell(hdrCell4);

var row = 0;
 
while(gr.next()) {
   var numCell = new sn_pdfgeneratorutils.Cell;
   var sdCell = new sn_pdfgeneratorutils.Cell;
   var stateCell = new sn_pdfgeneratorutils.Cell;
   var assignedCell = new sn_pdfgeneratorutils.Cell;

 
   var numberParagraph = new sn_pdfgeneratorutils.Paragraph(gr.number);
   var sdParagraph = new sn_pdfgeneratorutils.Paragraph(gr.short_description);
   var stateParagraph = new sn_pdfgeneratorutils.Paragraph(gr.state);
   var assignedParagraph = new sn_pdfgeneratorutils.Paragraph(gr.assigned_to);
  
   numCell.addParagraph(numberParagraph);
   sdCell.addParagraph(sdParagraph);
   stateCell.addParagraph(stateParagraph);
   assignedCell.addParagraph(assignedParagraph);

 
   if (row % 2 == 1) {
      table.setDefaultbackGroundColor(greyColor);
   } else {
      table.setDefaultbackGroundColor(whiteColor);
   }
 
   table.addCell(numCell);
   table.addCell(sdCell);
   table.addCell(stateCell);
   table.addCell(assignedCell);
 
   row = row + 1;
 
}

document.addTable(table);
table.addTextCell("A cell added later");
table.flush();
table.complete();
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – donotSplitRowOnPageBreak(ブール値)

可能な場合は、行が 2 ページにまたがって分割されないようにします。

表 : 16. パラメーター
名前	タイプ	説明
値	ブール	行を 2 ページに分割するか、行全体を 2 ページ目に移動するかを示すフラグ。ただし、行が複数のページにまたがる場合は、このプロパティは適用されません。有効な値： true:ページの残りの部分が行に対して十分な大きさでない場合は、行全体を新しいページに追加します。 false:ページの残りの部分が行に対して十分な大きさでない場合、行を 2 ページに分割します。デフォルト値：false

表 : 17. 戻り値
タイプ	説明
なし

この例では、行が 2 ページにまたがって分割されないようにする方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [25,25,25,75,400], false);
 
table.addTextCell("Text to add to the cell");
table.addTextCell("More text to add to the cell");
table.addTextCell("Even more text to add to the cell");
table.addTextCell("Even more text to add to the cell");
table.addTextCell("Even more text to add to the cell");

table.donotSplitRowOnPageBreak(true);
 
document.addTable(table);
document.saveAsAttachment("incident", "record_sys_id", "filename.pdf");

テーブル – flush()

既にドキュメントに追加されているテーブルにコンテンツを追加します。

Table.complete() メソッドとともに使用して、すべての追加コンテンツをテーブルに追加したことを示します。このメソッドは、コンストラクターの largeTable パラメーターが true に設定されている場合にのみ適用されます。

表 : 18. パラメーター
名前	タイプ	説明
なし

表 : 19. 戻り値
タイプ	説明
なし

この例では、ドキュメントに既に追加されているテーブルにテキストセルを追加する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
var whiteColor =  sn_pdfgeneratorutils.Color([1,1,1]);
var greyColor =  sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var headerBgColor = new sn_pdfgeneratorutils.Color([0.4,0.6,0.8]);
 
// Query Incident
var gr = new GlideRecord("incident");
gr.query();
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1,2,1,1], true);
 
var headerStyle = new sn_pdfgeneratorutils.Style;
headerStyle.setBackgroundColor(headerBgColor);
headerStyle.setTextAlignment("text-center");
headerStyle.setBold();
headerStyle.setFontColor(whiteColor);
 
table.setHeaderStyle(headerStyle);
 
var numberParagraph = new sn_pdfgeneratorutils.Paragraph("Number");
var descParagraph = new sn_pdfgeneratorutils.Paragraph("Short Description");
var stateParagraph = new sn_pdfgeneratorutils.Paragraph("State");
var assignedParagraph = new sn_pdfgeneratorutils.Paragraph("Assigned to");

 
var hdrCell1 = new sn_pdfgeneratorutils.Cell;
var hdrCell2 = new sn_pdfgeneratorutils.Cell;
var hdrCell3 = new sn_pdfgeneratorutils.Cell;
var hdrCell4 = new sn_pdfgeneratorutils.Cell;
 
hdrCell1.addParagraph(numberParagraph);
hdrCell2.addParagraph(descParagraph);
hdrCell3.addParagraph(stateParagraph);
hdrCell4.addParagraph(assignedParagraph);
 
table.addHeaderCell(hdrCell1);
table.addHeaderCell(hdrCell2);
table.addHeaderCell(hdrCell3);
table.addHeaderCell(hdrCell4);

var row = 0;
 
while(gr.next()) {
   var numCell = new sn_pdfgeneratorutils.Cell;
   var sdCell = new sn_pdfgeneratorutils.Cell;
   var stateCell = new sn_pdfgeneratorutils.Cell;
   var assignedCell = new sn_pdfgeneratorutils.Cell;

 
   var numberParagraph = new sn_pdfgeneratorutils.Paragraph(gr.number);
   var sdParagraph = new sn_pdfgeneratorutils.Paragraph(gr.short_description);
   var stateParagraph = new sn_pdfgeneratorutils.Paragraph(gr.state);
   var assignedParagraph = new sn_pdfgeneratorutils.Paragraph(gr.assigned_to);
  
   numCell.addParagraph(numberParagraph);
   sdCell.addParagraph(sdParagraph);
   stateCell.addParagraph(stateParagraph);
   assignedCell.addParagraph(assignedParagraph);

 
   if (row % 2 == 1) {
      table.setDefaultbackGroundColor(greyColor);
   } else {
      table.setDefaultbackGroundColor(whiteColor);
   }
 
   table.addCell(numCell);
   table.addCell(sdCell);
   table.addCell(stateCell);
   table.addCell(assignedCell);
 
   row = row + 1;
 
}

document.addTable(table);
table.addTextCell("A cell added later");
table.flush();
table.complete();
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – getDefaultStyle()

デフォルトのスタイルを返します。

表 : 20. パラメーター
名前	タイプ	説明
なし

表 : 21. 戻り値
タイプ	説明
スタイル	デフォルトのスタイル。

この例では、デフォルトスタイルを設定してから返す方法を示します。

var table = new sn_pdfgeneratorutils.Table(true, [1], false);

var style = new sn_pdfgeneratorutils.Style();

style.setItalic();

table.setDefaultStyle(style);
 
table.addTextCell("Text to add to the cell");

var defaultStyle = table.getDefaultStyle();

gs.info(defaultStyle);

テーブル – getHeaderStyle()

テーブルのヘッダーに適用されたスタイルを返します。

表 : 22. パラメーター
名前	タイプ	説明
なし

表 : 23. 戻り値
タイプ	説明
スタイル	テーブルのヘッダーに適用されるスタイル。

この例では、テーブルのヘッダースタイルを設定して返す方法を示します。

var table = new sn_pdfgeneratorutils.Table(true, [1,1], false);

var whiteColor =  sn_pdfgeneratorutils.Color([1,1,1]);
var headerBgColor = new sn_pdfgeneratorutils.Color([0.4,0.6,0.8]);

var headerStyle = new sn_pdfgeneratorutils.Style;
headerStyle.setBackgroundColor(headerBgColor);
headerStyle.setTextAlignment("text-center");
headerStyle.setBold();
headerStyle.setFontColor(whiteColor);
 
table.setHeaderStyle(headerStyle);

var hdrCell1 = new sn_pdfgeneratorutils.Cell;
var hdrCell2 = new sn_pdfgeneratorutils.Cell;
 
table.addHeaderCell(hdrCell1);
table.addHeaderCell(hdrCell2);

var styleObject = table.getHeaderStyle();

gs.info(styleObject);

テーブル – setBorder(数値幅)

テーブルの外縁の周囲に指定された幅の境界線を設定します。

表 : 24. パラメーター
名前	タイプ	説明
幅	番号	境界線の幅。単位:ポイント

表 : 25. 戻り値
タイプ	説明
なし

この例では、2 ピクセルの境界線を持つテーブルを作成し、そのテーブルをレコードに添付する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
table.setBorder(2);
 
document.addTable(table);
"document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – setDefaultbackGroundColor(色の色)

テーブルのデフォルトの背景色を設定します。

表 : 26. パラメーター
名前	タイプ	説明
色	色	テーブルのデフォルトの背景色として使用される Color オブジェクト。

表 : 27. 戻り値
タイプ	説明
なし

この例では、テーブルのデフォルトの背景色を設定する方法を示します。

// declare table by providing width array with automatic table size
var table = new sn_pdfgeneratorutils.Table(true, [1], false);

var color = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

table.setDefaultbackGroundColor(color);
 
table.addTextCell("Text to add to the cell");

テーブル – setDefaultStyle(Style defaultStyle)

テーブルに適用するデフォルトのスタイルを設定します。

表 : 28. パラメーター
名前	タイプ	説明
デフォルトスタイル	スタイル	テーブルに適用するデフォルトのスタイル。

表 : 29. 戻り値
タイプ	説明
なし

この例では、デフォルトスタイルをテーブルに適用する方法を示します。

var table = new sn_pdfgeneratorutils.Table(true, [1], false);

var style = new sn_pdfgeneratorutils.Style();

style.setItalic();

table.setDefaultStyle(style);
 
table.addTextCell("Text to add to the cell");

var defaultStyle = table.getDefaultStyle();

gs.info(defaultStyle);

テーブル – setFixedPosition(Number pageNumber, Number left, Number bottom, Number width)

テーブルをページ上の固定位置に設定します。

表 : 30. パラメーター
名前	タイプ	説明
pageNumber	番号	テーブルを追加するページ番号。
左	番号	テーブルを追加する左マージンからのピクセル数。単位:ポイント
下	番号	テーブルを追加する下マージンからのピクセル数。単位:ポイント
幅	番号	テーブルの幅。単位:ポイント

表 : 31. 戻り値
タイプ	説明
なし

この例では、ページの左下隅にテーブルの位置を変更する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
table.setFixedPosition(1,36,36,500);
 
document.addTable(table);
"document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – setHeaderStyle(Style headerStyle)

テーブルのヘッダーに適用するスタイルオブジェクトを設定します。

表 : 32. パラメーター
名前	タイプ	説明
ヘッダースタイル	スタイル	テーブルのヘッダーに適用するスタイルオブジェクト。

表 : 33. 戻り値
タイプ	説明
なし

この例では、テーブルのヘッダースタイルを設定して返す方法を示します。

var table = new sn_pdfgeneratorutils.Table(true, [1,1], false);

var whiteColor =  sn_pdfgeneratorutils.Color([1,1,1]);
var headerBgColor = new sn_pdfgeneratorutils.Color([0.4,0.6,0.8]);

var headerStyle = new sn_pdfgeneratorutils.Style;
headerStyle.setBackgroundColor(headerBgColor);
headerStyle.setTextAlignment("text-center");
headerStyle.setBold();
headerStyle.setFontColor(whiteColor);
 
table.setHeaderStyle(headerStyle);

var hdrCell1 = new sn_pdfgeneratorutils.Cell;
var hdrCell2 = new sn_pdfgeneratorutils.Cell;
 
table.addHeaderCell(hdrCell1);
table.addHeaderCell(hdrCell2);

var styleObject = table.getHeaderStyle();

gs.info(styleObject);

テーブル:setHorizontalAlignment(文字列アライメント)

テーブルの水平配置を設定します。

表 : 34. パラメーター
名前	タイプ	説明
位置調整	文字列	テーブルの配置。有効な値：中央:コンテンツを中央に揃えます。 left:コンテンツを左揃えにします。右:コンテンツを右揃えします。

表 : 35. 戻り値
タイプ	説明
なし

この例では、ページの中央に配置された小さなテーブルを作成する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
table.setWidth(90);
table.setHorizontalAlignment("center");
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – setMargin(数値余白)

テーブルの周囲のすべての余白を同じ幅に設定します。

表 : 36. パラメーター
名前	タイプ	説明
余白	番号	上、右、下、および左マージンの値 (ポイント単位)。

表 : 37. 戻り値
タイプ	説明
なし

この例では、テーブル全体のマージンを設定する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
table.setMargin(3);
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – setMarginBottom(数値マージン)

ページの下部のマージンを設定します。

表 : 38. パラメーター
名前	タイプ	説明
余白	番号	下マージンの高さ (ポイント単位)。

表 : 39. 戻り値
タイプ	説明
なし

この例では、ページ下部の余白を 3 ポイントに設定する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
var whiteColor =  sn_pdfgeneratorutils.Color([1,1,1]);
var greyColor =  sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
var headerBgColor = new sn_pdfgeneratorutils.Color([0.4,0.6,0.8]);
 
// Query Incident
var gr = new GlideRecord("incident");
gr.query();
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [70,200], false);
 
var headerStyle = new sn_pdfgeneratorutils.Style;
headerStyle.setBackgroundColor(headerBgColor);
headerStyle.setTextAlignment("text-center");
headerStyle.setBold();
headerStyle.setFontColor(whiteColor);
 
table.setHeaderStyle(headerStyle);
 
var nParagraph = new sn_pdfgeneratorutils.Paragraph("Number");
var sParagraph = new sn_pdfgeneratorutils.Paragraph("Short Description");
 
var hdrCell1 = new sn_pdfgeneratorutils.Cell;
var hdrCell2 = new sn_pdfgeneratorutils.Cell;
 
hdrCell1.addParagraph(nParagraph);
hdrCell2.addParagraph(sParagraph);
 
table.addHeaderCell(hdrCell1);
table.addHeaderCell(hdrCell2);

// set the bottom margin to three points
table.setBottomMargin(3);
 
var row = 0;
 
while(gr.next()) {
   var numCell = new sn_pdfgeneratorutils.Cell;
   var sdCell = new sn_pdfgeneratorutils.Cell;
 
   var numberParagraph = new sn_pdfgeneratorutils.Paragraph(gr.number);
   var sdParagraph = new sn_pdfgeneratorutils.Paragraph(gr.short_description);
  
   numCell.addParagraph(numberParagraph);
   sdCell.addParagraph(sdParagraph);
 
   if (row % 2 == 1) {
      table.setDefaultbackGroundColor(greyColor);
   } else {
      table.setDefaultbackGroundColor(whiteColor);
   }
 
   table.addCell(numCell);
   table.addCell(sdCell);
 
   row = row + 1;
 
}
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – setMarginLeft(数値余白)

ページの左側のマージンを設定します。

表 : 40. パラメーター
名前	タイプ	説明
余白	番号	左マージンの幅 (ポイント単位)。

表 : 41. 戻り値
タイプ	説明
なし

この例では、ページの左側に余白を設定する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
table.setMarginLeft(100);
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – setMarginRight(数値マージン)

ページの右側にマージンを設定します。

表 : 42. パラメーター
名前	タイプ	説明
余白	番号	右マージンの幅 (ポイント単位)。

表 : 43. 戻り値
タイプ	説明
なし

この例では、ページの左側に余白を設定する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
table.setMarginRight(100);
 
document.addTable(table);
"document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – setMarginTop(数値マージン)

ページの上部に余白を設定します。

表 : 44. パラメーター
名前	タイプ	説明
余白	番号	上マージンの高さ (ポイント単位)。

表 : 45. 戻り値
タイプ	説明
なし

この例では、ページの上部に余白を設定する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
table.setMarginTop(100);
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – setWidth(数値幅)

テーブルの全幅を設定します。

表 : 46. パラメーター
名前	タイプ	説明
幅	番号	テーブルの幅。単位:ポイント

表 : 47. 戻り値
タイプ	説明
なし

この例では、幅 90 ポイントのテーブルを作成し、ドキュメントをレコードに添付する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
table.setWidth(90);
table.setHorizontalAlignment("center");
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

テーブル – useAllAvailableWidth()

ページで利用可能な幅全体を使用するようにテーブルを展開します。

表 : 48. パラメーター
名前	タイプ	説明
なし

表 : 49. 戻り値
タイプ	説明
なし

この例では、ページで利用可能な幅まで拡張されるテーブルを作成する方法を示します。

var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
 
// declare table by providing width array and Boolean for large table
var table = new sn_pdfgeneratorutils.Table(true, [1], false);
 
table.addTextCell("Text to add to the cell");
table.useAllAvailableWidth();
 
document.addTable(table);
document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");