core/org.jetbrains.kotlinx.dataframe.api/FormattedFrame

FormattedFrame

class FormattedFrame<T>(val df: DataFrame<T>, val formatter: RowColFormatter<T, *>? = null, val headerFormatter: HeaderColFormatter<*>? = null)

A wrapper around a DataFrame with CSS attributes that can be converted to a formatted HTML table in the form of DataFrameHtmlData.

Call toHtml or toStandaloneHtml to get the HTML representation of the DataFrame.

In Jupyter kernel (Kotlin Notebook) environments, you can often output this class directly. Use toHtml or toStandaloneHtml when this produces unexpected results.

You can apply further formatting to this FormattedFrame by calling format() once again.

For more information: See format on the documentation website. See toHtml on the documentation website.

Constructors

FormattedFrame

constructor(df: DataFrame<T>, formatter: RowColFormatter<T, *>? = null, headerFormatter: HeaderColFormatter<*>? = null)

Properties

internal val df: DataFrame<T>

formatter

internal val formatter: RowColFormatter<T, *>?

headerFormatter

internal val headerFormatter: HeaderColFormatter<*>?

Functions

format

fun <T> FormattedFrame<T>.format(): FormatClause<T, Any?>

Formats the specified columns or cells within this dataframe such that they have specific CSS attributes applied to them when rendering the dataframe to HTML.

fun <T, C> FormattedFrame<T>.format(columns: ColumnsSelector<T, C>): FormatClause<T, C>

fun <T> FormattedFrame<T>.format(vararg columns: String): FormatClause<T, Any?>

Formats the specified columns or cells within this dataframe such that they have specific CSS attributes applied to them when rendering the dataframe to HTML.

formatHeader

fun <T> FormattedFrame<T>.formatHeader(): HeaderFormatClause<T, Any?>

fun <T, C> FormattedFrame<T>.formatHeader(columns: ColumnsSelector<T, C>): HeaderFormatClause<T, C>

fun <T> FormattedFrame<T>.formatHeader(vararg columns: String): HeaderFormatClause<T, Any?>

Experimental API. It may be changed in the future.

getDisplayConfiguration

fun getDisplayConfiguration(configuration: DisplayConfiguration): DisplayConfiguration

Applies this formatter to the given configuration and returns a new instance.

toHtml

fun toHtml(configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT, cellRenderer: CellRenderer = DefaultCellRenderer, getFooter: (DataFrame<T>) -> String? = { "DataFrame [${it.size}]" }): DataFrameHtmlData

Returns a DataFrameHtmlData without additional definitions. Can be rendered in Jupyter kernel (Kotlin Notebook) environments or other environments that already have CSS- and script definitions for DataFrame.

toStandaloneHtml

fun toStandaloneHtml(configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT, cellRenderer: CellRenderer = DefaultCellRenderer, getFooter: (DataFrame<T>) -> String? = { "DataFrame [${it.size}]" }): DataFrameHtmlData

Returns a DataFrameHtmlData with CSS- and script definitions for DataFrame.