mlreportgen.dom.Document クラス

名前空間: mlreportgen.dom

ドキュメントコンテナー

説明

mlreportgen.dom.Document クラスのオブジェクトを使用して、ドキュメントオブジェクトモデル (DOM) ドキュメントを表します。Document オブジェクトのプロパティを使用して、以下を指定します。

生成するドキュメントの形式 (HTML、Microsoft^® Word、または PDF)
生成ドキュメントの保存先と保存方法
ドキュメントの書式設定に使用するテンプレート

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

クラス属性

`ConstructOnLoad`	`true`
`HandleCompatible`	`true`

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

作成

説明

documentObj = mlreportgen.dom.Document は、既定の HTML テンプレートを使用して、現在のフォルダーに Untitled.htmx という名前の出力ファイルを指定する既定のプロパティ値をもつ Document オブジェクトを作成します。

documentObj = mlreportgen.dom.Document(outputPath) は、出力ファイルのパスと名前を指定して、OutputPath プロパティを outputPath に設定します。

例

documentObj = mlreportgen.dom.Document(outputPath,type) は、さらに出力タイプを指定して、Type プロパティを type に設定します。

documentObj = mlreportgen.dom.Document(outputPath,type,templatePath) は、さらにテンプレートファイルのパスと名前を指定して、TemplatePath プロパティを templatePath に設定します。

プロパティ

すべて展開する

`OutputPath` — 出力ファイルまたはフォルダーのパス
`"untitled"` (既定値) | 文字ベクトル | string スカラー

出力ファイルまたはフォルダーのパス。文字ベクトルまたは string スカラーとして指定します。既定値は、現在のフォルダー内の untitled という名前のファイルまたはフォルダーへのパスです。パスは、"C:/myreports/reportA.docx" のように、絶対パスで指定できます。また、"reportA" のように、現在の MATLAB フォルダーからの相対パスで指定することもできます。ファイル拡張子を指定しない場合、DOM はドキュメントの Type プロパティに基づいて拡張子を追加します。このプロパティは、ドキュメントを開く前にのみ設定できます。

OutputPath がファイルとフォルダーのどちらのパスを指定するかは、以下の表に示すように、PackageType プロパティの値によって決まります。

`PackageType`	`OutputPath` の値
`"zipped"` または `"single-file"`	zip ファイルまたは単一のファイルのパスと名前
`"unzipped"`	未圧縮ファイルのフォルダー
`"both"`	zip ファイルのパスと名前、および未圧縮ファイルのフォルダー

メモ

MATLAB^® Drive™ などのクラウドドライブで PDF レポートを生成すると、レポート生成ソフトウェアとクラウドドライブ同期ソフトウェアとの間でファイルの競合が発生し、エラーとなる可能性があります。このエラーを回避するには、クラウドと同期しないローカルドライブでレポートを生成します。ローカルドライブにレポートを生成し、そのレポートをクラウドドライブにコピーするスクリプトを作成することを検討してください。

属性:

NonCopyable true

データ型: char | string

`PackageType` — 生成されるファイルのパッケージ化
`"zipped"` (既定値) | `"unzipped"` | `"both"` | `"single-file"`

生成されたファイルに使用するパッケージ化。表中のいずれか 1 つを値として指定します。

値	サポートされているレポートタイプ	説明
`"zipped"`	`"docx"`、`"html-multipage"`、または `"html"`	`OutputPath` プロパティで指定された場所に zip ファイルとしてレポートを生成します。この zip ファイルは、ドキュメントタイプと一致する拡張子をもちます (Word 出力であれば `docx`、HTML 出力であれば `htmtx`。)たとえば、ドキュメントタイプが `docx` であり、`OutputPath` が `s:\docs\MyDoc` であれば、その出力は `s:\docs\MyDoc.docx` という名前の zip ファイルにパッケージ化されます。
`"unzipped"`	`"docx"`、`"html-multipage"`、または `"html"`	`OutputPath` プロパティのファイル名をもつフォルダー内に、個別のファイルとしてレポートを生成します。たとえば、`OutputPath` が `s:\docs\MyDoc` であれば、出力フォルダーは `s:\docs\MyDoc` となります。
`"both"`	`"docx"`、`"html-multipage"`、または `"html"`	圧縮した出力と未圧縮の出力を生成します。
`"single-file"`	`"pdf"` または `"html-file"`	レポートを単一のファイルとして生成します。

ヒント

Type プロパティが "html" または "html-multipage" の場合、解凍せずに開くことができる HTML レポートを生成するには、PackageType を "unzipped" または "both" に設定します。生成されたファイルがあるフォルダーで root.html ファイルを開きます。

属性:

NonCopyable true

データ型: char | string

