org.jetbrains.kotlinx.jupyter.api.RenderersProcessor.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-jupyter-api Show documentation

API for libraries supporting Kotlin Jupyter notebooks

There is a newer version: 0.12.0-335

package org.jetbrains.kotlinx.jupyter.api

import org.jetbrains.kotlinx.jupyter.api.libraries.ExecutionHost

/**
 * [RenderersProcessor] is responsible for rendering objects.
 * You may use it to render values exactly like notebook renders results,
 * and also register new renderers in runtime.
 */
interface RenderersProcessor {
    /**
     * Renders [value] in context of this execution [host]
     */
    fun renderValue(
        host: ExecutionHost,
        value: Any?,
    ): Any?

    /**
     * Adds new [renderer] for this notebook.
     * Don't turn on the optimizations for [PrecompiledRendererTypeHandler]
     */
    fun registerWithoutOptimizing(renderer: RendererFieldHandler)

    fun registerWithoutOptimizing(
        renderer: RendererFieldHandler,
        priority: Int,
    )

    fun unregister(renderer: RendererFieldHandler)

    fun unregisterAll()

    fun registeredRenderers(): List
}