セル:スコープ対象、グローバル

Cell - Cell(Number rowspan, Number colspan)

新しい Cell オブジェクトをインスタンス化します。テーブル内のカスタム量のセルスペースを使用するセルを作成します。

注:

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

表 : 1. パラメーター
名前	タイプ	説明
行スパン	数値	このセルが占有する行数。デフォルト：0
colspan	数値	このセルが占有する列の数。デフォルト：0

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

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

セル – addImage(画像画像)

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

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

表 : 3. 返される内容
タイプ	説明
なし

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

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

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

cell.addImage(image);

セル – addParagraph(段落段落)

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

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

表 : 5. 返される内容
タイプ	説明
なし

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

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

セル – addStyle(スタイルスタイル)

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

表 : 6. パラメーター
名前	タイプ	説明
style	スタイル	この要素に適用するスタイル。

表 : 7. 返される内容
タイプ	説明
なし

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

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

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

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

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

セル – 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

セル – 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

セル – setBackGroundColor(色の色)

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

表 : 14. パラメーター
名前	タイプ	説明
色	色	背景色。

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

セル – setBorder(数値幅)

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

表 : 16. パラメーター
名前	タイプ	説明
幅	数値	セル境界線の幅 (ポイント単位)。

表 : 17. 返される内容
タイプ	説明
なし

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

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

var width = 1.0;

cell.setBorder(width);

セル – setBorderBottom(数値幅)

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

表 : 18. パラメーター
名前	タイプ	説明
幅	数値	セル境界線の幅 (ポイント単位)。

表 : 19. 返される内容
タイプ	説明
なし

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

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

var width = 1.0;

cell.setBorder(width);

セル:setBorderLeft(数値幅)

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

表 : 20. パラメーター
名前	タイプ	説明
幅	数値	セル境界線の幅 (ポイント単位)。

表 : 21. 返される内容
タイプ	説明
なし

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

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

var width = 1.0;

cell.setLeftBorder(width);

セル – setBorderRight(数値幅)

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

表 : 22. パラメーター
名前	タイプ	説明
幅	数値	セル境界線の幅 (ポイント単位)。

表 : 23. 返される内容
タイプ	説明
なし

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

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

var width = 1.0;

cell.setRightBorder(width);

セル – setBorderTop(数値幅)

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

表 : 24. パラメーター
名前	タイプ	説明
幅	数値	セル境界線の幅 (ポイント単位)。

表 : 25. 返される内容
タイプ	説明
なし

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

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

var width = 1.0;

cell.setBorderTop(width);

セル – setColoredBorder(Color color, Number width)

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

表 : 26. パラメーター
名前	タイプ	説明
色	色	セル境界線の色。
幅	数値	セル境界線の幅 (ポイント単位)。

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

セル – setColoredBorderBottom(色の色, 数値の幅)

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

表 : 28. パラメーター
名前	タイプ	説明
色	色	セル境界線の色。
幅	数値	セル境界線の幅 (ポイント単位)。

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

セル – setColoredBorderLeft(色の色, 数値の幅)

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

表 : 30. パラメーター
名前	タイプ	説明
色	色	セル境界線の色。
幅	数値	セル境界線の幅 (ポイント単位)。

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

セル – setColoredBorderRight(色の色, 数値の幅)

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

表 : 32. パラメーター
名前	タイプ	説明
色	色	セル境界線の色。
幅	数値	セル境界線の幅 (ポイント単位)。

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

セル – setColoredBorderTop(色の色, 数値の幅)

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

表 : 34. パラメーター
名前	タイプ	説明
色	色	セル境界線の色。
幅	数値	セル境界線の幅 (ポイント単位)。

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

セル:setHeight(数値の高さ)

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

表 : 36. パラメーター
名前	タイプ	説明
value	数値	セルの高さ (ポイント単位)。

表 : 37. 返される内容
タイプ	説明
なし

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

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

var height = 10;

cell.setHeight(height);

セル – setHorizontalAlignment(文字列配置)

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

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

表 : 39. 返される内容
タイプ	説明
なし

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

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

var alignment = "center";

cell.setHorizontalAlignment(alignment);

セル:setMaxHeight(数値)

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

表 : 40. パラメーター
名前	タイプ	説明
value	数値	最大セル高さ (ポイント単位)。

表 : 41. 返される内容
タイプ	説明
なし

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

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

var height = 409;

cell.setMaxHeight(height);

セル – setMaxWidth(float value)

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

表 : 42. パラメーター
名前	タイプ	説明
value	数値	最大セル幅 (ポイント)。

表 : 43. 返される内容
タイプ	説明
なし

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

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

var width = 1530;

cell.setMaxWidth(width);

セル – setMinHeight(数値)

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

表 : 44. パラメーター
名前	タイプ	説明
value	数値	最小セル高さ (ポイント単位)。

表 : 45. 返される内容
タイプ	説明
なし

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

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

var height = 12.75;

cell.setMinHeight(height);

セル – setMinWidth(数値)

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

表 : 46. パラメーター
名前	タイプ	説明
value	数値	最小セル幅 (ポイント単位)。

表 : 47. 返される内容
タイプ	説明
なし

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

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

var width = 50.58;

cell.setMinWidth(width);

セル – setOpacity(数値の不透明度)

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

注:

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

表 : 48. パラメーター
名前	タイプ	説明
不透明度	数値	0 から 1 までの浮動小数点数の 10 進数値。0 は透明で、1 は完全に不透明です。デフォルト：0

表 : 49. 返される内容
タイプ	説明
なし

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

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

var opacity = 0.5;

cell.setOpacity(opacity);

セル – setPadding(数値のパディング)

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

関連項目：

表 : 50. パラメーター
名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 51. 返される内容
タイプ	説明
なし

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

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

var padding = 1.0;

cell.setPadding(padding);

セル – setPaddingBottom(数値のパディング)

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

関連項目：

表 : 52. パラメーター
名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 53. 返される内容
タイプ	説明
なし

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

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

var padding = 1.0;

cell.setPaddingBottom(padding);

セル – setPaddingLeft(数値のパディング)

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

関連項目：

表 : 54. パラメーター
名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 55. 返される内容
タイプ	説明
なし

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

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

var padding = 1.0;

cell.setPaddingLeft(padding);

セル – setPaddingRight(数値のパディング)

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

関連項目：

表 : 56. パラメーター
名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 57. 返される内容
タイプ	説明
なし

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

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

var padding = 1.0;

cell.setPaddingRight(padding);

セル – setPaddingTop(数値のパディング)

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

関連項目：

表 : 58. パラメーター
名前	タイプ	説明
padding	番号	パディング幅 (10 進数値としてのポイント単位)。

表 : 59. 返される内容
タイプ	説明
なし

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

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

var padding = 1.0;

cell.setPaddingTop(padding);

セル – setTextAlignment(文字列配置)

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

表 : 60. パラメーター
名前	タイプ	説明
位置調整	文字列	テキストの配置位置。有効な値： 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);

セル – setVerticalAlignment(文字列配置)

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

表 : 62. パラメーター
名前	タイプ	説明
位置調整	文字列	垂直方向の配置設定。有効な値： bottom:コンテンツを下に揃えます。 mid:コンテンツを中央に揃えます。 top:コンテンツを上部に揃えます。

表 : 63. 返される内容
タイプ	説明
なし

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

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

var alignment = "mid";

cell.setVerticalAlignment(alignment);