5.20213.824
wijmo.pdf Class PdfDocument Wijmo API クラス

PdfDocument クラス

PDFKit JavaScriptライブラリに基づくPDFドキュメントオブジェクトを表します。

階層

コンストラクタ

constructor

プロパティ

bufferPages

bufferPages: boolean

ページのバッファリングモードが有効かどうかを示す値を取得します。 このモードでは、pageIndex およびbufferedPageRange を使用してドキュメントのページを反復処理できます。

このプロパティは、PdfDocumentコンストラクターに渡されるIPdfDocumentOptionsオブジェクトを使用して割り当てることができます。 このプロパティは、headerfooter が両方とも非表示である場合にのみfalseに設定できます。

デフォルト値はtrueです。

compress

compress: boolean

ドキュメント圧縮が有効かどうかを示す値を取得または設定します。

このプロパティは、PdfDocumentコンストラクターに渡されるIPdfDocumentOptionsオブジェクトを使用して割り当てることができます。

デフォルト値はtrueです。

currentPageSettings

currentPageSettings: IPdfPageSettings

現在のページ設定を表すオブジェクトを取得します(読み取り専用)。

returns

A IPdfPageSettings object that represents the current page settings.

displayTitle

displayTitle: boolean

ウィンドウのタイトルバーにIPdfDocumentInfo.titleから取得したドキュメントタイトルを表示するかどうかを指定する値を取得します。 falseに設定した場合、PDFファイルの名前が表示されます。

このプロパティは、PdfDocumentコンストラクターに渡されるIPdfDocumentOptionsオブジェクトを使用して割り当てることができます。

デフォルト値はfalse

document

document: PdfDocument

ドキュメントオブジェクトを取得します。

footer

下マージンの直上に配置されているページ領域のフッターを表すオブジェクトを取得します。

header

上マージンの直下に配置されているページ領域のヘッダーを表すオブジェクトを取得します。

height

height: number

領域の高さ(ポイント単位)を取得します。

info

作成者名やドキュメントの作成日などのドキュメント情報を取得または設定します。

lang

lang: string

ドキュメントのデフォルトの自然言語を表す値を取得します。

言語コードは、2文字のISO 639言語コード(例:英語の場合は「en」または日本語の場合は「ja」)で、その後にオプションの2文字のISO 3166国コード(例:米国の場合は「US」または日本の場合「JP」)が続きます)。 例:「en」、「en-US」、「ja-JP」。

このプロパティは、PdfDocumentコンストラクターに渡されるIPdfDocumentOptionsオブジェクトを使用して割り当てることができます。

デフォルト値はundefinedです。これは、ドキュメントにデフォルトの自然言語がないことを意味します。

lineGap

lineGap: number

テキスト行の間隔(ポイント単位)を取得または設定します。

デフォルト値は0です。

ownerPassword

ownerPassword: string

PDF所有者のパスワードを取得します。

このプロパティは、PdfDocumentコンストラクターに渡されるIPdfDocumentOptionsオブジェクトを使用して割り当てることができます。

pageIndex

pageIndex: number

バッファページ範囲内の現在のページのインデックスを取得または設定します。

bufferedPageRange メソッドを使用して、バッファページの範囲を取得します。

pageSettings

pageSettings: IPdfPageSettings

自動的に追加されるページおよびaddPage メソッドの デフォルトのページ設定を表すオブジェクトを取得します。

paths

paths: PdfPaths

パスを描画する機能を提供するオブジェクトを取得します。

permissions

permissions: IPdfPermissions

PDFファイルのアクセス許可を表すオブジェクトを取得します。

このプロパティは、PdfDocumentコンストラクターに渡されるIPdfDocumentOptionsオブジェクトを使用して割り当てることができます。

tagged

tagged: boolean

ドキュメントがタグ付きPDFの規則に準拠していることを示す値を取得します。 ドキュメントがタグ付きPDFドキュメントとして認識されるには、この値がtrueである必要があります。

