mlreportgen.dom.Image クラス

名前空間: mlreportgen.dom

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

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

説明

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

mlreportgen.dom.Image オブジェクトを追加できる DOM オブジェクトを確認するには、mlreportgen.dom.Image オブジェクトを DOM クラス オブジェクトに追加を参照してください。

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

クラス属性

ConstructOnLoad
true
HandleCompatible
true

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

作成

説明

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

メモ

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

例

入力引数

すべて展開する

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

インポート イメージ形式ファイル拡張子HTML でサポートWord でサポートPDF でサポート

PDF/A でサポート (R2025a 以降)

Windows® メタファイル.emfいいえはいいいえいいえ
Graphics Interchange Format .gifはいはいはいはい
JPEG イメージ.jpgはいはいはいいいえ
PDF.pdfいいえいいえはいいいえ
PDF/A.pdfいいえいいえはいいいえ
Portable Network Graphics (.png).pngはいはいはいはい
Scalable Vector Graphics.svgはいはいはいはい
TIFF イメージ.tifいいえはいはいはい

メモ

PDF レポート出力形式とは異なり、PDF/A 形式では PDF または PDF/A イメージを含めることはできません。PDF/A レポートにイメージを含めるには、この表に記載されているイメージ形式のいずれかを使用します。

プロパティ

すべて展開する

イメージ ファイルのパス。文字ベクトルまたは string スカラーとして指定します。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true
Transient
true

データ型: char | string

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

  • 略語なし — ピクセル

  • px — ピクセル

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

  • % — 割合

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

mlreportgen.dom.Image オブジェクトの Style プロパティを設定すると、このプロパティ値は、設定したスタイルの高さによってオーバーライドされます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

  • 略語なし — ピクセル

  • px — ピクセル

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

  • % — 割合

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

mlreportgen.dom.Image オブジェクトの Style プロパティを設定すると、このプロパティ値は、設定したスタイルの幅によってオーバーライドされます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

SVG ファイルを埋め込むかどうか。logical の 1 (true) または 0 (false) として指定します。指定内容は以下のとおりです。

  • 1 (true) — 生成された HTML レポート ファイルには、SVG ファイルのコピーを含む生成された HTML レポート ファイルが含まれます。イメージの検索はできますが、CSS 書式設定に依存する SVG イメージが正しくレンダリングされない可能性があります。

  • 0 (false) — レポートは CSS を使用して SVG イメージをレンダリングします。イメージの検索はできません。

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: logical

スタイルシート定義スタイル名。文字ベクトルまたは string スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。

メモ

Microsoft® Word レポートでは、ドキュメント テンプレートで定義されていないスタイル名は無視されます。Microsoft Word テンプレートの詳細については、DOM API レポート プログラムのテンプレートを参照してください。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: cell

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

属性:

GetAccess
public
SetAccess
public
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 で導入

すべて展開する

参考

| | | |

トピック