このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
mlreportgen.report.TableOfContents クラス
名前空間: mlreportgen.report
スーパークラス: mlreportgen.report.Reporter
目次レポーター
説明
レポートに目次を追加する目次 (TOC) レポーターを作成します。このクラスは mlreportgen.report.Reporter
から継承します。
mlreportgen.report.TableOfContents
クラスは handle
クラスです。
作成
説明
は、レポートの目次 (TOC) セクションを生成するレポーターを返します。TOC セクションの既定のテンプレートは、TOC の外観とページ レイアウトを定義します。TOC セクションには、レポートの出力タイプに応じて、既定のタイトルと、生成される TOC の位置を指定する TOC 要素が含まれます。TOC の生成方法は、レポート タイプごとに異なります。 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
)