slreportgen.report.ElementDiagram クラス

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

要素のブロック線図のスナップショットと表題のレポーター

説明

Simulink^® または Stateflow^® の要素のブロック線図レポーターを作成します。レポートに追加された ElementDiagram レポーターは要素のスナップショットを作成します。レポーターは、スナップショットをイメージの形式で表題と共にレポートに追加します。Sourceプロパティを使用して目的の要素を指定します。

メモ

レポートで ElementDiagram レポーターを使用するには、slreportgen.report.Report クラスを使用してレポートを作成する必要があります。

slreportgen.report.ElementDiagram クラスは handle クラスです。

作成

説明

diagram = ElementDiagram は、空の要素ブロック線図レポーターを作成します。Simulink または Stateflow の要素のスナップショットを取得するように、そのプロパティを設定します。

例

diagram = ElementDiagram(source) は、source で指定されたブロック線図またはチャートの要素のブロック線図レポーターを作成します。このレポーターをレポートに追加すると、要素のブロック線図のスナップショットが作成され、そのスナップショットが表題と共にレポートに追加されます。スナップショットイメージファイルはレポートの一時フォルダーに格納されます。レポートを閉じると、イメージファイルがレポートにコピーされ、一時フォルダーは削除されます。削除されないようにするには、レポートの Debug プロパティを使用します。mlreportgen.report.Report を参照してください。

例

入力引数

すべて展開する

`source` — ブロック線図要素のソース
文字ベクトル | string スカラー | ハンドル | オブジェクト | `slreportgen.finder.DiagramElementResult` オブジェクト

Source プロパティを参照してください。

プロパティ

すべて展開する

`Source` — ブロック線図要素のソース
文字ベクトル | string スカラー | ハンドル | オブジェクト | `slreportgen.finder.DiagramElementResult` オブジェクト

ブロック線図要素のソース。次の値のいずれかとして指定します。

Simulink ブロックまたは Stateflow チャートブロックのパスを含む文字ベクトルまたは string スカラー
Simulink ブロックまたは Stateflow チャートブロックのハンドル
Stateflow オブジェクト
ブロック、注釈、または Stateflow オブジェクトの Simulink 識別子 (SID)
slreportgen.finder.DiagramElementResult オブジェクト

メモ

Simulink.Port オブジェクトは、このレポーターの有効なソースではありません。

`Snapshot` — スナップショットレポーター
`mlreportgen.report.FormalImage` オブジェクト

スナップショットレポーター。mlreportgen.report.FormalImage オブジェクトとして指定します。FormalImage オブジェクトのプロパティを使用して、スナップショットイメージのキャプションを指定したり、イメージのサイズをさらにカスタマイズしたりします。

メモ

レポーターは Snapshot プロパティを初期化します。このプロパティはリセットしないでください。

属性:

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

`SnapshotFormat` — スナップショットイメージの形式
`"svg"` (既定値) | `"emf"` | `"gif"` | `"jpg"` | ...

スナップショットイメージの形式。次のいずれかの形式として指定します。

