Style - スコープ指定、グローバル

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間:14分
  • フォントサイズ、境界線、配置などのプロパティを定義するスタイルを作成します。同じスタイルを複数のオブジェクトに同時に適用することができます。

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

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

    次の API 要素にカスタムのスタイルを適用できます。

    Style - Style()

    新しい Style オブジェクトをインスタンス化します。

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

    次の例は、セルパラグラフ、またはテーブル要素に追加できる Style オブジェクトの作成方法を示しています。

    var style = new sn_pdfgeneratorutils.Style();

    Style – setBackgroundColor(色 color)

    要素の背景色を指定します。

    表 : 2. パラメーター
    名前 タイプ 説明
    color Color 背景色。
    表 : 3. 返される内容
    タイプ 説明
    なし

    次の例は、要素の背景色を設定する方法を示しています。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

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

    Style – setBold()

    スタイルを太字フォントに設定します。

    表 : 4. パラメーター
    名前 タイプ 説明
    なし
    表 : 5. 返される内容
    タイプ 説明
    なし

    次の例は、スタイルを太字フォントに設定する方法を示しています。

    var style = new sn_pdfgeneratorutils.Style();
    style.setBold();

    Style – setBorder(数字 width)

    要素の 4 辺すべてにスタイルの境界線を設定します。

    表 : 6. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    表 : 7. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var width = 2;
    
    style.setBorder(width);

    Style – setBorderBottom(数字 width)

    スタイルの境界線を要素の下に設定します。

    表 : 8. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    表 : 9. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var width = 2;
    
    style.setBorderBottom(width);

    Style – setBorderLeft(数字 width)

    要素の左側にスタイルの境界線を設定します。

    表 : 10. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    表 : 11. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var width = 2;
    
    style.setBorderLeft(width);

    Style – setBorderRight(数字 width)

    要素の右側にスタイルの境界線を設定します。

    表 : 12. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    表 : 13. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var width = 2;
    
    style.setBorderRight(width);

    Style – setBorderTop(数字 width)

    要素の上にスタイルの境界線を設定します。

    表 : 14. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    表 : 15. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var width = 2;
    
    style.setBorderTop(width);

    Style – setColoredBorder(数字 width, 色 color)

    要素の 4 辺すべてにスタイルの境界線を色付きで設定します。

    表 : 16. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    color Color スタイルの境界線の色。
    表 : 17. 返される内容
    タイプ 説明
    なし

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

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

    Style – setColoredBorderBottom(数字 width, 色 color)

    要素の下にスタイルの境界線を色付きで設定します。

    表 : 18. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    color Color スタイルの境界線の色。
    表 : 19. 返される内容
    タイプ 説明
    なし

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

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

    Style – setColoredBorderLeft(数字 width, 色 color)

    要素の左側にスタイルの境界線を色付きで設定します。

    表 : 20. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    color Color スタイルの境界線の色。
    表 : 21. 返される内容
    タイプ 説明
    なし

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

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

    Style – setColoredBorderRight(数字 width, 色 color)

    要素の右側にスタイルの境界線を色付きで設定します。

    表 : 22. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    color Color スタイルの境界線の色。
    表 : 23. 返される内容
    タイプ 説明
    なし

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

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

    Style – setColoredBorderTop(数字 width, 色 color)

    要素の上にスタイルの境界線を色付きで設定します。

    表 : 24. パラメーター
    名前 タイプ 説明
    width 数値 スタイルの境界幅 (ポイント)。
    color Color スタイルの境界線の色。
    表 : 25. 返される内容
    タイプ 説明
    なし

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

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

    Style – setFontColor(色 color)

    フォントの色を設定します。

    表 : 26. パラメーター
    名前 タイプ 説明
    color フォントの色。
    表 : 27. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var fontColor = new sn_pdfgeneratorutils.Color([1,0.5,0.5]);
    
    style.setFontColor(fontColor);

    Style – setFontSize(数字 fontSize)

    スタイルのフォントサイズを設定します。

    表 : 28. パラメーター
    名前 タイプ 説明
    fontSize 数字 フォントサイズ (ポイント)。
    表 : 29. 返される内容
    タイプ 説明
    なし

    次の例は、フォントサイズを設定する方法を示しています。

    var style = new sn_pdfgeneratorutils.Style();
    
    style.setFontSize(12);

    Style – setHorizontalAlignment(文字列 alignment)

    スタイルの水平配置を設定します。

    表 : 30. パラメーター
    名前 タイプ 説明
    alignment 文字列 水平配置設定。
    有効な値:
    • center:コンテンツを中央に配置します。
    • left:コンテンツを左に配置します。
    • right:コンテンツを右に配置します。
    表 : 31. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var alignment = "Center";
    
    style.setHorizontalAlignment(alignment);
    

    Style – setItalic()

    スタイルをイタリック体フォントに設定します。

    表 : 32. パラメーター
    名前 タイプ 説明
    なし
    表 : 33. 返される内容
    タイプ 説明
    なし

    次の例は、要素のスタイルをイタリック体フォントに設定する方法を示しています。

    var style = new sn_pdfgeneratorutils.Style();
    style.setItalic();

    Style – setPadding(数字 padding)

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

    表 : 34. パラメーター
    名前 タイプ 説明
    padding 数値 10 進数値としてのパディング幅 (ポイント)。
    表 : 35. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var padding = 2.5;
    
    style.setPadding(padding);

    Style – setPaddingBottom(数字 padding)

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

    表 : 36. パラメーター
    名前 タイプ 説明
    padding 数値 10 進数値としてのパディング幅 (ポイント)。
    表 : 37. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var padding = 2.5;
    
    style.setPaddingBottom(padding);

    Style – setPaddingLeft(数字 padding)

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

    表 : 38. パラメーター
    名前 タイプ 説明
    padding 数値 10 進数値としてのパディング幅 (ポイント)。
    表 : 39. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var padding = 2.5;
    
    style.setPaddingLeft(padding);

    Style – setPaddingRight(数字 padding)

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

    表 : 40. パラメーター
    名前 タイプ 説明
    padding 数値 10 進数値としてのパディング幅 (ポイント)。
    表 : 41. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var padding = 2.5;
    
    style.setPaddingRight(padding);

    Style – setPaddingTop(数字 padding)

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

    表 : 42. パラメーター
    名前 タイプ 説明
    padding 数値 10 進数値としてのパディング幅 (ポイント)。
    表 : 43. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var padding = 2.5;
    
    style.setPaddingTop(padding);

    Style – setTextAlignment(文字列 alignment)

    スタイルのテキスト配置を設定します。

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

    次の例は、要素のテキストを中央揃えに設定する方法を示しています。

    var style = new sn_pdfgeneratorutils.Style();
    
    String alignment = "text-center";
    
    style.setTextAlignment(alignment);

    Style – setVerticalAlignment(文字列 alignment)

    この要素の垂直配置を設定します。

    表 : 46. パラメーター
    名前 タイプ 説明
    alignment 文字列 垂直配置設定。
    有効な値:
    • bottom:コンテンツを下揃えにします。
    • center:コンテンツを中央揃えにします。
    • top:コンテンツを上揃えにします。
    表 : 47. 返される内容
    タイプ 説明
    なし

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

    var style = new sn_pdfgeneratorutils.Style();
    
    var alignment = "Mid";
    
    style.setVerticalAlignment(alignment);