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

PDF に線を描画するメソッドを使用して、Line オブジェクトを作成します。

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

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

Line - Line()

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

表 : 1. パラメーター

名前	タイプ	説明
なし

次の例は、Line オブジェクトを作成する方法を示します。

var line = new sn_pdfgeneratorutils.Line();

Line –drawLine(ドキュメント document, 数字 pageNo, 数字 xPos, 数字 yPos, 数字 width, 数字 lineWidth)

ドキュメントのページに線を配置します。

表 : 2. パラメーター

名前	タイプ	説明
Document	ドキュメント	ドキュメントオブジェクトの名前。
pageNo	数字	線を配置するページ番号。
xPos	数字	ページ内の線を配置する X 座標領域。
yPos	数字	ページ内の線を配置する Y 座標領域。
width	数字	ページ内の線を描画する幅の領域。値はポイント単位です。
lineWidth	数字	オプション。線の太さの値 (単位：ポイント)。 デフォルト値：1

表 : 3. 返される内容

タイプ	説明
なし

次の例は、ドキュメントのページの下マージンに線を作成する方法を示します。 ドキュメントの使用例については、「ドキュメント API」を参照してください。

var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

var num = 1;
var xpos = 100;
var ypos = 100;
var width = 450;
var linewidth = 2.5;

document.addNewPage();

var line = new sn_pdfgeneratorutils.Line();

line.drawLine(document, num, xpos, ypos, width, linewidth);

document.saveAsAttachment("incident", "<sys_id>", "line.pdf");

Line – setColor(色 color)

線の色を設定します。

表 : 4. パラメーター

名前	タイプ	説明
color	色	線の色。

表 : 5. 返される内容

タイプ	説明
なし

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

var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

var num = 1;
var xpos = 100;
var ypos = 100;
var width = 450;
var linewidth = 2.5;

var color = new sn_pdfgeneratorutils.Color([0.5,0.5,0.8]);   //given as array of RGB values;

document.addNewPage();

var line = new sn_pdfgeneratorutils.Line();

line.setColor(color);

line.drawLine(document, num, xpos, ypos, width, linewidth);

document.saveAsAttachment("incident", "<sys_id>", "lineWithColor.pdf");