getCaptionReporter

クラス: mlreportgen.report.FormalImage
名前空間: mlreportgen.report

イメージ表題レポーターの取得

構文

reporter = getCaptionReporter(image)


説明

reporter = getCaptionReporter(image) は、mlreportgen.report.FormalImage の Caption プロパティに基づいて形式的イメージの表題を生成するレポーターを返します。DOM 段落に追加できる任意の MATLAB^® オブジェクトまたは DOM オブジェクトを表題とすることができます。表題の書式は、テンプレート内の対応する書式をオーバーライドします。表題の既定の書式をオーバーライドするには、この getCaptionReporter メソッドを使用します。

入力引数

image — イメージのソース

文字ベクトル | 文字配列 | DOM Image オブジェクト

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

出力引数

reporter — 形式的イメージ表題レポーター

レポーター オブジェクト

イメージの形式的イメージ表題レポーター。レポーター オブジェクトとして返されます。

例

既定以外の表題スタイルの使用

既定のスタイルとは異なる表題のスタイルを作成します。

1. MyCaptionTemplate という名前のテンプレートを作成します。

2. FormalImageCaption スタイルをカスタマイズします。

3. getCaptionReporter メソッドと TemplateSrc プロパティを使用して、独自のテンプレートを使用します。

   import mlreportgen.report.*
   rpt = Report();
   image = FormalImage();
   captionReporter = getCaptionReporter(image);
   image.TemplateSrc = "MyCaptionTemplate";
   add(rpt,image);
   

バージョン履歴

R2017b で導入

参考

mlreportgen.report.FormalImage | mlreportgen.report.Reporter | mlreportgen.report.Report