`ForceOverwrite` — 既存の出力ファイルを上書きするオプション
`true` (既定値) | `false`

既存の出力ファイルを上書きするかどうか。true または false として指定します。既存の出力ファイルを同じ名前で上書きするには、このプロパティを true に設定します。このプロパティが false で、同じ名前の書き込み可能ファイルが存在する場合、このドキュメントを閉じるときにエラーが発生します。既存のファイルが読み取り専用の場合は、このプロパティの設定にかかわらず、このドキュメントを閉じるときにエラーが発生します。

属性:

NonCopyable true

データ型: logical

`StreamOutput` — 出力をディスクにストリーミングするためのオプション
`false` (既定値) | `true`

出力をディスクにストリーミングするためのオプション。true または false として指定します。既定では、ドキュメントが閉じられるまでは、メモリにドキュメント要素が格納されます。ドキュメントに要素が追加されたときにドキュメント要素をディスクに書き込むには、このプロパティを true に設定します。

属性:

NonCopyable true

データ型: logical

`TitleBarText` — HTML ブラウザーのタイトルバーのテキスト
`''` (既定値) | 文字ベクトル | string スカラー

HTML ブラウザーのタイトルバーのテキスト。文字ベクトルまたは string スカラーとして指定します。HTML ドキュメントの場合、このプロパティは、このドキュメントを表示するのに使用されるブラウザーのタイトルバーに表示されるテキストを指定します。Word ドキュメントと PDF ドキュメントの場合、このプロパティは無視されます。

このプロパティは、ドキュメントを開く前に設定します。

属性:

NonCopyable true

データ型: char | string

`HTMLHeadExt` — HTML ヘッダーのカスタムコンテンツ
`''` (既定値) | 文字ベクトル | string スカラー

HTML ヘッダーのカスタムコンテンツ。文字ベクトルまたは string スカラーとして指定します。このプロパティの値は、ドキュメントテンプレートの head セクションで指定されたコンテンツの後、このドキュメントの <head> 要素に対して追加されます。このプロパティは、ドキュメントを開く前にのみ設定します。

属性:

NonCopyable true

データ型: char | string

`TemplatePath` — 使用するテンプレートのパス
文字ベクトル | string スカラー

使用するテンプレートの絶対パス (必要に応じてファイル拡張子を含めることができる)。文字ベクトルまたは string スカラーとして指定します。ファイル拡張子は、次のいずれかの値になります。

拡張子	ファイルタイプ
`.htmtx`	圧縮 HTML
`.dotx`	Microsoft Word
`.htmt`	単一ファイルの HTML
`.pdfx`	PDF

メモ

ドキュメントを出力用に開いた後、このプロパティを変更することはできません。

属性:

NonCopyable true

データ型: char | string

`Type` — 出力ファイルタイプ
`"html"` (既定値) | `"docx"`, | `"html-file"` | `"html-multipage"` | `"pdf"`

出力ファイルタイプ。次の値のいずれかとして指定します。

値	ファイルタイプ
`"docx"`	Microsoft Word
`"html"`	HTML ドキュメントのテキスト、イメージ、スタイルシート、および JavaScript^® ファイルを含む圧縮または未圧縮のフォルダーとしての HTML 出力
`"html-file"`	レポート用にテキスト、スタイルシート、JavaScript、およびイメージを含む単一のファイルで構成される HTML 出力
`"html-multipage"` (R2024a 以降)	複数のページに分割された HTML ドキュメントのテキスト、イメージ、スタイルシート、および JavaScript ファイルを含む圧縮または未圧縮のフォルダーとしての HTML 出力
`"pdf"`	PDF

TemplatePath プロパティを使用してテンプレートを指定する場合、テンプレートは Type プロパティと一致するものでなければなりません。

属性:

NonCopyable true

データ型: char | string

`CurrentHoleId` — ドキュメントのカレントホールの ID
`''` (既定値) | 文字ベクトル | string スカラー

ドキュメントのカレントホールの ID。文字ベクトルまたは string スカラーとして指定します。

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

データ型: char | string

`CurrentHoleType` — カレントホールのタイプ
`''` (既定値) | `"Inline"` | `"Block"`

カレントテンプレートホールのタイプ。"Inline" または "Block" として指定します。

インラインホールは、段落要素が含むことのできるドキュメント要素 (Text、Image、LinkTarget、ExternalLink、InternalLink、CharEntity、または AutoNumber) を対象とする。
ブロックホールは、Paragraph、Table、OrderedList、UnorderedList、DocumentPart、または Group の要素を含むことができる。

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

データ型: char | string

