Cell - スコープ付き、グローバル

Cell オブジェクトをテーブルのセルとして作成します。この API を使用して、セルを書式設定し、パラグラフや画像などの追加ブロックを含めることができます。

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

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

Cell - Cell(数値 rowspan, 数値 colspan)

新しい Cell オブジェクトをインスタンス化します。テーブル内でカスタムサイズのセルスペースを占有するセルを作成します。

注:

いずれかのパラメーターに負の数を指定すると、値は 1 に設定されます。

表 : 1. パラメーター

名前	タイプ	説明
rowspan	番号	このセルが占有する行数。 デフォルト：0
colspan	番号	このセルが占有する列数。 デフォルト：0

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

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

Cell – addImage(画像 image)

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

表 : 2. パラメーター

名前	タイプ	説明
image	画像	テーブルセルに追加する画像。

表 : 3. 返される内容

タイプ	説明
なし

次の例は、既存の画像の添付ファイルをインスタンス化してテーブル内のセルに追加する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

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

cell.addImage(image);

Cell – addParagraph(パラグラフ paragraph)

テーブルセルにテキストを追加します。

表 : 4. パラメーター

名前	タイプ	説明
paragraph	パラグラフ	テーブルセルに追加するテキスト。

表 : 5. 返される内容

タイプ	説明
なし

次の例は、パラグラフオブジェクトをインスタンス化し、テーブルにコンテンツセルを追加する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

Cell – addStyle(スタイル style)

テーブルセルに、事前定義されたスタイルを適用します。

表 : 6. パラメーター

名前	タイプ	説明
style	スタイル	この要素に適用するスタイル。

表 : 7. 返される内容

タイプ	説明
なし

次の例は、テーブルセルにスタイルを適用する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

Cell – addTable(テーブル table)

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

表 : 8. パラメーター

名前	タイプ	説明
テーブル	テーブル	セルに追加するテーブル。

表 : 9. 返される内容

タイプ	説明
なし

次の例は、テーブルオブジェクトをインスタンス化してセルに追加する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var columnWidths = [100, 50, 50];

var table = new Table(columnWidths, false);

cell.addTable(table);

Cell – getColumn()

セルが配置されている列の番号を取得します。

表 : 10. パラメーター

名前	タイプ	説明
なし

表 : 11. 返される内容

タイプ	説明
番号	セルの列位置の番号。

次の例は、セルの列位置の番号を取得する方法を示しています。

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);

出力：

The column position for cell is 1

Cell – getRow()

セルが配置されている行の番号を取得します。

表 : 12. パラメーター

名前	タイプ	説明
なし

表 : 13. 返される内容

タイプ	説明
番号	セルの行位置の番号。

次の例は、セルの行位置の番号を取得する方法を示しています。

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);

出力：

The row position for cell is 4927

Cell – setBackGroundColor(色 color)

セルの背景色を指定します。

表 : 14. パラメーター

名前	タイプ	説明
color	Color	背景色。

表 : 15. 返される内容

タイプ	説明
なし

次の例は、セルの背景色を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント 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);

Cell – setBorder(数値 width)

セルの 4 つのエッジすべてに境界線を設定します。

表 : 16. パラメーター

名前	タイプ	説明
width	番号	セルの境界幅 (ポイント)。

表 : 17. 返される内容

タイプ	説明
なし

次の例は、1 ポイントのセル境界線をセルの 4 つのエッジすべてに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var width = 1.0;

cell.setBorder(width);

Cell – setBorderBottom(数値 width)

セルの下側の境界線を設定します。

表 : 18. パラメーター

名前	タイプ	説明
width	番号	セルの境界幅 (ポイント)。

表 : 19. 返される内容

タイプ	説明
なし

次の例は、セルの境界線を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var width = 1.0;

cell.setBorder(width);

Cell – setBorderLeft(数値 width)

セルの左側の境界線を設定します。

表 : 20. パラメーター

名前	タイプ	説明
width	番号	セルの境界幅 (ポイント)。

表 : 21. 返される内容

タイプ	説明
なし

次の例は、セルの左側の境界線を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var width = 1.0;

cell.setLeftBorder(width);

Cell – setBorderRight(数値 width)

セルの右側の境界線を設定します。

表 : 22. パラメーター

名前	タイプ	説明
width	番号	セルの境界幅 (ポイント)。

