api/org.jetbrains.kotlinx.jupyter.api/MimeTypedResult

MimeTypedResult

class MimeTypedResult(mimeData: Map<String, String>, isolatedHtml: Boolean = false, val id: String? = null) : MimeTypedResultEx, Map<String, String>

Convenient implementation of DisplayResult, supposed to be used almost always.

Constructors

MimeTypedResult

constructor(mimeData: Map<String, String>, isolatedHtml: Boolean = false, id: String? = null)

Properties

entries

open override val entries: Set<Map.Entry<String, String>>

open override val id: String? = null

Unique id that may be used for updating display data

isExpandedJson

var MimeTypedResultEx.isExpandedJson: Boolean

isIsolatedHtml

var MimeTypedResultEx.isIsolatedHtml: Boolean

isolatedHtml

var ~~isolatedHtml~~: Boolean

keys

open override val keys: Set<String>

size

open override val size: Int

values

open override val values: Collection<String>

Functions

addMetadataModifier

fun addMetadataModifier(metadataModifier: MetadataModifier)

containsKey

open override fun containsKey(key: String): Boolean

containsValue

open override fun containsValue(value: String): Boolean

forEach

open fun forEach(p0: BiConsumer<in String, in String>)

get

open operator override fun get(key: String): String?

getOrDefault

open fun getOrDefault(key: String, defaultValue: String): String

hasMetadataModifiers

fun hasMetadataModifiers(predicate: (MetadataModifier) -> Boolean): Boolean

isEmpty

open override fun isEmpty(): Boolean

removeMetadataModifier

fun removeMetadataModifier(metadataModifier: MetadataModifier)

render

open override fun render(notebook: Notebook): DisplayResult

Renders display result, generally should return this

toJson

open fun ~~toJson~~(additionalMetadata: JsonObject = Json.EMPTY): JsonObject

open override fun toJson(additionalMetadata: JsonObject, overrideId: String?): JsonObject

Converts display data to JSON object for display_data response

toJson

fun DisplayResult?.toJson(): JsonObject

Convenience method for converting nullable DisplayResult to JSON

withId

fun DisplayResult.withId(id: String): DisplayResult