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 スカラーとして指定します。この表のイメージ形式を使用できます。

イメージ形式ファイル拡張子HTML でサポートWord でサポートPDF でサポート
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 レポートにのみ適用されます。

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

SVG ファイルを埋め込むかどうか。true または false として指定します。このプロパティが false の場合、レポートは CSS を使用して SVG イメージをレンダリングします。このプロパティが false に設定されている場合、イメージの検索はできません。true の場合、生成された HTML レポート ファイルには、SVG ファイルのコピーを含む生成された HTML レポート ファイルが含まれます。このプロパティが true の場合、イメージの検索はできますが、CSS 書式設定に依存する SVG イメージが正しくレンダリングされない可能性があります。

メモ

EmbedSVG プロパティは、HTML レポートにのみ適用されます。

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

メモ

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

このドキュメント要素オブジェクトの書式指定。書式オブジェクトの配列として指定します。このプロパティで指定された書式は、この要素の StyleName プロパティで指定された対応する書式をオーバーライドします。この要素に適用されない書式は無視されます。

属性:

NonCopyable
true

データ型: cell

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

属性:

NonCopyable
true

mlreportgen.dom.Image オブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。

属性:

SetAccess
private
NonCopyable
true

クラスはこのプロパティを無視します。

属性:

SetAccess
private
NonCopyable
true

mlreportgen.dom.Image オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメント生成中に問題が発生したときにどこを確認すればよいかを特定しやすくなります。

属性:

NonCopyable
true

データ型: char | string

mlreportgen.dom.Image オブジェクトのオブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。Id には独自の値を指定できます。

属性:

NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

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");

Figure contains an axes object. The axes object contains an object of type line.

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

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

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

close(d);
rptview(d);

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

バージョン履歴

R2014b で導入

すべて展開する

参考

| | | |

トピック