dataframe-json/org.jetbrains.kotlinx.dataframe.io/toJsonWithMetadata

toJsonWithMetadata

fun AnyFrame.toJsonWithMetadata(rowLimit: Int, nestedRowLimit: Int? = null, prettyPrint: Boolean = false, customEncoders: List<CustomEncoder> = emptyList(), isFormatted: Boolean = false): String

Converts the DataFrame to a JSON string representation with additional metadata about serialized data. It is heavily used to implement some integration features in Kotlin Notebook IntelliJ IDEA plugin.

Return

The DataFrame converted to a JSON string with metadata.

Parameters

rowLimit

The maximum number of top-level dataframe rows to include in the output JSON.

nestedRowLimit

The maximum number of nested frame rows to include in the output JSON. If null, all rows are included. Applied for each frame column recursively

prettyPrint

Specifies whether the output JSON should be formatted with indentation and line breaks.

customEncoders

The options for encoding things like images. The default is empty list, which indicates that the image is not encoded as Base64.

isFormatted

Specifies whether the DataFrame should be formatted, a.k.a. it comes from FormattedFrame.df or it contains a DataColumn<FormattedFrame<*>> at any depth. This is just a marker; formatting is applied by the renderer. Defaults to false.