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

FormatClause

class FormatClause<T, C>(val df: DataFrame<T>, val columns: ColumnsSelector<T, C> = { all().cast() }, val oldFormatter: RowColFormatter<T, C>? = null, val filter: RowValueFilter<T, C> = { true }, val oldHeaderFormatter: HeaderColFormatter<*>? = null)

An intermediate class used in the format operation.

This class itself does nothing—it is just a transitional step before specifying how to format the selected columns. It must be followed by one of the positioning methods to produce a new FormattedFrame; a DataFrame with HTML formatting data.

Use the following function to filter the rows to format:

where – filters the rows to format using a RowValueFilter.
at – Only format in rows with certain indices.
notNull – Only format cells that have non-null values.

Use the following functions to finalize this formatting round:

with – Specifies how to format the cells using a CellFormatter.
perRowCol – Specifies how to format each cell individually using a RowColFormatter.
linearBg – Interpolates between two colors to set the background color of each numeric cell based on its value. Shorthand for .with{ background(linear(it, from, to)) }
notNull – Specifies how to format non-null cells using a CellFormatter. Shorthand for .notNull().with { }.

For more information: See format on the documentation website.

See Grammar for more details.

Constructors

FormatClause

constructor(df: DataFrame<T>, columns: ColumnsSelector<T, C> = { all().cast() }, oldFormatter: RowColFormatter<T, C>? = null, filter: RowValueFilter<T, C> = { true }, oldHeaderFormatter: HeaderColFormatter<*>? = null)

Properties

columns

internal val columns: ColumnsSelector<T, C>

internal val df: DataFrame<T>

filter

internal val filter: RowValueFilter<T, C>

oldFormatter

internal val oldFormatter: RowColFormatter<T, C>?

oldHeaderFormatter

internal val oldHeaderFormatter: HeaderColFormatter<*>?

Functions

fun <T, C> FormatClause<T, C>.at(rowIndices: Collection<Int>): FormatClause<T, C>

fun <T, C> FormatClause<T, C>.at(rowRange: IntRange): FormatClause<T, C>

fun <T, C> FormatClause<T, C>.at(vararg rowIndices: Int): FormatClause<T, C>

Only format the selected columns at given row indices.

formatImpl

internal inline fun <T, C> FormatClause<T, C>.formatImpl(crossinline formatter: RowColFormatter<T, C>): FormattedFrame<T>

linearBg

fun <T, C : Number?> FormatClause<T, C>.linearBg(from: Pair<Number, RgbColor>, to: Pair<Number, RgbColor>): FormattedFrame<T>

Creates a new FormattedFrame by just changing the background colors of the selected cells.

notNull

fun <T, C> FormatClause<T, C?>.notNull(): FormatClause<T, C>

Filters the format-selection to only include cells where the value is not null.

fun <T, C> FormatClause<T, C?>.notNull(formatter: CellFormatter<C>): FormattedFrame<T>

Creates a new FormattedFrame that uses the specified CellFormatter to format selected non-null cells of the dataframe.

perRowCol

fun <T, C> FormatClause<T, C>.perRowCol(formatter: RowColFormatter<T, C>): FormattedFrame<T>

Creates a new FormattedFrame that uses the specified RowColFormatter to format the selected cells of the dataframe.

toString

open override fun toString(): String

where

fun <T, C> FormatClause<T, C>.where(filter: RowValueFilter<T, C>): FormatClause<T, C>

Filters the rows to format using a RowValueFilter.

with

fun <T, C> FormatClause<T, C>.with(formatter: CellFormatter<C>): FormattedFrame<T>

Creates a new FormattedFrame that uses the specified CellFormatter to format the selected cells of the dataframe.