このプロパティは、PdfDocumentコンストラクターに渡されるIPdfDocumentOptionsオブジェクトを使用して割り当てることができます。

メモ:タグ付きPDFには、ドキュメントバージョン1.4以降が必要です。

デフォルト値はfalseです。

userPassword

userPassword: string

PDFユーザーのパスワードを取得します。

このプロパティは、PdfDocumentコンストラクターに渡されるIPdfDocumentOptionsオブジェクトを使用して割り当てることができます。

version

version: PdfVersion

PDFファイルのバージョンを取得します。

このプロパティは、PdfDocumentコンストラクターに渡されるIPdfDocumentOptionsオブジェクトを使用して割り当てることができます。

デフォルト値はPdfVersion.v1_3です。

width

width: number

領域の幅(ポイント単位)を取得します。

x

x: number

テキストまたは画像の描画に使用されるテキストフロー内の現在の点のX座標 (ポイント単位)を取得または設定します。

y

y: number

テキストまたは画像の描画に使用されるテキストフロー内の現在の点のY座標 (ポイント単位)を取得または設定します。

メソッド

addPage

  • 指定された設定で新しいページを追加します。

    設定パラメータを省略すると、代わりにpageSettings が使用されます。

    引数

    戻り値 PdfDocument

    PdfDocument オブジェクト。

addTag

  • タグ要素をドキュメントの構造ツリーに追加します。

    引数

    • tag: IPdfTag

      ドキュメントの構造ツリーに追加する要素。

    戻り値 PdfDocument

    PdfDocument オブジェクト。

artifact

  • 内容をアーティファクトとしてマークします。

    以下に例を示します。

    doc.artifact(() => doc.drawText('アーティファクト'));
    

    引数

    戻り値 PdfPageArea

    マークされた内容への参照を表すIPdfTagContentオブジェクト。

