Main Content

getCaptionReporter

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

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

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

構文

reporter = getCaptionReporter(image)

説明

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

入力引数

すべて展開する

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

出力引数

すべて展開する

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

例

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

既定のスタイルとは異なる表題のスタイルを作成します。この例を実行する前に、MyCaptionTemplate という名前のテンプレートを作成し、その FormalImageCaption スタイルをカスタマイズします。その後、getCaptionReporter メソッドと TemplateSrc プロパティを使用して、テンプレートを使用します。

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

バージョン履歴

R2017b で導入

参考

| |