Table of Figures¶

The Table of Figures is a component in CxReports that enables users to track and reference figures throughout the report. It provides a centralized list of all figures, including tables, charts, and images, along with the page numbers where they appear.

How it Works¶

The Table of Figures displays all pages where the Figure Caption component is present. The Figure Caption is a simple textual component that serves as an indicator of a figure, allowing the Table of Figures to determine on which page the figure is located.

Warning

For the Table of Figures to function correctly, the page containing the figure must be marked as countable. This ensures that the figure is included in the table.

Figure Caption¶

The Figure Caption component shares channel options with the Table of Figures and can be customized to include a name and a title. For example:

Name: Figure 1.
Title: Cat 1

This information is used by the Table of Figures to identify and reference the figure within the report.

Customization¶

CxReports offers several customization options for the Table of Figures to adapt it to your specific needs:

1. Channel Customization¶

You can customize the Table of Figures to track specific types of figures by selecting the appropriate channel:

General: Tracks any type of figure.
Tables: Tracks table components.
Charts: Tracks chart components.
Image: Tracks image components.

2. Additional Customization Options¶

Tab Leader: Customize the tab leader that connects the figure name to the page number.
Leader Color: Adjust the color of the tab leader.
Column Count: Set the number of columns in the Table of Figures.
Column Gap: Define the gap between columns.
Fill Behavior: Defines how Table of Figures fills up when there are multiple columns.
Sample Count: Defines how many sample figures will be in preview mode.

These customization options allow you to create a Table of Figures that aligns with the design and structure of your report.