KSLCore/ksl.utilities.io.report.renderer/HtmlReportRenderer

HtmlReportRenderer

class HtmlReportRenderer(ctx: RenderContext = RenderContext(), cssPath: Path? = null, css: String? = null) : AbstractReportVisitor(source)

A ReportVisitor that renders a ReportNode tree to a self-contained HTML file.

Structure:

<html><head> — inline REPORT_CSS + Lets-Plot CDN <script> (emitted once)
<body> — content; <h1> document title
<details open><summary> — collapsible sections (nested sections indent)
<footer> — generated timestamp

Node rendering:

ReportNode.Document — <h1> title; footer timestamp on exit
ReportNode.Section — <details open><summary>title</summary>
ReportNode.Heading — <h{level}>text</h{level}>
ReportNode.Paragraph — <p>text</p>
ReportNode.StatTable — StatisticReporter.asDataFrame → toHtmlTable; detail=true appends an extended diagnostic table
ReportNode.WeightedStatTable — HTML <table> with all weighted-statistic fields
ReportNode.DataTable — HTML <table>; numeric columns right-aligned
ReportNode.PlotNode — <div class="plot-container"> + ksl.utilities.io.plotting.PlotIfc.toEmbeddedHTML
ReportNode.RawText — <pre>content</pre>
ReportNode.PageBreak — <hr/>

The Lets-Plot CDN <script> is emitted exactly once inside <head> so all embedded plot fragments can share it. Plots beyond RenderContext.maxPlotsPerSection per section are replaced with a <p class="plot-omitted"> notice.

All mutable state uses the my prefix per KSL coding conventions.

CSS selection (evaluated in priority order):

cssPath non-null → <link rel="stylesheet" href="..."> is emitted; no inline <style> block
css non-null → the supplied string is inlined in a <style> block
Both null (default) → REPORT_CSS is inlined in a <style> block

Parameters

ctx

the render context supplying output paths and formatting preferences

cssPath

path to an external CSS file; when non-null a <link> tag is emitted and css is ignored

css

inline CSS string to embed in a <style> block; only used when cssPath is null; when both are null REPORT_CSS is used

Constructors

HtmlReportRenderer

constructor(ctx: RenderContext = RenderContext(), cssPath: Path? = null, css: String? = null)

Types

Companion

object Companion

Functions

enterDocument

open override fun enterDocument(node: ReportNode.Document)

enterSection

open override fun enterSection(node: ReportNode.Section)

exitDocument

open override fun exitDocument(node: ReportNode.Document)

exitSection

open override fun exitSection(node: ReportNode.Section)

result

fun result(): String

Returns the accumulated HTML report as a String.

showInBrowser

fun showInBrowser(): File

Writes the accumulated HTML to a temporary file in RenderContext.outputDir and opens it in the system default browser. Returns the File that was created.

visit

open override fun visit(node: ReportNode.DataTable)

open override fun visit(node: ReportNode.Heading)

open override fun visit(node: ReportNode.PageBreak)

open override fun visit(node: ReportNode.Paragraph)

open override fun visit(node: ReportNode.PlotNode)

open override fun visit(node: ReportNode.RawText)

open override fun visit(node: ReportNode.StatPropertyTable)

open override fun visit(node: ReportNode.StatTable)

open override fun visit(node: ReportNode.WeightedStatPropertyTable)

open override fun visit(node: ReportNode.WeightedStatTable)

writeToFile

fun writeToFile(path: Path): File

Writes the accumulated report to a file at path and returns a File reference.