`CurrentPageLayout` — このドキュメントの現在のページレイアウト
`[]` (既定値) | `mlreportgen.dom.DOCXPageLayout` オブジェクト | `mlreportgen.dom.PDFPageLayout` オブジェクト | `[]`

このドキュメントの現在のページレイアウト。mlreportgen.dom.DOCXPageLayout オブジェクト、mlreportgen.dom.PDFPageLayout オブジェクト、または [] として指定します。このプロパティは、Word ドキュメントと PDF ドキュメントに適用されます。Word ドキュメントの場合、この値は現在のページレイアウトを指定する DOCXPageLayout オブジェクトになります。PDF ドキュメントの場合、ドキュメントによってページレイアウトが現在指定されていれば、この値は PDFPageLayout オブジェクトになります。HTML ドキュメントの場合、この値は常に [] になります。

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`OpenStatus` — ドキュメントが開かれているかどうかのステータス
`'unopened'` (既定値) | `'open'` | `'closed'`

このドキュメントが開かれているかどうかのステータス。'unopened'、'open'、または 'closed' として指定します。

メモ

mlreportgen.dom.Document オブジェクトの OpenStatus プロパティが 'open' である場合、レポートを表示するために rptview を呼び出すと、OpenStatus が 'closed' に設定されます。レポートを表示するには、DOM API の close コマンドを実行する必要があります。これにより、レポートのメモリ内の DOM 表現が、Type プロパティで指定されたタイプのファイルに変換されます。Document.OpenStatus が 'closed' に設定されていない場合、rptview は必要な close コマンドを発行します。

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

データ型: char | string

`EndnoteOptions` — ドキュメントの文末脚注オプション
`[]` (既定値) | `mlreportgen.dom.EndnoteOptions` オブジェクト

R2024a 以降

ドキュメントの文末脚注オプション。mlreportgen.dom.EndnoteOptions オブジェクトとして指定します。EndnoteOptions のプロパティが空の場合、ドキュメントは既定値を使用します。

メモ

ページレイアウトで文末脚注オプションが指定されている場合、ページレイアウトの文末脚注オプションは、ここで指定されたドキュメントの文末脚注オプションをオーバーライドします。

属性:

NonCopyable true

`FootnoteOptions` — ドキュメントの脚注オプション
`[]` (既定値) | `mlreportgen.dom.FootnoteOptions` オブジェクト

R2024a 以降

ドキュメントの脚注オプション。mlreportgen.dom.FootnoteOptions オブジェクトとして指定します。FootnoteOptions のプロパティが空の場合、ドキュメントは既定値を使用します。

メモ

ページレイアウトで脚注オプションが指定されている場合、ページレイアウトの脚注オプションは、ここで指定されたドキュメントの脚注オプションをオーバーライドします。

属性:

NonCopyable true

`Parent` — この `mlreportgen.dom.Document` オブジェクトの親
ドキュメント要素オブジェクト

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

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`Children` — この `mlreportgen.dom.Document` オブジェクトの子
ドキュメント要素オブジェクト

このドキュメント要素の子。ドキュメント要素オブジェクトの配列として指定します。append メソッドを使用して追加された要素がここに追加されます。

属性:

`SetAccess`	`private`
`Transient`	`true`
`NonCopyable`	`true`

`Tag` — `mlreportgen.dom.Document` オブジェクトのタグ
文字ベクトル | string スカラー

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

属性:

NonCopyable true

データ型: char | string

`Id` — `mlreportgen.dom.Document` オブジェクトの識別子
文字ベクトル | string スカラー

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

属性:

NonCopyable true

データ型: char | string

メソッド

すべて展開する

パブリックメソッド

