このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。
mlreportgen.dom.Document クラス
パッケージ: mlreportgen.dom
ドキュメント コンテナー
説明
mlreportgen.dom.Document
クラスのオブジェクトを使用して、ドキュメント オブジェクト モデル (DOM) ドキュメントを表します。Document
オブジェクトのプロパティを使用して、以下を指定します。
生成するドキュメントの形式 (HTML、Microsoft® Word、または PDF)
生成ドキュメントの保存先と保存方法
ドキュメントの書式設定に使用するテンプレート
mlreportgen.dom.Document
クラスは handle
クラスです。
作成
説明
は、既定の HTML テンプレートを使用して、現在のフォルダーに documentObj
= mlreportgen.dom.Document()Untitled.htmx
という名前の出力ファイルを指定する既定のプロパティ値をもつ Document
オブジェクトを作成します。
は、出力ファイルのパスと名前を指定して、documentObj
= mlreportgen.dom.Document(outputPath
)OutputPath
プロパティを outputPath
に設定します。
は、さらにテンプレート ファイルのパスと名前を指定して、documentObj
= mlreportgen.dom.Document(outputPath
,type
,templatePath
)TemplatePath
プロパティを templatePath
に設定します。
プロパティ
OutputPath
— このドキュメントの出力ファイルまたは出力フォルダーのパスと名前
string スカラー | 文字ベクトル
このドキュメントの出力ファイルまたは出力フォルダーのパスと名前。string スカラーまたは文字ベクトルとして指定します。絶対パス、または現在のフォルダーに対する相対パスを指定できます。このプロパティは、ドキュメントを開く前にのみ設定できます。
既定値は、現在のフォルダー内の untitled
という名前のファイルまたはフォルダーへのパスです。OutputPath
でファイルが指定され、ファイル拡張子が指定されなかった場合、DOM API は Type
プロパティに基づいて拡張子を追加します。
OutputPath
がファイルとフォルダーのどちらのパスを指定するかは、以下の表に示すように、PackageType
プロパティの値によって決まります。
PackageType | OutputPath の値 |
---|---|
"zipped" または "single-file" | zip ファイルまたは単一のファイルのパスと名前 |
"unzipped" | 未圧縮ファイルのフォルダー |
"both" | zip ファイルのパスと名前、および未圧縮ファイルのフォルダー |
メモ
MATLAB® Drive™ などのクラウド ドライブで PDF レポートを生成すると、レポート生成ソフトウェアとクラウド ドライブ同期ソフトウェアとの間でファイルの競合が発生し、エラーとなる可能性があります。このエラーを回避するには、クラウドと同期しないローカル ドライブでレポートを生成します。ローカル ドライブにレポートを生成し、そのレポートをクラウド ドライブにコピーするスクリプトを作成することを検討してください。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
PackageType
— 生成されたファイルのパッケージ処理
"zipped"
| "unzipped"
| "both"
| "single-file"
生成されたファイルに使用するパッケージ処理。表中のいずれか 1 つを値として指定します。PackageType
は、string スカラーまたは文字ベクトルとして指定できます。
値 | サポートされているレポート タイプ | 説明 |
---|---|---|
|
|
|
"unzipped" |
|
|
"both" |
| 圧縮した出力と未圧縮の出力を生成します。 |
"single-file" |
| レポートを単一のファイルとして生成します。 |
解凍せずに開くことができる HTML レポートを生成するには、Type
を "html"
に設定し、PackageType
を "unzipped"
または "both"
に設定します。生成されたファイルがあるフォルダーで root.html
ファイルを開きます。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
ForceOverwrite
— 既存の出力ファイルを上書きするかどうか
true
(既定値) | false
既存の出力ファイルを上書きするかどうか。true
または false
として指定します。既存の出力ファイルを同じ名前で上書きするには、このプロパティを true
に設定します。このプロパティが false
で、同じ名前の書き込み可能ファイルが存在する場合、このドキュメントを閉じるときにエラーが発生します。既存のファイルが読み取り専用の場合は、このプロパティの設定にかかわらず、このドキュメントを閉じるときにエラーが発生します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
StreamOutput
— 出力をディスクにストリーミングするためのオプション
false
(既定値) | true
出力をディスクにストリーミングするためのオプション。true
または false
として指定します。既定では、ドキュメントが閉じられるまでは、メモリにドキュメント要素が格納されます。ドキュメントに要素が追加されたときにドキュメント要素をディスクに書き込むには、このプロパティを true
に設定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
TitleBarText
— HTML ブラウザーのタイトル バーのテキスト
string スカラー | 文字ベクトル
HTML ブラウザーのタイトル バーのテキスト。string スカラーまたは文字ベクトルとして指定します。HTML ドキュメントの場合、このプロパティは、このドキュメントを表示するのに使用されるブラウザーのタイトル バーに表示されるテキストを指定します。Word ドキュメントと PDF ドキュメントの場合、このプロパティは無視されます。
このプロパティは、ドキュメントを開く前に設定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
HTMLHeadExt
— HTML ヘッダーのカスタム コンテンツ
string スカラー | 文字ベクトル
HTML ヘッダーのカスタム コンテンツ。string スカラーまたは文字ベクトルとして指定します。このプロパティの値は、ドキュメント テンプレートの head セクションで指定されたコンテンツの後、このドキュメントの <head>
要素に対して追加されます。このプロパティは、ドキュメントを開く前にのみ設定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
TemplatePath
— 使用するテンプレートのパス
string スカラー | 文字ベクトル
使用するテンプレートの絶対パス。string スカラーまたは文字ベクトルとして指定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Type
— 出力のタイプ
"html"
(既定値) | "docx"
| "pdf"
| "html-file"
出力のタイプ。以下のいずれかの string スカラーまたは文字ベクトルとして指定します。
"html"
— HTML ドキュメントのテキスト、イメージ、スタイル シート、および JavaScript® ファイルを含む圧縮または未圧縮のフォルダーとしてパッケージ化した HTML 出力"docx"
— Word 出力"pdf"
— PDF 出力"html-file"
— レポートのテキスト、スタイル シート、JavaScript、およびイメージを含む単一の HTML ファイル
TemplatePath
プロパティを使用してテンプレートを指定する場合、テンプレートは Type
引数と一致するものでなければなりません。Word 出力の場合は Word テンプレートの拡張子 (.dotx
) をもつテンプレート、HTML 出力の場合は HTML テンプレート パッケージの拡張子 (.htmtx
) をもつテンプレート、PDF 出力の場合は PDF テンプレート パッケージの拡張子 (.pdftx
) をもつテンプレート、html-file
出力の場合は単一ファイルの HTML テンプレートの拡張子 (.htmt
) をもつテンプレートを指定しなければなりません。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
CurrentHoleId
— ドキュメントのカレント ホールの ID
文字ベクトル
ドキュメントのカレント ホールの ID。文字ベクトルとして指定します。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
CurrentHoleType
— カレント ホールのタイプ
'Inline'
| 'Block'
カレント ホールのタイプ。'Inline'
または 'Block'
として指定します。
インライン ホールは、段落要素が含むことのできるドキュメント要素 (
Text
、Image
、LinkTarget
、ExternalLink
、InternalLink
、CharEntity
、またはAutoNumber
) を対象とする。ブロック ホールは、
Paragraph
、Table
、OrderedList
、UnorderedList
、DocumentPart
、またはGroup
の要素を含むことができる。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
CurrentPageLayout
— このドキュメントの現在のページ レイアウト
mlreportgen.dom.DOCXPageLayout
オブジェクト | mlreportgen.dom.PDFPageLayout
オブジェクト | []
このドキュメントの現在のページ レイアウト。mlreportgen.dom.DOCXPageLayout
オブジェクト、mlreportgen.dom.PDFPageLayout
オブジェクト、または []
として指定します。このプロパティは、Word ドキュメントと PDF ドキュメントに適用されます。Word ドキュメントの場合、この値は現在のページ レイアウトを指定する DOCXPageLayout
オブジェクトになります。PDF ドキュメントの場合、ドキュメントによってページ レイアウトが現在指定されていれば、この値は PDFPageLayout
オブジェクトになります。HTML ドキュメントの場合、この値は常に []
になります。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
OpenStatus
— ドキュメントが開かれているかどうかのステータス
'unopened'
(既定値) | 'open'
| 'closed'
このドキュメントが開かれているかどうかのステータス。'unopened'
、'open'
、または 'closed'
として指定します。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
Parent
— この DOM API オブジェクトの親
DOM API オブジェクト
この DOM API オブジェクトの親。DOM API オブジェクトとして指定します。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
Children
— この DOM API オブジェクトの子
DOM API オブジェクトの配列
この DOM API オブジェクトの子。DOM API オブジェクトの配列として指定します。
属性:
GetAccess | public |
SetAccess | private |
Transient | true |
NonCopyable | true |
Tag
— この DOM API オブジェクトのタグ
文字ベクトル | string スカラー
この DOM API オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。
DOM は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id
プロパティの値です。独自のタグ値を指定すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Id
— この DOM API オブジェクトの ID
文字ベクトル | string スカラー
この DOM API オブジェクトの ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
メソッド
パブリック メソッド
addHTML | ドキュメントへの HTML 文字列の追加 |
addHTMLFile | ドキュメントへの HTML ファイルのコンテンツの追加 |
append | ドキュメントへの DOM オブジェクトまたは MATLAB オブジェクトの追加 |
close | ドキュメントのクローズ |
createAutoNumberStream | Create numbering stream |
mlreportgen.dom.Document.createTemplate | DOM テンプレート ファイルの作成 |
fill | ドキュメント ホールを生成コンテンツで埋める |
getAutoNumberStream | Return numbering stream |
mlreportgen.dom.Document.getCoreProperties | ドキュメントまたはテンプレートのコア プロパティの取得 |
mlreportgen.dom.Document.getImageDirectory | ドキュメントのイメージ フォルダーの取得 |
mlreportgen.dom.Document.getImagePrefix | Get generated image name prefix |
getMainPartPath | Return path of main part of document output package |
mlreportgen.dom.Document.getOPCMainPart | Return main part of document, document part, or template |
moveToNextHole | ドキュメントの追加ポイントを次のテンプレート ホールに移動 |
open | ドキュメントを開く |
package | OPC パーツ ファイルをドキュメント パッケージに追加 |
mlreportgen.dom.Document.setCoreProperties | Set OPC core properties of output document or template |
例
Word ドキュメントの作成
Word ドキュメントを作成し、コンテンツを追加し、Word でレポートを表示します。
import mlreportgen.dom.*; d = Document("mydoc","docx"); append(d,"Hello World"); close(d); rptview(d);
単一のファイルとしての HTML ドキュメントの作成
イメージを含む単一の HTML ファイルとして HTML ドキュメントを作成します。この例では、MyImage.jpg
ファイルおよび myHTMLTemplate.htmt
HTML テンプレート ファイルがあることを前提としています。
その出力が単一の HTML ファイルであり、テンプレート myHTMLTemplate
を使用するドキュメントを作成します。レポートにテキストとイメージを追加します。ドキュメントを閉じて表示します。
import mlreportgen.dom.*; d = Document("mydoc","html-file","myHTMLTemplate.htmt"); open(d); append(d,"Hello world"); append(d,Image("C:/images/LocalSystem/MyImage.jpg")); close(d); rptview(d);
バージョン履歴
R2014b で導入
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)