Main Content

mlreportgen.dom.Image クラス

パッケージ: mlreportgen.dom

レポートに含めるイメージ

説明

mlreportgen.dom.Image クラスのオブジェクトを使用して、イメージをレポートに含めます。

mlreportgen.dom.Image クラスは handle クラスです。

クラス属性

ConstructOnLoad
true
HandleCompatible
true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

imageObj = mlreportgen.dom.Image(imagePath) は、Path プロパティがイメージのパスに設定された mlreportgen.dom.Image オブジェクトを作成します。

メモ

指定されたイメージ ファイルのコンテンツは、ドキュメントが閉じるときに出力ドキュメントにコピーされます。ドキュメントを閉じる前に、イメージ ファイルを削除したり上書きしたりしないでください。イメージ ファイルと、対応する mlreportgen.dom.Image オブジェクトをループ内に作成する場合は、ループの反復ごとに、イメージ ファイルに一意のファイル名を使用します。

入力引数

すべて展開する

レポートに含めるイメージ ファイルのパス。文字ベクトルまたは string スカラーとして指定します。この表のイメージ形式を使用できます。

イメージ形式ファイル拡張子サポートされるドキュメント タイプ
HTMLWordPDF
Windows® ビットマップ.bmp
Windows メタファイル.emf  
Graphics Interchange Format .gif
JPEG イメージ.jpg
PDF.pdf  
Portable Network Graphics .png
Scalable Vector Graphics.svg
TIFF イメージ.tif 

プロパティ

すべて展開する

イメージ ファイルのパス。文字ベクトルして指定します。このプロパティは読み取り専用です。

イメージの高さ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、"2in" は 2 インチを指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

  • % — 割合

Image オブジェクトが作成されると、Height プロパティは、Path プロパティで指定されたイメージ ファイルに基づく値に設定されます。

イメージの幅。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、"2in" は 2 インチを指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

  • % — 割合

Image オブジェクトが作成されると、Width プロパティは、Path プロパティで指定されたイメージ ファイルに基づく値に設定されます。

このイメージのハイパーリンク領域のマップ。mlreportgen.dom.ImageMap オブジェクトとして指定します。Map プロパティは、HTML レポートと PDF レポートにのみ適用されます。

イメージ マップの作成を参照してください。

イメージ スタイルの名前。文字ベクトルまたは string スカラーとして指定します。StyleName 値は、このイメージを追加するドキュメントまたはドキュメント パーツのスタイル シートのスタイルでなければなりません。この Image オブジェクトの Style プロパティの書式オブジェクトは、スタイル シートのスタイルをオーバーライドします。

メモ

StyleName プロパティは、Word 出力では無視されます。

このイメージのスタイルを定義する書式。DOM 書式オブジェクトの cell 配列として指定します。この書式は、StyleName プロパティで指定したスタイルで定義した対応する書式をオーバーライドします。イメージの作成と書式設定を参照してください。

このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、出力形式でサポートされていなければなりません。

このイメージの親。ドキュメント要素オブジェクトとして指定します。このプロパティは読み取り専用です。

このプロパティは無視されます。

このドキュメント要素のタグ。文字ベクトルまたは string スカラーとして指定します。

DOM は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。

このドキュメント要素の ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。

メソッド

すべて展開する

すべて折りたたむ

mlreportgen.dom.Image オブジェクトを使用して、レポートに含めるイメージを指定します。Image オブジェクトをレポートに追加して、イメージをレポートに含めます。

長い完全修飾クラス名を使用せずに済むよう、DOM パッケージをインポートします。

import mlreportgen.dom.*

レポートを作成し、mlreportgen.dom.Paragraph オブジェクトを使用してイメージのタイトルを追加します。

d = Document("myImageReport","docx");

p = Paragraph("Plot 1");
p.Bold = true;
append(d,p);

プロットをイメージ ファイルとして保存します。

x = 0:pi/100:2*pi;
y = sin(x);
plot(x,y);

saveas(gcf,"myPlot_img.png");

イメージ ファイルのパスを指定する mlreportgen.dom.Image オブジェクトを作成します。幅と高さを 4 インチと指定します。Image オブジェクトをレポートに追加します。

plot1 = Image("myPlot_img.png");
plot1.Width = "4in";
plot1.Height = "4in";
append(d,plot1);

レポートを閉じて表示します。

close(d);
rptview(d);

生成されたレポートのイメージは次のようになります。

バージョン履歴

R2014b で導入

すべて展開する

R2019b での動作変更