Main Content

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 に設定します。

プロパティ

すべて展開する

このドキュメントの出力ファイルまたは出力フォルダーのパスと名前。string スカラーまたは文字ベクトルとして指定します。絶対パス、または現在のフォルダーに対する相対パスを指定できます。このプロパティは、ドキュメントを開く前にのみ設定できます。

既定値は、現在のフォルダー内の untitled という名前のファイルまたはフォルダーへのパスです。OutputPath でファイルが指定され、ファイル拡張子が指定されなかった場合、DOM API は Type プロパティに基づいて拡張子を追加します。

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

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

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

生成されたファイルに使用するパッケージ処理。表中のいずれか 1 つを値として指定します。PackageType は、string スカラーまたは文字ベクトルとして指定できます。

サポートされているレポート タイプ説明

"zipped"

"docx" または "html"

OutputPath プロパティで指定された場所に zip ファイルとしてレポートを生成します。この zip ファイルは、ドキュメント タイプと一致する拡張子をもちます (Word 出力であれば .docx、HTML 出力であれば .htmx。)たとえば、ドキュメントの Typedocx であり、OutputPaths:\docs\MyDoc であれば、その出力は s:\docs\MyDoc.docx という名前の zip ファイルにパッケージ化されます。

"unzipped"

"docx" または "html"

OutputPath プロパティのファイル名をもつフォルダー内に、個別のファイルとしてレポートを生成します。たとえば、OutputPaths:\docs\MyDoc であれば、出力フォルダーは s:\docs\MyDoc となります。

"both"

"docx" または "html"

圧縮した出力と未圧縮の出力を生成します。

"single-file"

"pdf" または "html-file"

レポートを単一のファイルとして生成します。

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

使用するテンプレートの絶対パス。string スカラーまたは文字ベクトルとして指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

出力のタイプ。以下のいずれかの 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

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

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

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

  • インライン ホールは、段落要素が含むことのできるドキュメント要素 (TextImageLinkTargetExternalLinkInternalLinkCharEntity、または AutoNumber) を対象とする。

  • ブロック ホールは、ParagraphTableOrderedListUnorderedListDocumentPart、または Group の要素を含むことができる。

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

この DOM API オブジェクトの親。DOM API オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

この DOM API オブジェクトの子。DOM API オブジェクトの配列として指定します。

属性:

GetAccess
public
SetAccess
private
Transient
true
NonCopyable
true

この DOM API オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。

DOM は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトの ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

メソッド

すべて展開する

すべて折りたたむ

Word ドキュメントを作成し、コンテンツを追加し、Word でレポートを表示します。

import mlreportgen.dom.*;
d = Document("mydoc","docx");

append(d,"Hello World");

close(d);
rptview(d);

イメージを含む単一の 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 で導入