mlreportgen.report.TableOfContents クラス
名前空間: mlreportgen.report
スーパークラス: mlreportgen.report.Reporter
目次レポーター
説明
レポートに目次を追加する目次 (TOC) レポーターを作成します。このクラスは mlreportgen.report.Reporter から継承します。
mlreportgen.report.TableOfContents クラスは handle クラスです。
作成
説明
toc = TableOfContents
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)
プロパティ
メソッド
例
既定の書式設定を使用する目次を作成します。
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);
ヒント
レポート テンプレートは、このレポーターによって生成される TOC のサイズ、間隔、色、およびその他の書式プロパティを決定します。既定の Microsoft Word および PDF のテンプレートには、TOC 内の各エントリの既定のスタイルが含まれています。TOC の書式を変更するには、それらのスタイルを再定義するカスタム レポート テンプレートを作成し、レポートの生成時にそのテンプレートを使用します。mlreportgen.report.Report.createTemplate を参照してください。スタイルには TOC1、TOC2、…、TOC6 という名前が付けられます。ここで、スタイル TOC1 はレベル 1 のエントリの書式を定義し、スタイル TOC2 はレベル 2 のエントリの書式を定義します。
