Main Content

mlreportgen.report.FormalImage クラス

パッケージ: mlreportgen.report
スーパークラス: mlreportgen.report.Reporter

表題付きイメージ レポーター

説明

表題付きイメージのレポーターを作成します。

mlreportgen.report.FormalImage クラスは handle クラスです。

作成

説明

image = FormalImage() は、空のイメージ レポーターを作成します。レポーターのプロパティを使用して、イメージのソース、表題、高さ、幅などを設定します。レポーターは、テンプレートを使用して、表題の書式設定と番号付けを行い、イメージを基準に表題を配置します。書式をカスタマイズするには、カスタム テンプレートを指定するか、このレポーターのプロパティを使用してテンプレートをプログラムでオーバーライドします。

image = FormalImage(source) は、source によって指定されたイメージをレポートに追加するイメージ レポーターを作成します。Image プロパティを参照してください。

image = FormalImage(Name=Value) は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順番で指定できます。

入力引数

すべて展開する

レポートに追加するイメージのソース。string、文字配列、または DOM Image オブジェクトとして指定します。Image プロパティを参照してください。

プロパティ

すべて展開する

レポートに追加するイメージのソース。string、文字配列、または DOM Image オブジェクトとして指定します。string または文字配列を使用する場合は、イメージ ファイルへのシステム パスを指定します。

サポートされているイメージ形式は次のとおりです。

  • .bmp — ビットマップ イメージ

  • .gif — Graphics Interchange Format

  • .jpg — JPEG イメージ

  • .png — PNG イメージ

  • .emf — 拡張メタファイル (Windows® プラットフォーム上の DOCX 出力でのみサポート)

  • .svg - Scalable Vector Graphics

  • .tif - タグ イメージのファイル形式 (HTML 出力ではサポートなし)

  • .pdf - PDF イメージ (PDF 出力でのみサポート)

このレポーターは、レポーターのテンプレートによってスタイルが指定されている段落に、指定されたイメージを挿入します。段落スタイルによって、表題を基準にしたイメージの配置と間隔が決まります。配置と間隔をカスタマイズするには、レポーターのテンプレート ライブラリにある FormalImage テンプレートをカスタマイズします。

この形式的イメージの表題。次の値のいずれかとして指定します。

  • string または文字配列

  • DOM オブジェクト

  • string または DOM オブジェクトから成る 1 行 N 列または N 行 1 列の配列

  • string、文字配列、DOM オブジェクトのいずれか、またはこれらの組み合わせから成る 1 行 N 列または N 行 1 列の cell 配列

  • getCaptionReporter メソッドによって返されるホール レポーター

表題には自動的に番号が付けられ、イメージの下に配置されます。

インライン コンテンツは、段落が含むことのできるコンテンツです。表題の値がインライン コンテンツの場合、レポーターはテンプレート ライブラリに保存されているテンプレートを使用して表題を書式設定します。テンプレートは、イメージが番号付きの章にあるか番号なしの章にあるかによって異なる書式を使用して、表題に自動的に番号を付けます。

  • 番号が付けられた章のイメージは、'Figure N.M' という形式の表題テキストの接頭辞をもちます。ここで、N は章番号、M は章内の図の番号です。たとえば、レポートの 2 番目の章にある 3 番目のイメージの接頭辞は Figure 2.3 になります。

  • 番号なしの章のイメージは、'Figure N.' という形式の表題テキストの接頭辞をもちます。ここで、N は、レポートの最初のイメージでは 1 になり、2 番目のイメージでは 2 のようになります (以下同様)。

英語以外の多くのロケールでは、表題の接頭辞がロケールの言語と形式に変換されます。変換済みロケールのリストについては、mlreportgen.report.ReportLocale プロパティを参照してください。

このイメージの幅。string または文字配列として指定します。このプロパティは、ソースがイメージ パスとして指定されている形式的イメージにのみ適用されます。

Width の形式は valueUnits です。ここで、Units は幅の単位の略語で、value は単位の数値です。次の表は、有効な Units の略語を示しています。

単位単位の略語
ピクセルpx
センチメートルcm
インチin
ミリメートルmm
パイカpc
ポイントpt
パーセント%

イメージの幅を設定して高さを設定しない場合、イメージの縦横比を維持するために高さがスケーリングされます。

例: 5in

このイメージの高さ。string または文字配列として指定します。このプロパティは、ソースがイメージ パスとして指定されている形式的イメージにのみ適用されます。

Height の形式は valueUnits です。ここで、Units は高さの単位の略語で、value は単位の数値です。有効な Units の略語のリストについては、Width プロパティを参照してください。

イメージの高さを設定して幅を設定しない場合、イメージの縦横比を維持するために幅がスケーリングされます。

この形式的イメージをスケーリングするかどうか。logical 値として指定します。このプロパティは、Microsoft® Word のページ、PDF のページ、またはテーブル エントリの余白と余白の間に収まるようにイメージをスケーリングするかどうかを指定します。