`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 で導入

すべて展開する

R2024a: DOM API での脚注と文末脚注のサポート

DOM API は、脚注 mlreportgen.dom.Footnote と文末脚注 mlreportgen.dom.Endnote の両方をサポートします。これらのオプションについては、mlreportgen.dom.FootnoteOptions クラスと mlreportgen.dom.EndnoteOptions クラスを使用して設定します。脚注も文末脚注も、番号付けとスタイルの両方をカスタマイズできます。脚注と文末脚注は、Microsoft Word および PDF の出力形式で使用できます。

参考

mlreportgen.dom.DocumentPart | mlreportgen.dom.Text | mlreportgen.dom.Paragraph | mlreportgen.dom.Image

トピック

レポートコンテナーの作成

mlreportgen.dom.Document クラス

説明

クラス属性

作成

説明

プロパティ

OutputPath — 出力ファイルまたはフォルダーのパス "untitled" (既定値) | 文字ベクトル | string スカラー

属性:

PackageType — 生成されるファイルのパッケージ化 "zipped" (既定値) | "unzipped" | "both" | "single-file"

属性:

ForceOverwrite — 既存の出力ファイルを上書きするオプション true (既定値) | false

属性:

StreamOutput — 出力をディスクにストリーミングするためのオプション false (既定値) | true

属性:

TitleBarText — HTML ブラウザーのタイトル バーのテキスト '' (既定値) | 文字ベクトル | string スカラー

属性:

HTMLHeadExt — HTML ヘッダーのカスタム コンテンツ '' (既定値) | 文字ベクトル | string スカラー

属性:

TemplatePath — 使用するテンプレートのパス 文字ベクトル | string スカラー

属性:

Type — 出力ファイル タイプ "html" (既定値) | "docx", | "html-file" | "html-multipage" | "pdf"

属性:

CurrentHoleId — ドキュメントのカレント ホールの ID '' (既定値) | 文字ベクトル | string スカラー

属性:

CurrentHoleType — カレント ホールのタイプ '' (既定値) | "Inline" | "Block"

属性:

CurrentPageLayout — このドキュメントの現在のページ レイアウト [] (既定値) | mlreportgen.dom.DOCXPageLayout オブジェクト | mlreportgen.dom.PDFPageLayout オブジェクト | []

属性:

OpenStatus — ドキュメントが開かれているかどうかのステータス 'unopened' (既定値) | 'open' | 'closed'

属性:

EndnoteOptions — ドキュメントの文末脚注オプション [] (既定値) | mlreportgen.dom.EndnoteOptions オブジェクト

属性:

FootnoteOptions — ドキュメントの脚注オプション [] (既定値) | mlreportgen.dom.FootnoteOptions オブジェクト

属性:

Parent — この mlreportgen.dom.Document オブジェクトの親 ドキュメント要素オブジェクト

属性:

Children — この mlreportgen.dom.Document オブジェクトの子 ドキュメント要素オブジェクト

属性:

Tag — mlreportgen.dom.Document オブジェクトのタグ 文字ベクトル | string スカラー

属性:

Id — mlreportgen.dom.Document オブジェクトの識別子 文字ベクトル | string スカラー

属性:

メソッド

パブリック メソッド

例

Word ドキュメントの作成

単一のファイルとしての HTML ドキュメントの作成

バージョン履歴

R2024a: DOM API での脚注と文末脚注のサポート

参考

トピック

`OutputPath` — 出力ファイルまたはフォルダーのパス
`"untitled"` (既定値) | 文字ベクトル | string スカラー

`PackageType` — 生成されるファイルのパッケージ化
`"zipped"` (既定値) | `"unzipped"` | `"both"` | `"single-file"`

`ForceOverwrite` — 既存の出力ファイルを上書きするオプション
`true` (既定値) | `false`

`StreamOutput` — 出力をディスクにストリーミングするためのオプション
`false` (既定値) | `true`

`TitleBarText` — HTML ブラウザーのタイトルバーのテキスト
`''` (既定値) | 文字ベクトル | string スカラー

`HTMLHeadExt` — HTML ヘッダーのカスタムコンテンツ
`''` (既定値) | 文字ベクトル | string スカラー

`TemplatePath` — 使用するテンプレートのパス
文字ベクトル | string スカラー

`Type` — 出力ファイルタイプ
`"html"` (既定値) | `"docx"`, | `"html-file"` | `"html-multipage"` | `"pdf"`

`CurrentHoleId` — ドキュメントのカレントホールの ID
`''` (既定値) | 文字ベクトル | string スカラー

`CurrentHoleType` — カレントホールのタイプ
`''` (既定値) | `"Inline"` | `"Block"`

`CurrentPageLayout` — このドキュメントの現在のページレイアウト
`[]` (既定値) | `mlreportgen.dom.DOCXPageLayout` オブジェクト | `mlreportgen.dom.PDFPageLayout` オブジェクト | `[]`

`OpenStatus` — ドキュメントが開かれているかどうかのステータス
`'unopened'` (既定値) | `'open'` | `'closed'`

`EndnoteOptions` — ドキュメントの文末脚注オプション
`[]` (既定値) | `mlreportgen.dom.EndnoteOptions` オブジェクト

`FootnoteOptions` — ドキュメントの脚注オプション
`[]` (既定値) | `mlreportgen.dom.FootnoteOptions` オブジェクト

`Parent` — この `mlreportgen.dom.Document` オブジェクトの親
ドキュメント要素オブジェクト

`Children` — この `mlreportgen.dom.Document` オブジェクトの子
ドキュメント要素オブジェクト

`Tag` — `mlreportgen.dom.Document` オブジェクトのタグ
文字ベクトル | string スカラー

`Id` — `mlreportgen.dom.Document` オブジェクトの識別子
文字ベクトル | string スカラー

パブリックメソッド