mlreportgen.dom.Image クラス
パッケージ: mlreportgen.dom
レポートに含めるイメージ
作成
説明
入力引数
imagePath
— イメージ ファイルのパス
文字ベクトル | string スカラー
レポートに含めるイメージ ファイルのパス。文字ベクトルまたは string スカラーとして指定します。この表のイメージ形式を使用できます。
イメージ形式 | ファイル拡張子 | サポートされるドキュメント タイプ | ||
---|---|---|---|---|
HTML | Word | |||
Windows® ビットマップ | .bmp | ![]() | ![]() | ![]() |
Windows メタファイル | .emf | ![]() | ||
Graphics Interchange Format | .gif | ![]() | ![]() | ![]() |
JPEG イメージ | .jpg | ![]() | ![]() | ![]() |
.pdf | ![]() | |||
Portable Network Graphics | .png | ![]() | ![]() | ![]() |
Scalable Vector Graphics | .svg | ![]() | ![]() | ![]() |
TIFF イメージ | .tif | ![]() | ![]() |
プロパティ
Path
— イメージ ファイルのパス
文字ベクトル
イメージ ファイルのパス。文字ベクトルして指定します。このプロパティは読み取り専用です。
Height
— イメージの高さ
文字ベクトル | string スカラー
イメージの高さ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、"2in"
は 2 インチを指定します。有効な略語を以下に示します。
px
— ピクセル (既定)cm
— センチメートルin
— インチmm
— ミリメートルpc
— パイカpt
— ポイント%
— 割合
Image
オブジェクトが作成されると、Height
プロパティは、Path
プロパティで指定されたイメージ ファイルに基づく値に設定されます。
Width
— イメージの幅
文字ベクトル | string スカラー
イメージの幅。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、"2in"
は 2 インチを指定します。有効な略語を以下に示します。
px
— ピクセル (既定)cm
— センチメートルin
— インチmm
— ミリメートルpc
— パイカpt
— ポイント%
— 割合
Image
オブジェクトが作成されると、Width
プロパティは、Path
プロパティで指定されたイメージ ファイルに基づく値に設定されます。
Map
— イメージのハイパーリンク領域のマップ
mlreportgen.dom.ImageMap
オブジェクト
このイメージのハイパーリンク領域のマップ。mlreportgen.dom.ImageMap
オブジェクトとして指定します。Map
プロパティは、HTML レポートと PDF レポートにのみ適用されます。
イメージ マップの作成を参照してください。
StyleName
— イメージ スタイルの名前
文字ベクトル | string スカラー
イメージ スタイルの名前。文字ベクトルまたは string スカラーとして指定します。StyleName
値は、このイメージを追加するドキュメントまたはドキュメント パーツのスタイル シートのスタイルでなければなりません。この Image
オブジェクトの Style
プロパティの書式オブジェクトは、スタイル シートのスタイルをオーバーライドします。
メモ
StyleName
プロパティは、Word 出力では無視されます。
Style
— イメージ スタイルを定義する書式設定
DOM 書式オブジェクトの cell 配列
このイメージのスタイルを定義する書式。DOM 書式オブジェクトの cell 配列として指定します。この書式は、StyleName
プロパティで指定したスタイルで定義した対応する書式をオーバーライドします。イメージの作成と書式設定を参照してください。
CustomAttributes
— ドキュメント要素のカスタム属性
mlreportgen.dom.CustomAttribute
オブジェクトの配列
このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute
オブジェクトの配列として指定します。カスタム属性は、出力形式でサポートされていなければなりません。
Parent
— イメージの親
ドキュメント要素オブジェクト
このイメージの親。ドキュメント要素オブジェクトとして指定します。このプロパティは読み取り専用です。
Children
— このプロパティは無視されます
ドキュメント要素オブジェクトの配列
このプロパティは無視されます。
Tag
— このドキュメント要素のタグ
文字ベクトル | string スカラー
このドキュメント要素のタグ。文字ベクトルまたは string スカラーとして指定します。
DOM は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id
プロパティの値です。独自のタグ値を指定すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。
Id
— このドキュメント要素の ID
文字ベクトル | string スカラー
このドキュメント要素の 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: Word レポートの SVG イメージのサポート
R2019b 以降、Word レポートに Scalable Vector Graphics (SVG) イメージを含めることができるようになりました。SVG イメージを含む Word レポートには、Microsoft® Word 2016 以降が必要です。これより前のバージョンの Word との互換性があるイメージでレポートを生成するには、SVG 以外の形式のイメージから mlreportgen.dom.Image
オブジェクトを作成します。
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)