最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

mlreportgen.report.Figure クラス

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

説明

タイトル、図、および表題が付いた Figure レポーターを作成します。

構築

fig = Figure() は、MATLAB® で現在開いている Figure スナップショットを作成するレポーターを作成し、レポートに追加します。Figure プロパティを使用して、表題を追加したり、Figure のサイズを変更します。スナップショットのイメージは、レポートの一時フォルダーに保存されます。レポートを閉じると、スナップショット イメージがレポートにコピーされた後にそのイメージが一時フォルダーから削除されます。スナップショット イメージ ファイルが削除されないようにするには、レポートの Debug プロパティを使用します。mlreportgen.report.Report を参照してください。

fig = Figure(source) は、source によって指定された Figure を追加するレポーターを作成します。

fig = Figure(Name,Value) は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順番で指定できます。各プロパティ名は一重引用符または二重引用符で囲みます。

入力引数

すべて展開する

Source プロパティを参照してください。

プロパティ

すべて展開する

Figure のイメージ。mlreportgen.report.FormalImage レポーター クラスとして指定します。レポーターは、gcf を使用して、現在の MATLAB Figure を取得します。形式的イメージ レポーターを使用して、Figure をレポートに挿入します。Figure レポーターは、Snapshot プロパティを初期化します。このプロパティをリセットしないでください。FormalImage オブジェクトのプロパティを使用して、スナップショットのサイズまたはその表題を指定します。

Figure のソース。有効な Figure のファイルまたは有効なグラフィックス ハンドルへのパスを示す string または文字配列として指定します。

スナップショットのイメージ形式。string または文字配列として指定します。以下はサポートされる形式です。

  • auto — HTML または PDF 出力に対して .svg 形式を使用します。Windows 上で Word 出力に対して .emf 形式を使用します。Unix または Mac 上で Word 出力に対して .png を使用します。

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

  • .gif— グラフィックス交換形式

  • .jpg — JPEG イメージ

  • .png — PNG イメージ

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

  • .svg — Scalable Vector Graphics

  • .tif — タグ イメージのファイル形式。HTML 出力ではサポートされません。

  • .pdf — PDF イメージ

Figure スナップショット イメージのスケーリング オプション。string の auto または custom として指定します。Scaling は、イメージ ファイルの Figure スナップショット イメージのサイズを制御します。

  • auto — PDF または Word (docx) 出力の場合、縦横比を保持して現在のページ レイアウトに合わせて Figure スナップショット イメージをスケーリングします。最初に、Figure スナップショット イメージはページ幅にスケーリングされます。イメージの高さがページの高さを超える場合、イメージは再度スケール ダウンします。この追加のスケーリングでイメージは余分に 1 インチの間を空けて現在のページに収まるようになります。余分の空きは、表題のような追加のテキストに使用できます。スケーリングは HTML 出力には適用されません。

  • customHeight および Width プロパティの値を基にして Figure スナップショット イメージをスケーリングします。

メモ

java.lang.OutOfMemoryError は、Scalingcustom に設定して、HeightWidth プロパティの値が大きくなった場合に発生する可能性があります。このエラーを防ぐには、より小さい HeightWidth 値を使用して、Figure がページに確実に収まるようにします。

カスタムのスケーリングのスナップショット イメージの高さ。string として指定します。このプロパティは、Scalingcustom に設定した場合にのみ適用されます。

Height 形式は、valueUnits です。ここで Units は高さの単位の略語で、value は単位数です。次の表に有効な Units 略語を示します。

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

カスタムのスケーリングのスナップショット イメージの幅。string として指定します。このプロパティは、Scalingcustom に設定した場合にのみ適用されます。

The Width format is valueUnits, where Units is an abbreviation for the width units and value is the number of units.有効な Units の略語のテーブルについては Height プロパティを参照してください。

このレポーターのテンプレートのソース。以下のいずれかの値として指定します。

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

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

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

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

このレポーターのテンプレートの名前。string または文字配列として指定します。このレポーターのテンプレートは、このレポーター用のテンプレート ソース (TemplateSrc) のテンプレート ライブラリにあります。

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

メソッド

createTemplate Create figure template
customizeReporter Create custom figure reporter class
getClassFolder Figure class definition file location
getSnapshotImageGet snapshot image path

継承メソッド

customizeReporterCreate class derived from Reporter class
getImpl Get implementation of reporter

コピーのセマンティクス

ハンドル。ハンドル クラスがコピー操作にどのように影響するかについては、オブジェクトのコピー (MATLAB)を参照してください。

レポートへの表面プロット Figure の追加

表面プロットの Figure をレポートに追加して、その表題と高さを設定します。

import mlreportgen.report.*
surf(peaks);
rpt = Report('peaks');
chapter = Chapter();
chapter.Title = 'Figure Example';
add(rpt,chapter);

fig = Figure();
fig.Snapshot.Caption = '3-D shaded surface plot';
fig.Snapshot.Height = '5in';

add(rpt,fig);
delete(gcf);
rptview(rpt);

レポート ページへの 2 つの Figure の追加

レポートに 2 つの Figure を追加します。ページ上で隣どうしに配置するには、DOM Table オブジェクトを使用します。

import mlreportgen.report.*
import mlreportgen.dom.*
rpt = Report('peaks');

surf(peaks(20));
figure = Figure();
peaks20 = Image(getSnapshotImage(figure,report));
peaks20.Width = '3in';
peaks20.Height = [];

surf(peaks(40));
figure = Figure();
peaks40 = Image(getSnapshotImage(figure,report));
peaks40.Width = '3in';
peaks40.Height = [];
delete(gcf);

t = Table({peaks20,peaks40;'peaks(20)','peaks(40)'});
add(rpt,t);
close(rpt);
rptview(rpt);

R2017b で導入