Main Content

mlreportgen.report.TableOfContents クラス

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

目次レポーター

このページをすべて展開する

説明

レポートに目次を追加する目次 (TOC) レポーターを作成します。このクラスは mlreportgen.report.Reporter から継承します。

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

作成

説明

toc = TableOfContents は、レポートの目次 (TOC) セクションを生成するレポーターを返します。TOC セクションの既定のテンプレートは、TOC の外観とページ レイアウトを定義します。TOC セクションには、レポートの出力タイプに応じて、既定のタイトルと、生成される TOC の位置を指定する TOC 要素が含まれます。TOC の生成方法は、レポート タイプごとに異なります。

  • HTML — レポートがブラウザーで開かれたときに、レポート テンプレートからレポートにコピーされた JavaScript が TOC を生成します。スクリプトは、TOC を折りたたみ可能なツリーとして生成します。ツリー エントリは、レポートの HTML 見出し要素 (h1 ～ h6) のハイパーリンクされたコンテンツです。TOC ツリーのエントリのレベルは、見出し要素のレベルに対応します。章レポーターとセクション レポーターによって、適切なレベルの見出し要素として章と節のタイトルが生成されるため、章と節のタイトルは TOC に自動的に表示されます。レポート内の DOM 見出し要素を使用して TOC エントリを生成することもできます。

  • DOCX — Word でレポートを開いた後、Report Generator の関数 rptview が TOC を生成するように Word に指示します。rptview を使用せずに Word で直接レポートを開く場合は、自分でレポート ドキュメントを更新して TOC を生成しなければなりません。Word ドキュメントの目次および生成されたリストの更新を参照してください。

    TOC は 2 列のテーブルです。最初の列には、アウトライン レベルが設定されたレポート段落から成るハイパーリンクされたコンテンツが格納されます。アウトライン レベルによって、TOC エントリの書式設定が決まります。2 番目の列には、対応する段落が出現するページの番号が格納されます。章レポーターとセクション レポーターによって、適切なレベル セットをもつ段落として章と節のタイトルが生成されるため、章と節のタイトルは TOC に自動的に表示されます。レポート内の DOM 見出し要素を使用して TOC エントリを生成することもできます。

  • PDF — PDF ドキュメントの生成時に目次が生成されます。

例

toc = TableOfContents(title) は、指定された title を使用する TOC を作成します。

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

プロパティ

すべて展開する

目次のタイトル。次の値のいずれかとして指定します。

  • string または文字ベクトル

  • DOM オブジェクト

  • string または DOM オブジェクトから成る 1 行 N 列または N 行 1 列の配列

  • string、文字ベクトル、DOM オブジェクトのいずれか、またはこれらの組み合わせから成る 1 行 N 列または N 行 1 列の cell 配列

  • TableOfContentsTitle レポーター

例: 'TableOfContents','Report Contents'

目次で使用する見出しレベルの数。範囲 [1,9] の正の整数として指定します。

タイトルとページ番号の間に使用するリーダーのタイプ。以下の文字ベクトルまたは string スカラーのいずれかとして指定します。

  • '.' または 'dots'

  • ' ' または 'space'

このプロパティは、PDF レポートにのみ適用されます。Word レポートには常にドット リーダーがあります。HTML レポートにはリーダーがありません。

目次セクションのページ レイアウト。mlreportgen.report.ReporterLayout オブジェクトとして指定します。ReporterLayout オブジェクトのプロパティを使用して、ページの向きなど、既定のページ レイアウト プロパティの一部をオーバーライドします。

このレポーターのテンプレートのソース。次のオプションのいずれかとして指定します。

  • このレポーターのテンプレートを含むファイルのパスを指定する文字ベクトルまたは string スカラー

  • テンプレートがこのレポーターのために使用される、またはテンプレート ライブラリがこのレポーターのテンプレートを含むレポーターまたはレポート

  • テンプレートがこのレポーターのために使用される、またはテンプレート ライブラリがこのレポーターのテンプレートを含む DOM ドキュメントまたはドキュメント パーツ

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

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

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

メソッド

すべて展開する

例

すべて折りたたむ

既定の書式設定を使用する目次を作成します。

import mlreportgen.report.*
rpt = Report('output','pdf');
toc = TableOfContents();
add(rpt,toc);

緑色のタイトルをもつ目次を含むレポートを作成します。このレポートには、章、節、および付録セクションも含まれています。

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

rpt = Report('Report with TOC');
add(rpt, TitlePage(Title='Report',Subtitle='with TOC'));
toc = TableOfContents;
toc.Title = Text('Table of Contents');
toc.Title.Color = 'green';
toc.NumberOfLevels = 2; 
add(rpt,toc);

ch = Chapter('First Chapter');
add(ch,Section('First Subsection'));
add(ch,Section('Second Subsection'));

add(rpt,ch);
add(rpt,Chapter('Second Chapter'));

add(rpt,PDFPageLayout);
p = Paragraph('Appendix'); 
p.Style = {OutlineLevel(1), Bold, FontSize('18pt')};
add(rpt,p);

close(rpt);
rptview(rpt);

バージョン履歴

R2017b で導入

すべて展開する

参考

|

トピック