Skip to content

Commit 41f6cab

Browse files
committed
updated kdocs of format with information about colgroups and framecols
1 parent c33e89e commit 41f6cab

File tree

1 file changed

+14
-0
lines changed
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api

1 file changed

+14
-0
lines changed

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ import org.jetbrains.kotlinx.dataframe.api.FormattingDsl.linear
1414
import org.jetbrains.kotlinx.dataframe.api.FormattingDsl.linearBg
1515
import org.jetbrains.kotlinx.dataframe.api.FormattingDsl.rgb
1616
import org.jetbrains.kotlinx.dataframe.api.FormattingDsl.textColor
17+
import org.jetbrains.kotlinx.dataframe.columns.ColumnGroup
1718
import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
1819
import org.jetbrains.kotlinx.dataframe.columns.ColumnWithPath
20+
import org.jetbrains.kotlinx.dataframe.columns.FrameColumn
1921
import org.jetbrains.kotlinx.dataframe.columns.toColumnSet
2022
import org.jetbrains.kotlinx.dataframe.dataTypes.IFRAME
2123
import org.jetbrains.kotlinx.dataframe.dataTypes.IMG
@@ -66,9 +68,21 @@ import kotlin.reflect.KProperty
6668
*
6769
* You can continue formatting the [FormattedFrame] by calling [format][FormattedFrame.format] on it again.
6870
*
71+
* Specifying a [column group][ColumnGroup] makes all of its inner columns to be formatted in the same way unless
72+
* overridden.
73+
*
6974
* Formatting is done additively, meaning you can add more formatting to a cell that's already formatted or
7075
* override certain attributes inherited from its outer group.
7176
*
77+
* Specifying a [frame column][FrameColumn] at the moment does nothing
78+
* ([Issue #1375](https://github.com/Kotlin/dataframe/issues/1375)),
79+
* convert each nested [DataFrame] to a [FormattedFrame] instead:
80+
* ```kt
81+
* df.convert { myFrameCol }.with {
82+
* it.format { someCol }.with { background(green) }
83+
* }.toStandaloneHtml()
84+
* ```
85+
*
7286
* Check out the [Grammar].
7387
*
7488
* For more information: {@include [DocumentationUrls.Format]}

0 commit comments

Comments
 (0)