表 : 23. 返される内容

タイプ	説明
なし

次の例は、セルの右側の境界線を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var width = 1.0;

cell.setRightBorder(width);

Cell – setBorderTop(数値 width)

セルの上側の境界線を設定します。

表 : 24. パラメーター

名前	タイプ	説明
width	番号	セルの境界幅 (ポイント)。

表 : 25. 返される内容

タイプ	説明
なし

次の例は、セルの上側の境界線を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var width = 1.0;

cell.setBorderTop(width);

Cell – setColoredBorder(色 color, 数値 width)

セルの 4 つのエッジすべてに色付きの境界線を設定します。

表 : 26. パラメーター

名前	タイプ	説明
color	色	セルの境界色。
width	番号	セルの境界幅 (ポイント)。

表 : 27. 返される内容

タイプ	説明
なし

次の例は、セルに色付きの境界線を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント 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);

Cell – setColoredBorderBottom(色 color, 数値 width)

セルの下側に色付きの境界線を設定します。

表 : 28. パラメーター

名前	タイプ	説明
color	色	セルの境界色。
width	番号	セルの境界幅 (ポイント)。

表 : 29. 返される内容

タイプ	説明
なし

次の例は、セルの下側に色付きの境界線を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント 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);

Cell – setColoredBorderLeft(色 color, 数値 width)

セルの左側に色付きの境界線を設定します。

表 : 30. パラメーター

名前	タイプ	説明
color	色	セルの境界色。
width	番号	セルの境界幅 (ポイント)。

表 : 31. 返される内容

タイプ	説明
なし

次の例は、セルの左側に色付きの境界線を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント 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);

Cell – setColoredBorderRight(色 color, 数値 width)

セルの右側に色付きの境界線を設定します。

表 : 32. パラメーター

名前	タイプ	説明
color	色	セルの境界色。
width	番号	セルの境界幅 (ポイント)。

表 : 33. 返される内容

タイプ	説明
なし

次の例は、セルの右側に色付きの境界線を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント 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);

Cell – setColoredBorderTop(色 color, 数値 width)

セルの上側に色付きの境界線を設定します。

表 : 34. パラメーター

名前	タイプ	説明
color	色	セルの境界色。
width	番号	セルの境界幅 (ポイント)。

表 : 35. 返される内容

タイプ	説明
なし

次の例は、セルの上側に色付きの境界線を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント 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);

Cell – setHeight(数値 height)

セルの高さを設定します。

表 : 36. パラメーター

名前	タイプ	説明
value	番号	セルの高さ (単位：ポイント)。

表 : 37. 返される内容

タイプ	説明
なし

次の例は、セルの高さを 10 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var height = 10;

cell.setHeight(height);

Cell – setHorizontalAlignment(文字列 alignment)

このセルの水平配置を設定します。

表 : 38. パラメーター

名前	タイプ	説明
alignment	文字列	水平配置設定。 有効な値： center：コンテンツを中央に配置します。 left：コンテンツを左に配置します。 right：コンテンツを右に配置します。

表 : 39. 返される内容

タイプ	説明
なし

次の例は、セルの水平配置を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var alignment = "center";

cell.setHorizontalAlignment(alignment);

Cell – setMaxHeight(数値 value)

セルの最大高さを設定します。

表 : 40. パラメーター

名前	タイプ	説明
value	番号	セルの最大高さ (単位：ポイント)。

表 : 41. 返される内容

タイプ	説明
なし

次の例は、セルの最大高さを 409 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var height = 409;

cell.setMaxHeight(height);

Cell – setMaxWidth(浮動小数点数 value)

セルの最大幅を設定します。

表 : 42. パラメーター

名前	タイプ	説明
value	番号	セルの最大幅 (単位：ポイント)。

表 : 43. 返される内容

タイプ	説明
なし

次の例は、セルの最大幅を 1530 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var width = 1530;

cell.setMaxWidth(width);

Cell – setMinHeight(数値 value)

セルの最小高さを設定します。

表 : 44. パラメーター

名前	タイプ	説明
value	番号	セルの最小高さ (単位：ポイント)。

表 : 45. 返される内容

タイプ	説明
なし

次の例は、セルの最小高さを 12.75 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var height = 12.75;

cell.setMinHeight(height);