インポートするイメージ形式	HTML でのサポート	Word でのサポート	PDF でのサポート	PDF/A でのサポート (R2025a 以降)
Windows^® メタファイル (`.emf`)	なし	あり	なし	なし
グラフィックス交換形式 (`.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 レポートにイメージを含めるには、表にリストされているイメージ形式のいずれかを使用します。

属性:

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

データ型: char | string

`Scaling` — スナップショットイメージのスケーリングオプション
`"auto"` (既定値) | `"custom"` | `"zoom"`

スナップショットイメージのスケーリングオプション。"auto"、"custom"、または"zoom" として指定します。このプロパティは、イメージファイル内のスナップショットイメージのサイズを制御します。サポートされているスケーリングオプションは次のとおりです。

"auto" — PDF または Word (DOCX) 出力の場合、このオプションを使用して、スナップショットイメージを、縦横比を保ちながら現在のページレイアウトに収まるようにスケーリングします。まず、レポーターがスナップショットイメージをページ幅に合わせてスケーリングします。イメージの高さがページの高さを超えると、レポーターはイメージを再び縮小方向にスケーリングします。このさらなるスケーリングにより、イメージを 1 インチの余白を空けて現在のページに収まるようにします。スケーリングは HTML 出力には適用されません。
"custom" — このオプションを使用して、Height プロパティおよび Width プロパティの値に基づいてスナップショットイメージをスケーリングします。
"zoom" — Zoom プロパティで指定されているパーセント値に要素イメージのサイズを拡大または縮小します。イメージの最大高さと最大幅を指定するには、それぞれ MaxHeight プロパティと MaxWidth プロパティを使用します。

メモ

"auto" と "custom" オプションは、MATLAB^® の print コマンドを使用して図のサイズを変更します。図が大きすぎて指定されたスペースに収まらない場合は、print コマンドでスナップショットイメージをトリミングします。トリミングを回避するには、[スケーリング] プロパティを ”なし” に設定し、Snapshot プロパティで指定されているレポーターを使用して画像のサイズを変更します。レポーターはテキストのサイズをイメージの他の部分と一緒に縮小するため、画像を拡大しないと細かい部分が判読できない場合があります。Figure スナップショットイメージのサイズ変更を参照してください。

メモ

次のいずれかのプロパティ設定の組み合わせでは、java.lang.OutOfMemoryError が発生する可能性があります。

Scaling を "zoom" に設定し、かつ Zoom、MaxHeight、および MaxWidth プロパティを大きい値に設定する
Scaling を "custom" に設定し、かつ Height および Width プロパティを大きい値に設定する

このエラーを回避するには、ズームの Scaling には、より小さい Zoom、MaxHeight、および MaxWidth プロパティ値を使用します。Scaling を "custom" に設定している場合は、より小さい Height および Width プロパティ値を使用します。

属性:

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

データ型: char | string

`Height` — スナップショットイメージの高さ
`"6in"` (既定値) | 文字ベクトル | string スカラー

スナップショットイメージの高さ。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"2in" は 2 インチを指定します。既定のスナップショットは 6 インチです。有効な略語は次のとおりです。

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

メモ

PDF イメージの場合、サイズの上限は幅と高さ共に 10,000 ピクセルです。その他のイメージタイプはすべて画面サイズが上限となります。

例: "2in"

属性:

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

データ型: char | string

`Width` — スナップショットイメージの幅
`"6.5in"` (既定値) | 文字ベクトル | string スカラー

スナップショットイメージの幅。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"2in" は 2 インチを指定します。デフォルトのスナップショットの幅は 6.5 インチです。有効な略語は次のとおりです。

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

メモ

PDF イメージの場合、サイズの上限は幅と高さ共に 10,000 ピクセルです。その他のイメージタイプはすべて画面サイズが上限となります。

例: "2in"

属性:

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

データ型: char | string

`Zoom` — スナップショットイメージのズーム量
`"100%"` (既定値) | 文字ベクトル | string スカラー

スナップショットイメージのズーム量。string として指定します。Zoom の形式は "value%" です。ここで、value はスナップショットイメージが拡大または縮小されるパーセントです。

例: "100%"

データ型: char | string

`MaxHeight` — ズームスケーリングの最大高さ
`"6in"` (既定値) | 文字ベクトル | string スカラー

ズームスケーリングの最大高さ。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"10px" は 10 ピクセルを指定します。有効な略語は次のとおりです。

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

メモ

このプロパティは、Scaling が "zoom" に設定されている場合にのみ適用されます。

例: "5in"

データ型: char | string

`MaxWidth` — ズームスケーリングの最大幅
`"6.5in"` (既定値) | 文字ベクトル | string スカラー

ズームスケーリングの最大幅。数値とそれに続く測定単位の略語を含む文字ベクトルまたは string スカラーとして指定します。たとえば、"10px" は 10 ピクセルを指定します。有効な略語は次のとおりです。

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

メモ

このプロパティは、Scaling が "zoom" に設定されている場合にのみ適用されます。

例: "5in"

データ型: 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`

メソッド

すべて展開する

パブリックメソッド

`slreportgen.report.ElementDiagram.createTemplate`	要素のブロック線図テンプレートの作成
`slreportgen.report.ElementDiagram.customizeReporter`	Create custom element diagram reporter class
`slreportgen.report.ElementDiagram.getClassFolder`	要素のブロック線図のクラス定義ファイルの場所
`getSnapshotImage`	Element diagram snapshot image file location
`copy`	Create copy of a Simulink reporter object and make deep copies of certain property values
`getImpl`	レポーターの実装を取得する

例

すべて折りたたむ

要素のブロック線図と表題の追加

import slreportgen.report.*
import mlreportgen.report.*

openExample('f14')

rpt = slreportgen.report.Report("output","pdf");
open(rpt)
chap = Chapter();
chap.Title = "Element Diagram Reporter Example";

diag = ElementDiagram("f14/Actuator Model");
diag.Snapshot.Caption = "f14 Simulink Model - Actuator Model block";

add(chap,diag)
add(rpt,chap)

close(rpt)
rptview(rpt)

Element diagram with caption that reads f14 Simulink Model - Actuator Model block

要素のブロック線図とプロパティテーブルの追加

openExample('f14')
modelsys = "f14/Aircraft Dynamics Model";

rpt = slreportgen.report.Report("output","pdf");
open(rpt)
chapter = mlreportgen.report.Chapter();
chapter.Title = "Element Snapshots";

diag = slreportgen.report.ElementDiagram(modelsys);
add (chapter,diag)

blkfinder = slreportgen.finder.BlockFinder(modelsys);
blks = find(blkfinder);
for blk = blks
   blkDiag = slreportgen.report.ElementDiagram...
       (blk.Object);
   blkDiag.Snapshot.Caption = strcat(blk.DiagramPath,...
       "/", blk.Name);
   add(chapter,blkDiag)   % Add diagram element image
   add(chapter,blk)       % Add property table
end

add(rpt,chapter)
close(rpt)
rptview(rpt)

Element diagram followed by property table

バージョン履歴

R2018b で導入

すべて展開する

R2024b: イメージ出力の BMP の廃止

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

R2019b: `SnapshotFormat` の既定値は、すべてのレポートタイプで `'svg'` です。

R2019b 以降は、Scalable Vector Graphics (SVG) のイメージが Word レポートでサポートされています。すべてのレポートタイプ (HTML、PDF、および Word) で、SnapshotFormat プロパティの既定値は 'svg' であり、値 'auto' は 'svg' を示します。以前のリリースでは、SnapshotFormat プロパティの既定値は 'auto' であり、プラットフォームに応じて HTML レポートおよび PDF レポートの場合は 'svg'、Word レポートの場合は 'emf' または 'png' を示していました。

SVG イメージを含む Word レポートには、Word 2016 以降のバージョンが必要です。MATLAB R2019b 以降のリリースで、以前のバージョンの Word と互換性のあるイメージを含むレポートを生成するには、SnapshotFormat プロパティを 'svg' 以外の値に設定します。以前のリリースの MATLAB で既定で使用されていたイメージ形式を指定するには、SnapshotFormat を次のように設定します。

Windows プラットフォームの場合、"emf"
UNIX^® または Mac プラットフォームの場合、"png"

参考

slreportgen.report.ElementDiagram クラス

説明

作成

説明

入力引数

source — ブロック線図要素のソース 文字ベクトル | string スカラー | ハンドル | オブジェクト | slreportgen.finder.DiagramElementResult オブジェクト

プロパティ

Source — ブロック線図要素のソース 文字ベクトル | string スカラー | ハンドル | オブジェクト | slreportgen.finder.DiagramElementResult オブジェクト

Snapshot — スナップショット レポーター mlreportgen.report.FormalImage オブジェクト

属性:

SnapshotFormat — スナップショット イメージの形式 "svg" (既定値) | "emf" | "gif" | "jpg" | ...

属性:

Scaling — スナップショット イメージのスケーリング オプション "auto" (既定値) | "custom" | "zoom"

属性:

Height — スナップショット イメージの高さ "6in" (既定値) | 文字ベクトル | string スカラー

属性:

Width — スナップショット イメージの幅 "6.5in" (既定値) | 文字ベクトル | string スカラー

属性:

Zoom — スナップショット イメージのズーム量 "100%" (既定値) | 文字ベクトル | string スカラー

MaxHeight — ズーム スケーリングの最大高さ "6in" (既定値) | 文字ベクトル | string スカラー

MaxWidth — ズーム スケーリングの最大幅 "6.5in" (既定値) | 文字ベクトル | string スカラー

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

属性:

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

属性:

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

属性:

メソッド

パブリック メソッド

例

要素のブロック線図と表題の追加

要素のブロック線図とプロパティ テーブルの追加

バージョン履歴

R2024b: イメージ出力の BMP の廃止

R2019b: SnapshotFormat の既定値は、すべてのレポート タイプで 'svg' です。

参考

トピック

`source` — ブロック線図要素のソース
文字ベクトル | string スカラー | ハンドル | オブジェクト | `slreportgen.finder.DiagramElementResult` オブジェクト

`Source` — ブロック線図要素のソース
文字ベクトル | string スカラー | ハンドル | オブジェクト | `slreportgen.finder.DiagramElementResult` オブジェクト

`Snapshot` — スナップショットレポーター
`mlreportgen.report.FormalImage` オブジェクト

`SnapshotFormat` — スナップショットイメージの形式
`"svg"` (既定値) | `"emf"` | `"gif"` | `"jpg"` | ...

`Scaling` — スナップショットイメージのスケーリングオプション
`"auto"` (既定値) | `"custom"` | `"zoom"`

`Height` — スナップショットイメージの高さ
`"6in"` (既定値) | 文字ベクトル | string スカラー

`Width` — スナップショットイメージの幅
`"6.5in"` (既定値) | 文字ベクトル | string スカラー

`Zoom` — スナップショットイメージのズーム量
`"100%"` (既定値) | 文字ベクトル | string スカラー

`MaxHeight` — ズームスケーリングの最大高さ
`"6in"` (既定値) | 文字ベクトル | string スカラー

`MaxWidth` — ズームスケーリングの最大幅
`"6.5in"` (既定値) | 文字ベクトル | string スカラー

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

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

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

パブリックメソッド

要素のブロック線図とプロパティテーブルの追加

R2019b: `SnapshotFormat` の既定値は、すべてのレポートタイプで `'svg'` です。