mlreportgen.report.FormalImage クラス

名前空間: mlreportgen.report
スーパークラス: mlreportgen.report.Reporter

表題付きイメージレポーター

説明

表題付きイメージのレポーターを作成します。

mlreportgen.report.FormalImage クラスは handle クラスです。

作成

説明

image = FormalImage は、空のイメージレポーターを作成します。レポーターのプロパティを使用して、イメージのソース、表題、高さ、幅などを設定します。レポーターは、テンプレートを使用して、表題の書式設定と番号付けを行い、イメージを基準に表題を配置します。書式をカスタマイズするには、カスタムテンプレートを指定するか、このレポーターのプロパティを使用してテンプレートをプログラムでオーバーライドします。

例

image = FormalImage(source) は、source によって指定されたイメージをレポートに追加するイメージレポーターを作成します。Image プロパティを参照してください。

例

image = FormalImage(Name=Value) は、名前と値の引数を使用してプロパティを設定します。複数の名前と値の引数を任意の順番で指定できます。

入力引数

すべて展開する

`source` — イメージのソース
文字ベクトル | string スカラー | DOM Image オブジェクト

レポートに追加するイメージのソース。string または文字ベクトルとして指定するか、DOM Image オブジェクトとして指定します。Image プロパティを参照してください。

プロパティ

すべて展開する

`Image` — イメージのソース
`[]` (既定値) | 文字ベクトル | string スカラー | DOM Image オブジェクト