beginArtifact

  • 内容をPDFアーティファクトとしてマークし始めます。 beginArtifact()の各呼び出しは、endArtifactで囲む必要があります。

    以下に例を示します。

    doc.beginArtifact();
    doc.drawText('アーティファクト);
    doc.endArtifact();
    

    引数

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

beginTagContent

  • 指定されたタグで内容のマーキングを開始し、マークされた内容への参照を表すオブジェクトであるタグの内容の要素を返します。 タグの内容の要素は、タグ要素に追加することでドキュメントの構造ツリーに組み込むことができます。 beginTagContent()の各呼び出しは、endTagContentで囲む必要があります。

    以下に例を示します。

    let content = doc.beginTagContent(wijmo.pdf.PdfTagType.P);
    doc.drawText('Hello, world!');
    doc.endTagContent();
    
    let tag = doc.tag(wijmo.pdf.PdfTagType.P);
    tag.add(content);
    doc.addTag(tag);
    

    メモ: タグの内容をマークすると、タグの内容の現在のマーキング(および子孫のマーキング)が自動的に終了します。

    引数

    戻り値 IPdfTagContent

    マークされた内容への参照を表すIPdfTagContentオブジェクト。

bufferedPageRange

dispose

  • dispose(): void
  • ドキュメントを破棄します。

    戻り値 void

drawImage

  • 指定されたオプションを使用して、JPGまたはPNG形式で画像を描画します。

    xおよびyが定義されていない場合は、代わりにx およびy が使用されます。

    最後に、画像がテキストフロー内で描画された場合、このメソッドはyを更新します。 したがって、後続のテキストまたは画像は、この点の下から開始されます。

    引数

    • src: string | IPdfImage

      画像の取得元のURLを含む文字列、Base64エンコード画像を含むデータURI、 またはopenImageメソッドによって返されるwijmo.pdf.IPdfImageオブジェクト。

    • オプション x: number

      画像を描画するポイントのx座標(ポイント単位)。

    • オプション y: number

      画像を描画するポイントのy座標(ポイント単位)。

    • オプション options: IPdfImageDrawSettings

      画像描画オプションを決定します。

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

drawSvg

  • 指定されたオプションを使用してSVG画像を描画します。

    xおよびyが定義されていない場合は、代わりにx およびy が使用されます。 このメソッドは、最も外側のSVG要素のwidth属性とheight属性の値を使用し、 options.widthプロパティとoptions.heightプロパティに基づいて拡大縮小率を決定します。 これらの属性のいずれかを省略した場合、拡大縮小は行われず、画像は元のサイズでレンダリングされます。 最後に、画像がテキストフロー内で描画された場合、このメソッドはy を更新します。 したがって、後続のテキストまたは画像は、この点の下から開始されます。 インクリメント値は、options.heightプロパティまたは最も外側のSVG要素のheight属性によって定義されます。 どちらも指定されていない場合、y は変更されません。 このメソッドは、SVG機能の一部のみをサポートしており、 主にWijmo 5のチャートコントロールをレンダリングするために提供されています。

    引数

    • url: string

      SVG画像の取得元のURLを含む文字列、またはBase64エンコードSVG画像を含むデータURI。

    • オプション x: number

      画像を描画するポイントのx座標(ポイント単位)。

    • オプション y: number

      画像を描画するポイントのy座標(ポイント単位)。

    • オプション options: IPdfSvgDrawSettings

      SVG画像描画オプションを決定します。

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

drawText

  • 指定されたオプションを使用して文字列を描画し、測定情報を返します。

    options.penoptions.brush、またはoptions.fontを省略すると、 それぞれ現在のドキュメントのペン、ブラシ、またはフォントが使用されます(PdfDocument.setPenPdfDocument.setBrush、および PdfDocument.setFont を参照)。

    文字列は、左上隅がxおよびy、幅および高さが options.width値およびoptions.height値で定義される四角形領域内に描画されます。xとyを指定しない場合は、代わりにPdfDocument.x プロパティとPdfDocument.y プロパティが使用されます。

    領域内のテキストは、自動的に折り返されてクリッピングされます。 options.heightが定義されておらず、テキストが本文の下端を超えた場合、 テキストに合わせて新しいページが追加されます。

    最後に、PdfDocument.x} プロパティとPdfDocument.y プロパティ プロパティの値を更新します。したがって、後続のテキストまたは画像は、この点の下から開始されます (options.continuedの値によって異なる)。

    測定結果には、テキストが複数のページまたは列に分割される可能性があることが反映されません。 テキストは単一ブロックとして処理されます。

    引数

    • text: string

      描画するテキスト。

    • オプション x: number

      テキストを描画するポイントのX座標(ポイント単位)。

    • オプション y: number

      テキストを描画するポイントのY座標(ポイント単位)。

    • オプション options: IPdfTextDrawSettings

      テキスト描画オプションを決定します。

    戻り値 IPdfTextMeasurementInfo

    IPdfTextMeasurementInfoオブジェクトは、測定情報を決定します。

end

  • end(): void
  • ドキュメントのレンダリングを終了します。

    戻り値 void

