5.20193.637
PdfRunningTitle Wijmo API クラス

PdfRunningTitle クラス

ヘッダー、フッターなどページの欄外見出しを表します。

このクラスは、ユーザーコード内でインスタンス化することを意図していません。

階層

コンストラクタ

constructor

プロパティ

declarative

欄外見出しのコンテンツを宣言的に設定するための機能を提供するオブジェクトを取得または設定します。

document

document: PdfDocument

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

height

height: number

欄外見出しの高さ(ポイント単位)を取得または設定します。 欄外見出しを非表示にするには、このプロパティを0に設定します。 このプロパティを変更しても、前の描画に影響はなく、サイズ変更もクリップもされません。

デフォルト値は24です。

lineGap

lineGap: number

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

デフォルト値は0です。

paths

paths: PdfPaths

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

width

width: number

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

x

x: number

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

y

y: number

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

メソッド

drawImage

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

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

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

    引数

    • src: any

      画像の取得元のURLを含む文字列、Base64エンコード画像を含むデータURI、またはwijmo.pdf.IPdfImage オブジェクト。

    • オプション x: number

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

    • オプション y: number

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

    • オプション options: IPdfImageDrawSettings

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

    戻り値 PdfPageArea

    The PdfPageArea object.

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

    The PdfPageArea object.

lineHeight

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

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

    引数

    • オプション font: PdfFont

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

    戻り値 number

    The line height, in points.

measureText

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

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

    引数

    • text: string

      測定するテキスト。

    • オプション font: PdfFont

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

    • オプション options: IPdfTextMeasurementSettings

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

    戻り値 IPdfTextMeasurementInfo

    A IPdfTextMeasurementInfo object determines the measurement information.

moveDown

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

    引数

    • オプション lines: number

      下に移動する行数。

    • オプション font: PdfFont

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

    戻り値 PdfPageArea

    The PdfPageArea object.

moveUp

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

    引数

    • オプション lines: number

      上に移動する行数。

    • オプション font: PdfFont

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

    戻り値 PdfPageArea

    The PdfPageArea object.

openImage

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

    引数

    • url: string

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

    戻り値 IPdfImage

    The IPdfImage object containing image data.

rotate

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

    引数

    • angle: number

      回転角度(度単位)。

    • オプション origin: Point

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

    戻り値 PdfPageArea

scale

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

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

    引数

    • xFactor: number

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

    • オプション yFactor: number

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

    • オプション origin: Point

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

    戻り値 PdfPageArea

    The PdfPageArea object.

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

    The PdfPageArea object.

translate

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

    引数

    • x: number

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

    • y: number

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

    戻り値 PdfPageArea

    The PdfPageArea object.