レポートに追加するイメージのソース。文字配列、string スカラーまたは 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`)	はい	はい	はい	はい
Scalable Vector Graphics (`.svg`)	はい	はい	はい	はい
TIFF イメージ (`.tif`)	いいえ	はい	はい	はい

メモ

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

このレポーターは、レポーターのテンプレートによってスタイルが指定されている段落に、指定されたイメージを挿入します。段落スタイルによって、表題を基準にしたイメージの配置と間隔が決まります。配置と間隔をカスタマイズするには、レポーターのテンプレートライブラリにある FormalImage テンプレートをカスタマイズします。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

`Caption` — この形式的イメージの表題
`[]` (既定値) | 文字ベクトル | string スカラー | ...

この形式的イメージの表題。次の値のいずれかとして指定します。

string または文字ベクトル
DOM オブジェクト
string または DOM オブジェクトから成る 1 行 N 列または N 行 1 列の配列
string、文字ベクトル、DOM オブジェクトのいずれか、またはこれらの組み合わせから成る 1 行 N 列または N 行 1 列の cell 配列
getCaptionReporter メソッドによって返されるホールレポーター

表題には自動的に番号が付けられ、イメージの下に配置されます。

インラインコンテンツは、段落が含むことのできるコンテンツです。表題の値がインラインコンテンツの場合、レポーターはテンプレートライブラリに保存されているテンプレートを使用して表題を書式設定します。テンプレートは、イメージが番号付きの章にあるか番号なしの章にあるかによって異なる書式を使用して、表題に自動的に番号を付けます。

番号付きの章のイメージは、"Figure N.M" という形式の表題テキストの接頭辞をもちます。ここで、N は章番号、M は章内の Figure の番号です。たとえば、レポートの 2 番目の章にある 3 番目のイメージの接頭辞は Figure 2.3 になります。
番号なしの章のイメージは、"Figure N" という形式の表題テキストの接頭辞をもちます。ここで、N は、レポートの最初のイメージでは 1 になり、2 番目のイメージでは 2 になります (以下同様)。

英語以外の多くのロケールでは、表題の接頭辞がロケールの言語と形式に変換されます。変換済みロケールのリストについては、mlreportgen.report.Report の Locale プロパティを参照してください。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`Width` — このイメージの幅
`[]` | 文字ベクトル | string スカラー

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

px — ピクセル
cm — センチメートル
in — インチ
mm — ミリメートル
pc — パイカ
pt — ポイント
% — 割合

イメージの幅を設定して高さを設定しない場合、イメージの縦横比を維持するために高さがスケーリングされます。

メモ

このプロパティは、ソースがイメージパスとして指定されている形式的イメージにのみ適用されます。

例: 5in

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`Height` — このイメージの高さ
`[]` | 文字ベクトル | string スカラー

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

px — ピクセル
cm — センチメートル
in — インチ
mm — ミリメートル
pc — パイカ
pt — ポイント
% — 割合

イメージの高さを設定して幅を設定しない場合、イメージの縦横比を維持するために幅がスケーリングされます。

メモ

このプロパティは、ソースがイメージパスとして指定されている形式的イメージにのみ適用されます。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`ScaleToFit` — イメージのスケーリング
true (既定値) | false

この形式的イメージをスケーリングするかどうか。logical 値として指定します。このプロパティは、Microsoft^® Word のページ、PDF のページ、またはテーブルエントリの余白と余白の間に収まるようにイメージをスケーリングするかどうかを指定します。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: logical

`Map` — イメージのハイパーリンク領域のマップ
`[]` (既定値) | `mlreportgen.dom.ImageMap` オブジェクト

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

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`TemplateSrc` — このレポーターのテンプレートのソース
文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメントパーツ

このレポーターのテンプレートのソース。次のいずれかの方法で指定します。

このレポーターのテンプレートを含むファイルのパスを指定する文字ベクトルまたは string スカラー
このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレートライブラリに含む、レポーターまたはレポート
このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレートライブラリに含む、ドキュメントオブジェクトモデル (DOM) ドキュメントまたはドキュメントパーツ

指定するテンプレートは、このレポーターを追加するレポートと同じタイプでなければなりません。たとえば、Microsoft Word レポートでは、TemplateSrc は Word レポーターテンプレートでなければなりません。TemplateSrc プロパティが空の場合、このレポーターはレポートの出力タイプに既定のレポーターテンプレートを使用します。

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`TemplateName` — このレポーターのテンプレートの名前
文字ベクトル | string スカラー

このレポーターのテンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーターのテンプレートは、このレポーターの TemplateSrc プロパティで指定されたテンプレートのテンプレートライブラリになければなりません。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`LinkTarget` — このレポーターのハイパーリンクターゲット
`[]` (既定値) | 文字ベクトル | string スカラー | `mlreportgen.dom.LinkTarget` オブジェクト

このレポーターのハイパーリンクターゲット。リンクターゲット ID を指定する文字ベクトルもしくは string スカラー、または mlreportgen.dom.LinkTarget オブジェクトとして指定します。文字ベクトルまたは string スカラー値は LinkTarget オブジェクトに変換されます。リンクターゲットは、出力レポートでこのレポーターのコンテンツの直前にあります。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

メソッド

すべて展開する

パブリックメソッド

メソッド	目的
`getImageReporter`	形式的イメージレポーターの取得
`getCaptionReporter`	イメージ表題レポーターの取得
`mlreportgen.report.FormalImage.createTemplate`	`template = mlreportgen.report.FormalImage.createTemplate(path,type)` レポーターテンプレートの作成入力引数 `path`。テンプレートファイルのターゲットパスとファイル名 `type`。テンプレートタイプ (`"html"`、`"docx"`、または `"pdf"` として指定) 戻り値 `template` — テンプレートのコピーのパスとファイル名。string スカラーとして返されます。詳細については、`Reporter` クラスの同等のメソッド `mlreportgen.report.Reporter.createTemplate` を参照してください。
`mlreportgen.report.FormalImage.customizeReporter`	`reporter` `= mlreportgen.report.FormalImage.customizeReporter(classpath)` `mlreportgen.report.FormalImage` クラスから派生させたレポーターの作成戻り値 `reporter` — 新しいレポータークラスのパスとファイル名。string スカラーとして返されます。詳細については、`Reporter` クラスの同等のメソッド `mlreportgen.report.Reporter.customizeReporter` を参照してください。
`mlreportgen.report.FormalImage.getClassFolder`	`path = mlreportgen.report.FormalImage.getClassFolder` `mlreportgen.report.FormalImage` クラス定義ファイルが含まれるフォルダーの場所の取得戻り値 `path` — クラス定義ファイルの場所。文字ベクトルとして返されます。詳細については、`Reporter` クラスの同等のメソッド `mlreportgen.report.Reporter.getClassFolder` を参照してください。
`copy`	レポーターオブジェクトのコピーの作成および特定のプロパティ値のディープコピーの作成
`getImpl`	レポーターの実装の取得

例

すべて折りたたむ

レポートへのイメージの追加

ライブスクリプトを開く

空のイメージレポーターをレポートに追加し、そのソース、表題、および高さを設定します。

import mlreportgen.report.*
rpt = mlreportgen.report.Report('output','pdf');
chapter = mlreportgen.report.Chapter();
chapter.Title = 'Formal Image Reporter Example';

image = mlreportgen.report.FormalImage();
image.Image = which('ngc6543a.jpg');
image.Caption = 'Cat''s Eye Nebula or NGC 6543';
image.Height = '5in';

add(chapter,image);
add(rpt,chapter);
rptview(rpt);

イメージ表題の色の変更

ライブスクリプトを開く

レポートにイメージを追加します。既定の書式設定を使用しますが、表題のテキストの色を赤に変更します。

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report('output','pdf');
chapter = Chapter();
chapter.Title = 'Formal Image Reporter Example';

image = FormalImage();
image.Image = which('ngc6543a.jpg');
text = Text('Cat''s Eye Nebula or NGC 6543');
text.Color = 'red';
image.Caption = text;

add(chapter,image);
add(rpt,chapter);
rptview(rpt);

イメージと表題の書式の変更

ライブスクリプトを開く

レポートにイメージを追加し、その配置、表題フォント、余白をオーバーライドします。

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report('output','pdf');
chapter = Chapter();
chapter.Title = 'Formal Image Reporter Example';

image = FormalImage();
image.Image = which('ngc6543a.jpg');
image.Height = '5in';

para = Paragraph('System Design Description');
para.Style = {HAlign('left'),FontFamily('Arial'),...
     FontSize('12pt'),Color('white'),...
     BackgroundColor('blue'), ...
     OuterMargin('0in', '0in','.5in','1in')};
image.Caption = para;

add(chapter,image);
add(rpt,chapter);
rptview(rpt);

イメージマップの作成

ライブスクリプトを開く

左上にイメージ領域が定義されたイメージマップを作成し、そのイメージをレポートに追加します。イメージ領域をクリックすると、その領域に関連付けられた Web ページが表示されます。

import mlreportgen.report.*;
rpt = Report('test','pdf');

image = FormalImage(which('ngc6543a.jpg'));
area = mlreportgen.dom.ImageArea('https://www.google.com',...
     'Google',0,0,100,100);
map = mlreportgen.dom.ImageMap;
append(map,area);
image.Map = map;

add(rpt,image);
close(rpt);
rptview(rpt);

バージョン履歴

R2017b で導入

すべて展開する

R2024b: イメージ出力における BMP の廃止

Report Generator で、出力イメージ形式の BMP (ビットマップ) がサポートされなくなりました。これは、レポートエクスプローラーと API (レポート、DOM、PPT) の両方で、スナップショット、ファイルからのイメージ、透かしに影響します。詳細については、print を参照してください。

参考

トピック

レポーターとは

mlreportgen.report.FormalImage クラス

説明

作成

説明

入力引数

source — イメージのソース 文字ベクトル | string スカラー | DOM Image オブジェクト

プロパティ

Image — イメージのソース [] (既定値) | 文字ベクトル | string スカラー | DOM Image オブジェクト

属性:

Caption — この形式的イメージの表題 [] (既定値) | 文字ベクトル | string スカラー | ...

属性:

Width — このイメージの幅 [] | 文字ベクトル | string スカラー

属性:

Height — このイメージの高さ [] | 文字ベクトル | string スカラー

属性:

ScaleToFit — イメージのスケーリング true (既定値) | false

属性:

Map — イメージのハイパーリンク領域のマップ [] (既定値) | mlreportgen.dom.ImageMap オブジェクト

属性:

TemplateSrc — このレポーターのテンプレートのソース 文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメント パーツ

属性:

TemplateName — このレポーターのテンプレートの名前 文字ベクトル | string スカラー

属性:

LinkTarget — このレポーターのハイパーリンク ターゲット [] (既定値) | 文字ベクトル | string スカラー | mlreportgen.dom.LinkTarget オブジェクト

属性:

メソッド

パブリック メソッド

例

レポートへのイメージの追加

イメージ表題の色の変更

イメージと表題の書式の変更

イメージ マップの作成

バージョン履歴

R2024b: イメージ出力における BMP の廃止

参考

トピック

`source` — イメージのソース
文字ベクトル | string スカラー | DOM Image オブジェクト

`Image` — イメージのソース
`[]` (既定値) | 文字ベクトル | string スカラー | DOM Image オブジェクト

`Caption` — この形式的イメージの表題
`[]` (既定値) | 文字ベクトル | string スカラー | ...

`Width` — このイメージの幅
`[]` | 文字ベクトル | string スカラー

`Height` — このイメージの高さ
`[]` | 文字ベクトル | string スカラー

`ScaleToFit` — イメージのスケーリング
true (既定値) | false

`Map` — イメージのハイパーリンク領域のマップ
`[]` (既定値) | `mlreportgen.dom.ImageMap` オブジェクト

`TemplateSrc` — このレポーターのテンプレートのソース
文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメントパーツ

`TemplateName` — このレポーターのテンプレートの名前
文字ベクトル | string スカラー

`LinkTarget` — このレポーターのハイパーリンクターゲット
`[]` (既定値) | 文字ベクトル | string スカラー | `mlreportgen.dom.LinkTarget` オブジェクト

パブリックメソッド

イメージマップの作成