api/org.jetbrains.kotlinx.jupyter.api/Notebook

Notebook

interface Notebook

Notebook is a main entry point for Kotlin Jupyter API

Properties

afterCellExecutionsProcessor

abstract val afterCellExecutionsProcessor: ExtensionsProcessor<AfterCellExecutionCallback>

beforeCellExecutionsProcessor

abstract val beforeCellExecutionsProcessor: ExtensionsProcessor<ExecutionCallback<*>>

cellsList

abstract val cellsList: Collection<CodeCell>

All executed cells of this notebook

cellVariables

abstract val cellVariables: Map<Int, Set<String>>

Stores info about useful variables in a cell. Key: cellId; Value: set of variable names. Useful <==> declarations + modifying references

codePreprocessorsProcessor

abstract val codePreprocessorsProcessor: ExtensionsProcessor<CodePreprocessor>

colorSchemeChangeCallbacksProcessor

abstract val colorSchemeChangeCallbacksProcessor: ExtensionsProcessor<ColorSchemeChangedCallback>

commManager

abstract val commManager: CommManager

Manages custom messages

currentCell

open val currentCell: CodeCell?

Current cell

currentClasspath

abstract val currentClasspath: List<String>

Current session classpath

currentColorScheme

abstract val currentColorScheme: ColorScheme?

Current color scheme. Works correctly only in Kotlin Notebook plugin

displays

abstract val displays: DisplayContainer

executionHost

abstract val executionHost: KotlinKernelHost?

Represents the execution host for the Kotlin kernel. Could be null outside of the execution, so use it with care.

fieldsHandlersProcessor

abstract val fieldsHandlersProcessor: FieldsProcessor

interruptionCallbacksProcessor

abstract val interruptionCallbacksProcessor: ExtensionsProcessor<InterruptionCallback>

jreInfo

abstract val jreInfo: JREInfoProvider

Current JRE info

jupyterClientType

abstract val jupyterClientType: JupyterClientType

Jupyter client that started the current kernel session

kernelRunMode

abstract val kernelRunMode: KernelRunMode

Kernel Run mode. Determines some capabilities of a running kernel depending on the environment it's running under

kernelVersion

abstract val kernelVersion: KotlinKernelVersion

Current kernel version

lastCell

open val lastCell: CodeCell?

Last evaluated cell

libraryLoader

abstract val libraryLoader: LibraryLoader

LibraryLoader of the current session

libraryRequests

abstract val libraryRequests: Collection<LibraryResolutionRequest>

All requests for libraries made during this session

loggerFactory

abstract val loggerFactory: KernelLoggerFactory

Logger factory of the current session

renderersProcessor

abstract val renderersProcessor: RenderersProcessor

Renderers processor gives an ability to render values and add new renderers

resultsAccessor

abstract val resultsAccessor: ResultsAccessor

Returns the object that allows to access execution results

sessionOptions

abstract val sessionOptions: SessionOptions

Configuration options for the current notebook session.

shutdownExecutionsProcessor

abstract val shutdownExecutionsProcessor: ExtensionsProcessor<ExecutionCallback<*>>

textRenderersProcessor

abstract val textRenderersProcessor: TextRenderersProcessor

throwableRenderersProcessor

abstract val throwableRenderersProcessor: ThrowableRenderersProcessor

variablesState

abstract val variablesState: Map<String, VariableState>

Current state of visible variables

Functions

animate

fun Notebook.animate(nextFrame: () -> Frame<*>?)

Triggers the animation sequence consisting of frames that are produced by the nextFrame function.

fun Notebook.animate(iterable: Iterable<Frame<*>>)

Displays all the frames in this iterable, with respect to the delays.

fun Notebook.animate(frames: Iterator<Frame<*>>)

Displays all the frames left in this frames iterator, with respect to the delays.

fun Notebook.animate(sequence: Sequence<Frame<*>>)

Displays all the frames in this sequence, with respect to the delays.

fun Notebook.animate(framesCount: Int, frameByIndex: (index: Int) -> Frame<*>)

Animates a sequence of frames by displaying them with respect to their delays.

fun Notebook.animate(delay: Duration, nextValue: () -> Any?)

fun Notebook.animate(delay: Duration, sequence: Sequence<*>)

fun <T : Any> Notebook.animate(delay: Duration, firstValue: T?, nextValue: (T) -> T?)

fun Notebook.animate(delay: Duration, framesCount: Int, valueByIndex: (index: Int) -> Any?)

Animates a sequence of values with a specified delay between each frame. The first value is displayed without a delay.

fun Notebook.animate(delay: Duration, iterable: Iterable<*>)

Animates an iterable sequence of values, each one (except first) appearing after a specified delay.

fun Notebook.animate(delay: Duration, iterator: Iterator<*>)

Animates a sequence of values by displaying them with specified delay. The first value is displayed without a delay.

fun <T> Notebook.animate(firstFrame: Frame<T>, nextFrame: (Frame<T>) -> Frame<T>?)

Triggers the animation using a chain of frames, beginning with firstFrame and subsequently obtained through the nextFrame function.

changeColorScheme

abstract fun changeColorScheme(newScheme: ColorScheme)

Change color scheme and run callbacks. Works correctly only in Kotlin Notebook plugin

display

fun Notebook.display(value: Any, id: String? = null)

Displays the given value in the notebook.

getAllDisplays

abstract fun getAllDisplays(): List<DisplayResultWithCell>

Information about all display data objects

getCell

abstract fun getCell(id: Int): CodeCell

Mapping allowing to get cell by execution number

getDisplaysById

abstract fun getDisplaysById(id: String?): List<DisplayResultWithCell>

Information about displays with the given id

getLibraryFromDescriptor

abstract fun getLibraryFromDescriptor(descriptorText: String, options: Map<String, String> = emptyMap()): LibraryDefinition

Converts descriptor JSON text into LibraryDefinition

getResult

abstract fun getResult(id: Int): Any?

Mapping allowing to get a result by execution number

history

abstract fun history(before: Int): CodeCell?

Get cell by relative offset: 0 for current cell, 1 for previous cell, and so on

prompt

abstract fun prompt(prompt: String = DefaultPromptOptions.PROMPT, isPassword: Boolean = DefaultPromptOptions.IS_PASSWORD): String

Prompts the user for input and returns the entered value as a String.

renderHtmlAsIFrame

abstract fun renderHtmlAsIFrame(data: HtmlData): MimeTypedResult

Renders HTML as iframe that fixes scrolling and color scheme issues in Kotlin Notebook plugin

renderHtmlAsIFrameIfNeeded

fun Notebook.renderHtmlAsIFrameIfNeeded(data: HtmlData): MimeTypedResult

Renders HTML as iframe in Kotlin Notebook or simply in other clients

updateDisplay

fun Notebook.updateDisplay(value: Any, id: String? = null)

Updates the display with the given value.