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

FormattingDsl

The formatting DSL allows you to create and combine CellAttributes to apply to one or multiple cells of a dataframe such that they have specific CSS attributes applied to them when rendered to HTML.

For instance, to specify black, bold text on a white background, you could write:

background(white) and textColor(black) and bold

It's also possible to define your own colors using rgb or interpolate colors using linear.

Use attr if you want to specify a custom CSS attribute.

For more information: See format on the documentation website.

Properties

black

val black: RgbColor

blue

val blue: RgbColor

bold

val bold: CellAttributes

A cell attribute that makes the text inside the cell bold.

darkGray

val darkGray: RgbColor

gray

val gray: RgbColor

green

val green: RgbColor

italic

val italic: CellAttributes

A cell attribute that makes the text inside the cell italic.

lightGray

val lightGray: RgbColor

red

val red: RgbColor

underline

val underline: CellAttributes

A cell attribute that u͟n͟d͟e͟r͟l͟i͟n͟e͟s͟ the text inside the cell.

white

val white: RgbColor

Functions

attr

fun attr(name: String, value: String): CellAttributes

A custom cell attribute that allows you to specify any custom CSS attribute by name and value.

background

fun background(color: RgbColor): CellAttributes

A cell attribute that sets the background color of a cell.

fun background(r: Short, g: Short, b: Short): CellAttributes

A cell attribute that sets the background color of a cell. A shortcut for background(rgb(...)).

linear

fun linear(value: Number, from: Pair<Number, RgbColor>, to: Pair<Number, RgbColor>): RgbColor

Calculates an RgbColor by interpolating between from and to, given value. The interpolation is linear. If value falls outside the range from..to, the colors at the bounds will be used.

linearBg

fun linearBg(value: Number, from: Pair<Number, RgbColor>, to: Pair<Number, RgbColor>): CellAttributes

Shorthand for background(linear(...))

rgb

fun rgb(r: Short, g: Short, b: Short): RgbColor

Creates a new RgbColor instance with r (red), g (green), and b (blue) values from 0..255.

textColor

fun textColor(color: RgbColor): CellAttributes

A cell attribute that sets the text color of a cell.

fun textColor(r: Short, g: Short, b: Short): CellAttributes

A cell attribute that sets the text color of a cell. A shortcut for textColor(rgb(...)).