Cell – setMinWidth(数値 value)

セルの最小幅を設定します。

表 : 46. パラメーター

名前	タイプ	説明
value	番号	セルの最小幅 (単位：ポイント)。

表 : 47. 返される内容

タイプ	説明
なし

次の例は、セルの最小幅を 50.58 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var width = 50.58;

cell.setMinWidth(width);

Cell – setOpacity(数値 opacity)

セルのコンテンツ、境界線、および背景の不透明度を設定します。

注:

この設定は、セルのすべての子要素に影響します。

表 : 48. パラメーター

名前	タイプ	説明
opacity	番号	0 〜 1 の浮動小数点値。0 は透明で、1 は完全に不透明です。 デフォルト：0

表 : 49. 返される内容

タイプ	説明
なし

次の例は、セルの不透明度を設定する方法を示しています。

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

var opacity = 0.5;

cell.setOpacity(opacity);

Cell – setPadding(数値 padding)

セルの 4 辺すべてのパディングを同じ幅に設定します。

関連項目：

• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

表 : 50. パラメーター

名前	タイプ	説明
padding	数値	10 進数値としてのパディング幅 (ポイント)。

表 : 51. 返される内容

タイプ	説明
なし

次の例は、最下部のセルを 1 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var padding = 1.0;

cell.setPadding(padding);

Cell – setPaddingBottom(数値 padding)

セルの下パディング幅の値を設定します。

関連項目：

• setPadding()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

表 : 52. パラメーター

名前	タイプ	説明
padding	数値	10 進数値としてのパディング幅 (ポイント)。

表 : 53. 返される内容

タイプ	説明
なし

次の例は、セルの下部パディングを 1 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var padding = 1.0;

cell.setPaddingBottom(padding);

Cell – setPaddingLeft(数値 padding)

セルの左パディング幅の値を設定します。

関連項目：

• setPadding()
• setPaddingBottom()
• setPaddingRight()
• setPaddingTop()

表 : 54. パラメーター

名前	タイプ	説明
padding	数値	10 進数値としてのパディング幅 (ポイント)。

表 : 55. 返される内容

タイプ	説明
なし

次の例は、セルの左パディングを 1 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var padding = 1.0;

cell.setPaddingLeft(padding);

Cell – setPaddingRight(数値 padding)

セルの右パディング幅の値を設定します。

関連項目：

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingTop()

表 : 56. パラメーター

名前	タイプ	説明
padding	数値	10 進数値としてのパディング幅 (ポイント)。

表 : 57. 返される内容

タイプ	説明
なし

次の例は、セルの右パディングを 1 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var padding = 1.0;

cell.setPaddingRight(padding);

Cell – setPaddingTop(数値 padding)

セルの上パディング幅の値を設定します。

関連項目：

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()

表 : 58. パラメーター

名前	タイプ	説明
padding	数値	10 進数値としてのパディング幅 (ポイント)。

表 : 59. 返される内容

タイプ	説明
なし

次の例は、セルの上パディングを 1 ポイントに設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var padding = 1.0;

cell.setPaddingTop(padding);

Cell – setTextAlignment(文字列 alignment)

このセルのテキスト配置を設定します。

表 : 60. パラメーター

名前	タイプ	説明
alignment	文字列	テキストの位置調整。 有効な値： text-center：テキストを中央揃えにします。 text-justified：文字間のスペースを変更して、左側と右側の間をテキストで完全に埋めます。最後の行は左揃えで表示されます。 text- Justified-all：最後の行を含むテキストの配置を調整します。 text-left：テキストを左揃えにします。 text-right：テキストを右揃えにします。

表 : 61. 返される内容

タイプ	説明
なし

次の例は、セルテキストを左揃えに設定する方法を示しています。

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

var alignment = "text-left";

cell.setTextAlignment(alignment);

Cell – setVerticalAlignment(文字列 alignment)

このセルの垂直配置を設定します。

表 : 62. パラメーター

名前	タイプ	説明
alignment	文字列	垂直配置設定。 有効な値： bottom：コンテンツを下揃えにします。 center：コンテンツを中央揃えにします。 top：コンテンツを上揃えにします。

表 : 63. 返される内容

タイプ	説明
なし

次の例は、セルの垂直配置を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

var alignment = "mid";

cell.setVerticalAlignment(alignment);