Add a script to expand nested frames in HTML samples. Expand nested frames in countDistinct website docs

Author: Allex-Nik

docs/StardustDocs/resources/api/countDistinct/countDistinctColumnsGroupBy.html

@@ -497,6 +497,36 @@
 
 call_DataFrame(function() { DataFrame.renderTable(0) });
 
+(function () {
+    function expandColumnGroups(df) {
+        for (let col of df.cols) {
+            if (col.parent === undefined && col.children.length > 0) col.expanded = true;
+        }
+    }
+
+    function expandNestedFrames(df, rootDf) {
+        for (let col of df.cols) {
+            for (let value of col.values) {
+                if (value && value.frameId !== undefined) {
+                    rootDf.expandedFrames.add(value.frameId);
+                    let child = rootDf.childFrames[value.frameId];
+                    if (child) {
+                        expandColumnGroups(child);
+                        expandNestedFrames(child, rootDf);
+                    }
+                }
+            }
+        }
+    }
+
+    document.querySelectorAll("table.dataframe").forEach(function (table) {
+        if (table.df && table.df.id === table.df.rootId) {
+            let rootDf = table.df;
+            expandNestedFrames(rootDf, rootDf);
+            DataFrame.renderTable(rootDf.id);
+        }
+    });
+})();
 function sendHeight() {
     const table = document.querySelector('table.dataframe');
     if (!table) return;

docs/StardustDocs/resources/api/countDistinct/countDistinctGroupBy.html

@@ -497,6 +497,36 @@
 
 call_DataFrame(function() { DataFrame.renderTable(0) });
 
+(function () {
+    function expandColumnGroups(df) {
+        for (let col of df.cols) {
+            if (col.parent === undefined && col.children.length > 0) col.expanded = true;
+        }
+    }
+
+    function expandNestedFrames(df, rootDf) {
+        for (let col of df.cols) {
+            for (let value of col.values) {
+                if (value && value.frameId !== undefined) {
+                    rootDf.expandedFrames.add(value.frameId);
+                    let child = rootDf.childFrames[value.frameId];
+                    if (child) {
+                        expandColumnGroups(child);
+                        expandNestedFrames(child, rootDf);
+                    }
+                }
+            }
+        }
+    }
+
+    document.querySelectorAll("table.dataframe").forEach(function (table) {
+        if (table.df && table.df.id === table.df.rootId) {
+            let rootDf = table.df;
+            expandNestedFrames(rootDf, rootDf);
+            DataFrame.renderTable(rootDf.id);
+        }
+    });
+})();
 function sendHeight() {
     const table = document.querySelector('table.dataframe');
     if (!table) return;

samples/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/DataFrameSampleHelper.kt

@@ -1,8 +1,13 @@
 package org.jetbrains.kotlinx.dataframe.samples
 
 import org.jetbrains.kotlinx.dataframe.DataColumn
+import org.jetbrains.kotlinx.dataframe.DataFrame
 import org.jetbrains.kotlinx.dataframe.api.CodeString
+import org.jetbrains.kotlinx.dataframe.api.GroupBy
 import org.jetbrains.kotlinx.dataframe.api.toDataFrame
+import org.jetbrains.kotlinx.dataframe.io.DataFrameHtmlData
+import org.jetbrains.kotlinx.dataframe.io.DisplayConfiguration
+import org.jetbrains.kotlinx.dataframe.io.toStandaloneHtml
 import org.jetbrains.kotlinx.dataframe.samples.api.TestBase
 import org.jetbrains.kotlinx.kandy.letsplot.samples.SampleHelper
 import java.io.File
@@ -44,4 +49,48 @@ abstract class DataFrameSampleHelper(sampleName: String, subFolder: String = "sa
     fun DataColumn<*>.saveDfHtmlSample() {
         toDataFrame().saveDfHtmlSample()
     }
+
+    // TODO: might be changed as #1887 is fixed
+    private val expandNestedFramesScript = DataFrameHtmlData(
+        script =
+            """
+        (function () {
+            function expandColumnGroups(df) {
+                for (let col of df.cols) {
+                    if (col.parent === undefined && col.children.length > 0) col.expanded = true;
+                }
+            }
+
+            function expandNestedFrames(df, rootDf) {
+                for (let col of df.cols) {
+                    for (let value of col.values) {
+                        if (value && value.frameId !== undefined) {
+                            rootDf.expandedFrames.add(value.frameId);
+                            let child = rootDf.childFrames[value.frameId];
+                            if (child) {
+                                expandColumnGroups(child);
+                                expandNestedFrames(child, rootDf);
+                            }
+                        }
+                    }
+                }
+            }
+
+            document.querySelectorAll("table.dataframe").forEach(function (table) {
+                if (table.df && table.df.id === table.df.rootId) {
+                    let rootDf = table.df;
+                    expandNestedFrames(rootDf, rootDf);
+                    DataFrame.renderTable(rootDf.id);
+                }
+            });
+        })();
+        """.trimIndent(),
+    )
+
+    fun DataFrame<*>.toExpandedHtml() = toStandaloneHtml(
+        configuration = DisplayConfiguration(enableFallbackStaticTables = false),
+        getFooter = { "" },
+    ) + expandNestedFramesScript
+
+    fun GroupBy<*, *>.toExpandedHtml() = toDataFrame().toExpandedHtml()
 }

samples/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/CountDistinctSamples.kt

@@ -68,6 +68,7 @@ class CountDistinctSamples : DataFrameSampleHelper("countDistinct", "api") {
         // SampleStart
         df.groupBy { city }
             // SampleEnd
+            .toExpandedHtml()
             .saveDfHtmlSample()
     }
 
@@ -130,6 +131,7 @@ class CountDistinctSamples : DataFrameSampleHelper("countDistinct", "api") {
                     background(firstNameToColor(firstName)) and textColor(black)
                 }
             }
+            .toExpandedHtml()
             .saveDfHtmlSample()
     }
 }