---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

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

# Line - スコープ指定、グローバル {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：3分

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

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

この API は、PDF を生成するために[ドキュメント API](https://servicenow-prod.fluidtopics.net/PkT2cVgUF6xDOPZvUnjHtw#DocumentBothAPI "Document API には、PDF の初期化、コンテンツの追加、PDF のクローズを行うメソッドが用意されています。コンテンツを追加した後、ドキュメントをターゲットレコードに添付できます。") とともに使用されるコンポーネントです。

## Line - Line() {#ariaid-title2}

新しい Line オブジェクトをインスタンス化します。
{#Line-Line__table_twm_hjk_34b__entry__3}

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

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

    var line = new sn_pdfgeneratorutils.Line();

## Line --drawLine(ドキュメント document, 数字 pageNo, 数字 xPos, 数字 yPos, 数字 width, 数字 lineWidth) {#ariaid-title3}

ドキュメントのページに線を配置します。
{#Line-drawLine_O_N_N_N_N_N__table_vv5_52h_44b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| Document | [ドキュメント](https://servicenow-prod.fluidtopics.net/PkT2cVgUF6xDOPZvUnjHtw#DocumentBothAPI "Document API には、PDF の初期化、コンテンツの追加、PDF のクローズを行うメソッドが用意されています。コンテンツを追加した後、ドキュメントをターゲットレコードに添付できます。") | ドキュメントオブジェクトの名前。 |
| pageNo | 数字 | 線を配置するページ番号。 |
| xPos | 数字 | ページ内の線を配置する X 座標領域。 |
| yPos | 数字 | ページ内の線を配置する Y 座標領域。 |
| width | 数字 | ページ内の線を描画する幅の領域。値はポイント単位です。 |
| lineWidth | 数字 | オプション。線の太さの値 (単位：ポイント)。 デフォルト値：1 |
[表 : 2. パラメーター]

{#Line-drawLine_O_N_N_N_N_N__table_vv5_52h_44b} {#Line-drawLine_O_N_N_N_N_N__table_wv5_52h_44b__entry__2}

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

{#Line-drawLine_O_N_N_N_N_N__table_wv5_52h_44b}  
次の例は、ドキュメントのページの下マージンに線を作成する方法を示します。 ドキュメントの使用例については、「[ドキュメント](https://servicenow-prod.fluidtopics.net/PkT2cVgUF6xDOPZvUnjHtw#DocumentBothAPI "Document API には、PDF の初期化、コンテンツの追加、PDF のクローズを行うメソッドが用意されています。コンテンツを追加した後、ドキュメントをターゲットレコードに添付できます。") 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) {#ariaid-title4}

線の色を設定します。
{#Line-setColor_O__table_vv5_52h_44b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| color | [色](https://servicenow-prod.fluidtopics.net/5ziHyJThRZ~YBMye1Ixwpw#ColorBothAPI "PDF の要素に適用できるセル、テーブル、行などの色属性を定義するために使用する Color オブジェクトを作成します。") | 線の色。 |
[表 : 4. パラメーター]

{#Line-setColor_O__table_vv5_52h_44b} {#Line-setColor_O__table_wv5_52h_44b__entry__2}

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

{#Line-setColor_O__table_wv5_52h_44b}  
次の例は、ドキュメントに線を作成して、線の色を設定する方法を示します。 ドキュメントの使用例については、「[ドキュメント](https://servicenow-prod.fluidtopics.net/PkT2cVgUF6xDOPZvUnjHtw#DocumentBothAPI "Document API には、PDF の初期化、コンテンツの追加、PDF のクローズを行うメソッドが用意されています。コンテンツを追加した後、ドキュメントをターゲットレコードに添付できます。") 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");