mlreportgen.dom.Watermark クラス

名前空間: mlreportgen.dom

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

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

説明

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

  • .emf

  • .gif

  • .jpg

  • .pdf

  • .png

  • .svg

  • .tiff

このクラスは、以下の MATLAB® Report Generator™ 出力形式にのみ対応しています。

  • "pdf"

  • "pdfa" (R2025a 以降)

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

作成

説明

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

例

入力引数

すべて展開する

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

  • .emf

  • .gif

  • .jpg

  • .pdf

  • .png

  • .svg

  • .tiff

プロパティ

すべて展開する

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

属性:

GetAccess
public
SetAccess
private
NonCopyable
true
Transient
true

データ型: char | string

透かしの高さ。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"10px" は 10 ピクセルを指定します。有効な略語を以下に示します。

  • "px" — ピクセル

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

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

単位を省略することで、ピクセルとして指定することもできます。たとえば、"5" は 5 ピクセルを指定します。

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

透かしの幅。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"10px" は 10 ピクセルを指定します。有効な略語を以下に示します。

  • "px" — ピクセル

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

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

単位を省略することで、ピクセルとして指定することもできます。たとえば、"5" は 5 ピクセルを指定します。

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

スタイルシート定義スタイル名。文字ベクトルまたは string スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。

メモ

Microsoft® Word レポートでは、ドキュメント テンプレートで定義されていないスタイル名は無視されます。Microsoft Word テンプレートの詳細については、DOM API レポート プログラムのテンプレートを参照してください。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: cell

ドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、このオブジェクトが追加されるドキュメント要素の出力形式でサポートされていなければなりません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
public
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 で導入

すべて展開する

参考

トピック