mlreportgen.report.Figure クラス
名前空間: mlreportgen.report
スーパークラス: mlreportgen.report.Reporter
Figure レポーター
説明
作成
説明
fig = mlreportgen.report.Figure は、MATLAB® で現在開かれている Figure のスナップショットを作成し、それをレポートに追加するレポーターを作成します。表題を追加したり、Figure のサイズを変更したりするには、Figure のプロパティを使用します。スナップショット イメージはレポートの一時フォルダーに保存されます。レポートを閉じると、スナップショット イメージがレポートにコピーされ、一時フォルダーからイメージが削除されます。スナップショット イメージ ファイルが削除されないようにするには、レポートの Debug プロパティを使用します。mlreportgen.report.Report を参照してください。
fig = mlreportgen.report.Figure(source) は、source で指定された Figure を追加し、Source プロパティを source に設定するレポーターを作成します。
fig = mlreportgen.report.Figure(Name=Value) は、名前と値の引数を使用してプロパティを設定します。複数の名前と値の引数を任意の順番で指定できます。
プロパティ
メソッド
例
レポートに表面プロットの 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 を追加します。ページ上でそれらを隣どうしに配置するには、DOM テーブル オブジェクトを使用します。
import mlreportgen.report.* import mlreportgen.dom.* rpt = Report('peaks'); surf(peaks(20)); figure = Figure(); peaks20 = Image(getSnapshotImage(figure,rpt)); peaks20.Width = '3in'; peaks20.Height = []; delete(gcf); surf(peaks(40)); figure = Figure(); peaks40 = Image(getSnapshotImage(figure,rpt)); peaks40.Width = '3in'; peaks40.Height = []; delete(gcf); t = Table({peaks20,peaks40;'peaks(20)','peaks(40)'}); add(rpt,t); close(rpt); rptview(rpt);
この例では、print コマンドを使用して Figure のスナップショット イメージをサイズ変更する場合と、Figure レポーターの Snapshot プロパティで指定されたレポーターを使用してサイズ変更する場合の違いを示す PDF レポートを生成します。
幅広の MATLAB® Figure を作成します。Figure から 3 つの mlreportgen.report.Figure レポーターを作成し、それらをレポートに追加します。
最初の
Figureレポーターは Figure のサイズを変更しません。2 番目の
Figureレポーターは、printコマンドを使用して Figure のサイズを変更します。3 番目の
Figureレポーターは、Snapshotレポーターを使用して Figure のサイズを変更します。
import mlreportgen.report.* fig = figure(); ax = axes(fig); plot(ax, rand(1,100)); pos = fig.Position; fig.Position = [pos(1) pos(2) 2*pos(3) pos(4)]; rpt = Report('example','pdf'); add(rpt, "Intrinsic figure size"); figReporter0 = Figure(fig); figReporter0.Scaling = 'none'; add(rpt,figReporter0); add(rpt, "Resized by print command"); figReporter1 = Figure(fig); add(rpt,figReporter1); add(rpt, "Resized by snapshot reporter"); figReporter2 = Figure(fig); figReporter2.Scaling = 'none'; figReporter2.Snapshot.ScaleToFit = true; add(rpt,figReporter2);
close(rpt); delete(fig) rptview(rpt);
生成されたレポートの Figure は次のようになります。
制限
モニターのないサーバー上でレポートを生成する場合、
Figureレポーターはスナップショットを取得できません。
ヒント
Report Generator は、Scaling プロパティの値に基づいて、Figure スナップショットの幅と高さを計算します。凡例は、座標軸や Figure のコンテンツと緊密に結び付いていないフローティング要素です。
Scalingの値を使用して Figure の寸法を調整すると、レポート内の凡例の位置が Figure ウィンドウ内の位置に対してずれる場合があります。
