ReportIndex & Example Files

ReportIndex

ReportIndex creates an interactive navigation component for browsing collections of HTML reports. It reads from a CSV manifest file containing metadata about each report page, and generates a searchable, sortable, and groupable index.

Manifest Format

The manifest CSV file should contain columns describing each report:

• path: Directory path to the HTML file
• html_filename: Name of the HTML file
• description: Human-readable description shown in the index
• date: Date the report was created/updated
• Additional columns: Any extra columns (like chart_type, page_type) can be used for grouping and filtering

Usage

# Create a manifest entry when generating HTML
manifest_entry = ManifestEntry(
    path="..",
    html_filename="my_chart.html",
    description="My Chart Example",
    date=today(),
    extra_columns=Dict(:chart_type => "2D Charts", :page_type => "Chart Tutorial")
)
create_html(page, "generated_html_examples/my_chart.html";
    manifest="generated_html_examples/z_general_example/manifest.csv",
    manifest_entry=manifest_entry)

# Later, create an index page from the manifest
index = ReportIndex(:my_index, "path/to/manifest.csv",
    title = "My Reports",
    default_group_by = :chart_type,
    default_sort_by = :description
)

The useful feature of ReportIndex over LinkList is that because ReportIndex comes from an external csv file you can add to that external csv file on a regular basis. For instance you can do a new report every day. Then you can have a different document that will link to all of them.

JSPlots Example Files

Below is an interactive index of all JSPlots example files generated using ReportIndex. Click on any link to view the example. Use the dropdowns to group and sort the examples.