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

Package-level declarations

Types

Base64ImageEncodingOptions

class Base64ImageEncodingOptions(val imageSizeLimit: Int = DEFAULT_IMG_SIZE, options: Int = GZIP_ON or LIMIT_SIZE_ON)

Class representing the options for encoding images.

CustomEncoder

interface CustomEncoder

Interface for defining a custom encoder. That applied to the value during dataframe JSON serialization

DefaultReadJsonMethod

internal class DefaultReadJsonMethod(path: String?, arguments: MethodArguments) : AbstractDefaultReadMethod

JSON

class JSON(typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, keyValuePaths: List<JsonPath> = emptyList(), unifyNumbers: Boolean = true) : SupportedDataFrameFormat

JsonFacadeForDebugger

open class JsonFacadeForDebugger

Properties

ARRAY_COLUMN_NAME

internal const val ARRAY_COLUMN_NAME: String

DEFAULT_IMG_SIZE

internal const val DEFAULT_IMG_SIZE: Int = 600

VALUE_COLUMN_NAME

internal const val VALUE_COLUMN_NAME: String

Functions

readJson

fun DataFrame.Companion.readJson(file: File, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyFrame

fun DataFrame.Companion.readJson(url: URL, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyFrame

fun DataFrame.Companion.readJson(path: Path, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyFrame

fun DataFrame.Companion.readJson(path: String, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyFrame

fun DataRow.Companion.readJson(file: File, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyRow

fun DataRow.Companion.readJson(url: URL, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyRow

fun DataRow.Companion.readJson(path: Path, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyRow

fun DataRow.Companion.readJson(path: String, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyRow

fun DataFrame.Companion.readJson(stream: InputStream, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true, format: Json = Json.Default): AnyFrame

fun DataRow.Companion.readJson(stream: InputStream, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true, format: Json = Json.Default): AnyRow

readJsonStr

fun DataFrame.Companion.readJsonStr(text: String, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyFrame

fun DataRow.Companion.readJsonStr(text: String, header: List<String> = emptyList(), keyValuePaths: List<JsonPath> = emptyList(), typeClashTactic: JSON.TypeClashTactic = ARRAY_AND_VALUE_COLUMNS, unifyNumbers: Boolean = true): AnyRow

toJson

fun AnyFrame.toJson(prettyPrint: Boolean = false): String

Converts this DataFrame to a JSON array; each row becomes an element of that array.

fun AnyRow.toJson(prettyPrint: Boolean = false): String

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.

writeJson

fun AnyFrame.writeJson(file: File, prettyPrint: Boolean = false)

fun AnyFrame.writeJson(writer: Appendable, prettyPrint: Boolean = false)

fun AnyFrame.writeJson(path: Path, prettyPrint: Boolean = false)

fun AnyFrame.writeJson(path: String, prettyPrint: Boolean = false)

fun AnyRow.writeJson(file: File, prettyPrint: Boolean = false)

fun AnyRow.writeJson(writer: Appendable, prettyPrint: Boolean = false)

fun AnyRow.writeJson(path: Path, prettyPrint: Boolean = false)

fun AnyRow.writeJson(path: String, prettyPrint: Boolean = false)