Skip to content

Commit a698609

Browse files
committed
Added important disclaimer to AnyFrame.toStaticHtml()
1 parent 7951e04 commit a698609

File tree

1 file changed

+5
-0
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io

1 file changed

+5
-0
lines changed

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/html.kt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,11 @@ private fun downsizeBufferedImageIfNeeded(value: Any?, renderConfig: DisplayConf
319319
* Renders [this] [DataFrame] as static HTML (meaning no JS is used).
320320
* CSS rendering is enabled by default but can be turned off using [includeCss]
321321
*
322+
* __IMPORTANT:__ If JavaScript is enabled, the table inside the returned [DataFrameHtmlData] will be HIDDEN when rendered.
323+
* This is done so this function can be used as a fallback mechanism for [AnyFrame.toHtmlData], which
324+
* requires JavaScript to be displayed.
325+
* Call `.copy(script = "")` on the returned [DataFrameHtmlData] to remove this hiding/fallback mechanism.
326+
*
322327
* @param configuration optional configuration for rendering
323328
* @param cellRenderer optional cell renderer for rendering
324329
* @param includeCss whether to include CSS in the output. This is `true` by default but it can be set

0 commit comments

Comments
 (0)