Skip to content

Commit 7e6256b

Browse files
Fix formatted frame toHtml methods
1 parent 645c9c8 commit 7e6256b

2 files changed

Lines changed: 23 additions & 8 deletions

File tree

core/api/core.api

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2302,10 +2302,10 @@ public final class org/jetbrains/kotlinx/dataframe/api/FormattedFrame {
23022302
public fun <init> (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function2;)V
23032303
public synthetic fun <init> (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function2;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
23042304
public final fun getDisplayConfiguration (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;)Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;
2305-
public final fun toHtml (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2306-
public static synthetic fun toHtml$default (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2307-
public final fun toStandaloneHtml (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2308-
public static synthetic fun toStandaloneHtml$default (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2305+
public final fun toHtml (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2306+
public static synthetic fun toHtml$default (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2307+
public final fun toStandaloneHtml (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2308+
public static synthetic fun toStandaloneHtml$default (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
23092309
}
23102310

23112311
public final class org/jetbrains/kotlinx/dataframe/api/FormattingDsl {

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/format.kt

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@ import org.jetbrains.kotlinx.dataframe.io.DataFrameHtmlData
4040
import org.jetbrains.kotlinx.dataframe.io.DisplayConfiguration
4141
import org.jetbrains.kotlinx.dataframe.io.toHtml
4242
import org.jetbrains.kotlinx.dataframe.io.toStandaloneHtml
43+
import org.jetbrains.kotlinx.dataframe.jupyter.CellRenderer
44+
import org.jetbrains.kotlinx.dataframe.jupyter.DefaultCellRenderer
4345
import org.jetbrains.kotlinx.dataframe.jupyter.RenderedContent.Companion.media
46+
import org.jetbrains.kotlinx.dataframe.size
4447
import org.jetbrains.kotlinx.dataframe.util.DEPRECATED_ACCESS_API
4548
import org.jetbrains.kotlinx.dataframe.util.FORMATTING_DSL
4649
import org.jetbrains.kotlinx.dataframe.util.FORMATTING_DSL_REPLACE
@@ -803,10 +806,16 @@ public class FormattedFrame<T>(
803806
*
804807
* @param [configuration] The [DisplayConfiguration] to use as a base for this [FormattedFrame].
805808
* Default: [DisplayConfiguration.DEFAULT].
809+
* @param [cellRenderer] Mostly for internal usage, use [DefaultCellRenderer] if unsure.
810+
* @param [getFooter] Allows you to specify how to render the footer text beneath the dataframe.
811+
* Default: `"DataFrame [rows x cols]"`
806812
* @see toStandaloneHtml
807813
*/
808-
public fun toHtml(configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT): DataFrameHtmlData =
809-
df.toHtml(getDisplayConfiguration(configuration))
814+
public fun toHtml(
815+
configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT,
816+
cellRenderer: CellRenderer = DefaultCellRenderer,
817+
getFooter: (DataFrame<T>) -> String? = { "DataFrame [${it.size}]" },
818+
): DataFrameHtmlData = df.toHtml(getDisplayConfiguration(configuration), cellRenderer, getFooter)
810819

811820
/**
812821
* Returns a [DataFrameHtmlData] with CSS- and script definitions for DataFrame.
@@ -827,10 +836,16 @@ public class FormattedFrame<T>(
827836
*
828837
* @param [configuration] The [DisplayConfiguration] to use as a base for this [FormattedFrame].
829838
* Default: [DisplayConfiguration.DEFAULT].
839+
* @param [cellRenderer] Mostly for internal usage, use [DefaultCellRenderer] if unsure.
840+
* @param [getFooter] Allows you to specify how to render the footer text beneath the dataframe.
841+
* Default: `"DataFrame [rows x cols]"`
830842
* @see toHtml
831843
*/
832-
public fun toStandaloneHtml(configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT): DataFrameHtmlData =
833-
df.toStandaloneHtml(getDisplayConfiguration(configuration))
844+
public fun toStandaloneHtml(
845+
configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT,
846+
cellRenderer: CellRenderer = DefaultCellRenderer,
847+
getFooter: (DataFrame<T>) -> String? = { "DataFrame [${it.size}]" },
848+
): DataFrameHtmlData = df.toStandaloneHtml(getDisplayConfiguration(configuration), cellRenderer, getFooter)
834849

835850
/** Applies this formatter to the given [configuration] and returns a new instance. */
836851
@Suppress("UNCHECKED_CAST")

0 commit comments

Comments
 (0)