endArtifact

  • マークされた内容をPDFのアーティファクトとして終了します。

    以下に例を示します。

    doc.beginArtifact();
    doc.drawText('アーティファクト);
    doc.endArtifact();
    

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

endTagContent

  • タグの内容のマーケティングを終了します。

    以下に例を示します。

    let content = doc.beginTagContent(wijmo.pdf.PdfTagType.P);
    doc.drawText('Hello, world!');
    doc.endTagContent();
    

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

lineHeight

  • lineHeight(font?: PdfFont): number
  • 指定されたフォントの行の高さを取得します。

    フォントが指定されていない場合は、現在のドキュメントで使用されているフォントが使用されます。

    引数

    • オプション font: PdfFont

      行の高さを取得するフォント。

    戻り値 number

    行の高さ(ポイント単位)。

measureText

  • 指定されたフォントおよびテキスト描画オプションを使用して、テキストをレンダリングせずに測定します。

    フォントが指定されていない場合は、現在のドキュメントで使用されているフォントが使用されます。 このメソッドは、drawText と同じテキストレンダリングエンジンを使用するため、options.widthが指定されていない場合は、 同様にx およびページの右マージンに制約されます。 測定結果には、テキストが複数のページまたは列に分割される可能性があることが反映されません。 テキストは単一ブロックとして処理されます。

    引数

    • text: string

      測定するテキスト。

    • オプション font: PdfFont

      テキストに適用されるフォント。

    • オプション options: IPdfTextMeasurementSettings

      テキスト描画オプションを決定します。

    戻り値 IPdfTextMeasurementInfo

    IPdfTextMeasurementInfoオブジェクトは、測定情報を決定します。

moveDown

  • 指定されたフォントまたはフォントが指定されていない場合は現在のドキュメントのフォントを使用して、指定された行数だけy を下に移動します。

    引数

    • オプション lines: number

      下に移動する行数。

    • オプション font: PdfFont

      行の高さを計算するフォント。

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

moveUp

  • 指定されたフォントまたはフォントが指定されていない場合は現在のドキュメントのフォントを使用して、指定された行数だけy を上に移動します。

    引数

    • オプション lines: number

      上に移動する行数。

    • オプション font: PdfFont

      行の高さを計算するフォント。

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

onEnded

onPageAdded

  • pageAdded イベントを発生させます。

    引数

    戻り値 void

openImage

  • JPGまたはPNG形式で画像を開きます。

    引数

    • url: string

      画像の取得元のURLを含む文字列、またはBase64エンコード画像を含むデータURI。

    戻り値 IPdfImage

    画像データを含むIPdfImageオブジェクト。

registerFont

  • ソースからフォントを登録し、それを指定されたフォントファミリ名およびフォント属性に関連付けます。

    引数

    戻り値 PdfDocument

    PdfDocument オブジェクト。

registerFontAsync

  • registerFontAsync(font: IPdfFontFile, callback: Object): void
  • URLからフォントを非同期に登録し、それを指定されたフォントファミリ名 およびフォント属性に関連付けます。

    このコールバック関数は、パラメータとして IPdfFontFile オブジェクトを受け取ります。

    引数

    • font: IPdfFontFile

      登録するフォント。

    • callback: Object

      フォントが登録されると呼び出されるコールバック関数。

    戻り値 void

restoreState

  • スタックから状態を復元し、それをグラフィックコンテキストに適用します。

    戻り値 PdfDocument

    PdfDocument オブジェクト。

rotate

  • 指定された角度でグラフィックコンテキストを時計回りに回転します。

    引数

    • angle: number

      回転角度(度単位)。

    • オプション origin: Point

      回転の中心の Point (ポイント単位)。 指定しない場合は、左上隅が使用されます。

    戻り値 PdfPageArea

saveState

  • グラフィックコンテキストの状態(現在のペン、ブラシ、変換状態を含む)を 保存し、それをスタックにプッシュします。

    戻り値 PdfDocument

    PdfDocument オブジェクト。

scale

  • 指定された拡大率でグラフィックコンテキストを拡大縮小します。

    範囲[0, 1]内の拡大率の値は、サイズが小さくなることを示します。 1より大きい拡大率の値は、サイズが大きくなることを示します。

    引数

    • xFactor: number

      Xサイズを拡大縮小する係数。

    • オプション yFactor: number

      Yサイズを拡大縮小する係数。 指定しない場合は、xFactorと等しい値と見なされます。

    • オプション origin: Point

      拡大縮小の中心となるPoint (ポイント単位)。 指定しない場合は、左上隅が使用されます。

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

setBrush

setFont

  • ドキュメントフォントを設定します。

    指定されたスタイルおよび重みプロパティを持つフォントが見つからない場合は

    • フォールバック を使用して、 最も近いフォントが検索されます。
    • 何も見つからなかった場合は、以下の順序で他のスタイルの最も近いフォントが検索されます。
      • 'italic': 'oblique', 'normal'.
      • 'oblique': 'italic', 'normal'.
      • 'normal': 'oblique', 'italic'.

    引数

    • font: PdfFont

      設定するフォントオブジェクト。

    戻り値 PdfDocument

    PdfDocument オブジェクト。

setPen

  • デフォルトのドキュメントペンを設定します。 特定のペンが提供されていない場合は、このペンが PdfPaths.strokePdfPaths.fillAndStroke 、および drawText メソッドで使用されます。

    pen 引数は、次の値を取ることができます。

    • PdfPen オブジェクト。
    • wijmo.Color オブジェクト、またはwijmo.Color.fromString メソッドが受け取ることができる任意の文字列。 この場合、指定された色のPdfPen オブジェクトが内部的に作成されます。

    引数

    • pen: PdfPen | Color | string

      使用するペンまたは色。

    戻り値 PdfDocument

    PdfDocument オブジェクト。

tag

  • ドキュメントの構造ツリー内の項目を表すタグ要素を作成します。

    以下に例を示します。

    // 一部のテキストを段落としてマークします。
      let content = doc.beginTagContent(wijmo.pdf.PdfTagType.P);
    doc.drawText('Hello, world!');
      doc.endTagContent();
    
      // タグ要素を作成し、内容を追加します。
      let tag = doc.tag(wijmo.pdf.PdfTagType.P);
      tag.add(content);
    
      // タグ要素をドキュメントの構造ツリーに追加します。
      doc.addTag(tag);
    

    同様に、コールバック関数を使用します。

    doc.addTag(doc.tag(wijmo.pdf.PdfTagType.P, () =>  doc.drawText('Hello, world! ')));
    

    引数

    • type: PdfTagType

      タグ要素の種類。

    • オプション child: PdfTagOrContent | PdfTagOrContent[]

      オプションの子要素または子要素の配列。

    • オプション options: IPdfTagOptions

      要素の構成に使用されるオプションのIPdfTagOptionsオブジェクト。 次の子型がサポートされています。

      • 要素内にネストするIPdfTagオブジェクト。
      • IPdfTagContentオブジェクト、要素に関連付けるマークされたコンテンツへの参照。
      • 作成された要素がドキュメントの構造ツリーにアタッチされたときに自動的に実行されるコールバック関数。 この関数によって作成されたコンテンツは、**type**パラメータで指定され、要素に関連付けられたタグでマークされます。

    戻り値 IPdfTag

    IPdfTagタグ要素。

tagContent

  • 指定されたタグで内容をマークし、マークされた内容への参照を表すオブジェクトであるタグの内容の要素を返します。 タグの内容の要素は、タグ要素に追加することでドキュメントの構造ツリーに組み込むことができます。

    以下に例を示します。

    let content = doc.tagContent(wijmo.pdf.PdfTagType.P, () => doc.drawText('Hello, world!'));
    
    let tag = doc.tag(wijmo.pdf.PdfTagType.P);
    tag.add(content);
    doc.addTag(tag);
    

    引数

    戻り値 IPdfTagContent

    マークされた内容への参照を表すIPdfTagContentオブジェクト。

transform

  • transform(a: number, b: number, c: number, d: number, e: number, f: number): PdfPageArea
  • 3x3の変換マトリックスを表す指定された6つの数字で グラフィックコンテキストを変換します。

    変換マトリックスは次のように記述されます。

    ab0
    cd0
    ef1

    引数

    • a: number

      1行1列目の値。

    • b: number

      1行2列目の値。

    • c: number

      2行1列目の値。

    • d: number

      2行2列目の値。

    • e: number

      3行1列目の値。

    • f: number

      3行2列目の値。

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

translate

  • 指定された距離でグラフィックコンテキストを平行移動します。

    引数

    • x: number

      X軸方向に移動する距離(ポイント単位)。

    • y: number

      Y軸方向に移動する距離(ポイント単位)。

    戻り値 PdfPageArea

    PdfPageArea オブジェクト。

イベント

ended

ドキュメントがレンダリングされると発生します。

pageAdded

ドキュメントに新しいページが追加されたときに発生します。