この形式的イメージ内のハイパーリンク領域のマップ。mlreportgen.dom.ImageMap オブジェクトとして指定します。このプロパティは、HTML および PDF のレポートにのみ適用されます。mlreportgen.dom.ImageArea を使用してイメージ領域を定義し、マップに追加します。イメージ領域は、ブラウザーでコンテンツを開いたり、同じページの別の場所に移動したりするためのハイパーリンクを含むイメージ内の領域です。

このレポーターのテンプレートのソース。次のオプションのいずれかとして指定します。

  • このレポーターのテンプレートを含むファイルのパスを指定する文字ベクトルまたは string スカラー

  • テンプレートがこのレポーターのために使用される、またはテンプレート ライブラリがこのレポーターのテンプレートを含むレポーターまたはレポート

  • テンプレートがこのレポーターのために使用される、またはテンプレート ライブラリがこのレポーターのテンプレートを含む DOM ドキュメントまたはドキュメント パーツ

指定したテンプレートは、このレポーターが追加されるレポートと同じタイプにしなければなりません。たとえば、Microsoft Word レポートでは、TemplateSrc は Word レポーター テンプレートでなければなりません。TemplateSrc プロパティが空の場合、このレポーターはレポートの出力タイプに既定のレポーター テンプレートを使用します。

このレポーターのテンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーターのテンプレートは、このレポーター用のテンプレート ソース (TemplateSrc) のテンプレート ライブラリになければなりません。

このレポーターのハイパーリンク ターゲット。リンク ターゲット ID を指定する文字ベクトルもしくは string スカラー、または mlreportgen.dom.LinkTarget オブジェクトとして指定します。文字ベクトルまたは string スカラー値は LinkTarget オブジェクトに変換されます。リンク ターゲットは、出力レポートでこのレポーターのコンテンツの直前にあります。

メソッド

すべて展開する

すべて折りたたむ

空のイメージ レポーターをレポートに追加し、そのソース、表題、および高さを設定します。

次のコマンドを実行して、この例で使用されているサポート ファイルにアクセスします。

openExample('rptgen/MatlabReportGeneratorSupportFilesExample');
import mlreportgen.report.*
rpt = mlreportgen.report.Report('output','pdf');
chapter = mlreportgen.report.Chapter();
chapter.Title = 'Formal Image Reporter Example';

image = mlreportgen.report.FormalImage();
image.Image = which('ngc6543a.jpg');
image.Caption = 'Cat''s Eye Nebula or NGC 6543';
image.Height = '5in';

add(chapter,image);
add(rpt,chapter);
rptview(rpt);

レポートにイメージを追加します。既定の書式設定を使用しますが、表題のテキストの色を赤に変更します。

次のコマンドを実行して、この例で使用されているサポート ファイルにアクセスします。

openExample('rptgen/MatlabReportGeneratorSupportFilesExample');
import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report('output','pdf');
chapter = Chapter();
chapter.Title = 'Formal Image Reporter Example';

image = FormalImage();
image.Image = which('ngc6543a.jpg');
text = Text('Cat''s Eye Nebula or NGC 6543');
text.Color = 'red';
image.Caption = text;

add(chapter,image);
add(rpt,chapter);
rptview(rpt);

レポートにイメージを追加し、その配置、表題フォント、余白をオーバーライドします。

次のコマンドを実行して、この例で使用されているサポート ファイルにアクセスします。

openExample('rptgen/MatlabReportGeneratorSupportFilesExample');
import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report('output','pdf');
chapter = Chapter();
chapter.Title = 'Formal Image Reporter Example';

image = FormalImage();
image.Image = which('ngc6543a.jpg');
image.Height = '5in';

para = Paragraph('System Design Description');
para.Style = {HAlign('left'),FontFamily('Arial'),...
     FontSize('12pt'),Color('white'),...
     BackgroundColor('blue'), ...
     OuterMargin('0in', '0in','.5in','1in')};
image.Caption = para;

add(chapter,image);
add(rpt,chapter);
rptview(rpt);

左上にイメージ領域が定義されたイメージ マップを作成し、そのイメージをレポートに追加します。イメージ領域をクリックすると、その領域に関連付けられた Web ページが表示されます。

次のコマンドを実行して、この例で使用されているサポート ファイルにアクセスします。

openExample('rptgen/MatlabReportGeneratorSupportFilesExample');
import mlreportgen.report.*;
rpt = Report('test','pdf');

image = FormalImage(which('ngc6543a.jpg'));
area = mlreportgen.dom.ImageArea('https://www.google.com',...
     'Google',0,0,100,100);
map = mlreportgen.dom.ImageMap;
append(map,area);
image.Map = map;

add(rpt,image);
close(rpt);
rptview(rpt);

バージョン履歴

R2017b で導入