Main Content

mlreportgen.dom.Watermark クラス

名前空間: mlreportgen.dom

PDF レポート セクション内のページへの透かしの追加

このページをすべて展開する

説明

PDF レポート セクションに追加できる透かしオブジェクトを作成します。透かしとは、ページの背景に表示するイメージのことで、ドラフトや秘密情報などの言葉が使われます。これは、適用された各ページのテキストの背後に表示されます。.bmp、.jpg、.png、.svg、および .tiff のいずれのファイル タイプも使用できます。

mlreportgen.dom.Watermark クラスは handle クラスです。

作成

説明

例

wm = Watermark(image) は、指定されたイメージに基づいて Watermark オブジェクトを作成し、Watermark オブジェクトを返します。

入力引数

すべて展開する

透かしとして使用するイメージ。イメージ パス名として指定します。次のファイル タイプのいずれかを使用します。

  • .bmp

  • .jpg

  • .pdf (PDF 出力タイプのみ)

  • .png

  • .svg

  • .tiff

プロパティ

すべて展開する

valueUnits 形式の文字ベクトル。単位には次の値のいずれかを使用します。

  • "px" — ピクセル

  • "cm" — センチメートル

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

あるいは、Watermark.Style プロパティを使用して高さを指定できます。例:

Watermark.Style = {Height('4in')};

イメージ ファイルのパス。文字ベクトルとして指定します。

このドキュメント要素オブジェクトの書式指定。書式オブジェクトの配列として指定します。このプロパティで指定された書式は、この要素の StyleName プロパティで指定された対応する書式をオーバーライドします。この要素に適用されない書式は無視されます。

属性:

NonCopyable
true

データ型: cell

透かしの幅。valueUnits 形式で文字ベクトルとして指定します。単位には次の値のいずれかを使用します。

  • "px" — ピクセル

  • "cm" — センチメートル

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

あるいは、Watermark.Style プロパティを使用して幅を指定できます。例:

Watermark.Style = {Width('4in')};

mlreportgen.dom.Watermark オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメント生成中に問題が発生したときにどこを確認すればよいかを特定しやすくなります。

属性:

NonCopyable
true

データ型: char | string

mlreportgen.dom.Watermark オブジェクトのオブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。Id には独自の値を指定できます。

属性:

NonCopyable
true

データ型: char | string

例

すべて折りたたむ

スクリプトを開く

この例では、透かしをプログラムで作成し、それを現在のレイアウトに適用する方法を示します。透かしをプログラムで作成すると、イメージ ファイルを保存してその場所を追跡する必要がないため、ファイル管理が簡素化されます。

MATLAB® コマンドを使用して、イメージ ファイルをプログラムで作成します。SVG イメージ ファイルを使用すると、イメージをスケーリングしても解像度が維持されます。イメージをファイルに書き込んだら、Figure を削除できます。

 wmname = 'wm';
 wmtype =  'svg';
 wmfilename = [wmname '.' wmtype];

 subplot('Position',[0, 0, 1, 1]);
 axis('off');
 text(0.25, 0.25,'Draft', ...
   'Rotation', 45, ...
   'Color', [0.85, 0.85, 0.85], ...
   'FontSize',72);

  print(wmfilename, ['-d' wmtype]);
  delete(gcf);

透かしオブジェクト wm を作成し、現在のページ レイアウトに適用します。レポートを生成したら、変数 wmfilename で指定されたイメージ ファイルを削除できます。

import mlreportgen.dom.*;

d = Document('myreport','pdf');
open(d);

wm = Watermark(wmfilename);
wm.Width = '12in';
wm.Height = [];

d.CurrentPageLayout.Watermark = wm;

append(d,'Hello');
append(d, PageBreak);
append(d,'World');

close(d);
rptview(d.OutputPath);
delete(wmfilename);

バージョン履歴

R2016b で導入

参考

トピック