common-dependencies/org.jetbrains.kotlinx.jupyter.common/ReplLineMagic

ReplLineMagic

enum ReplLineMagic : Enum<ReplLineMagic>

This class defines the magic commands available to users of a notebook. They are accessed by using the %<enumNameInCamelCase> syntax inside a notebook.

Example:

// Snippet 1
%useLatestDescriptors
println("Hello world")

Adding new magic value also requires registering a handler in org.jetbrains.kotlinx.jupyter.magics.AbstractMagicsHandler.

Entries

USE

TRACK_CLASSPATH

TRACK_EXECUTION

DUMP_CLASSES_FOR_SPARK

USE_LATEST_DESCRIPTORS

OUTPUT

LOG_LEVEL

LOG_HANDLER

Types

Companion

object Companion : ReplEnum<ReplLineMagic>

Properties

argumentsUsage

val argumentsUsage: String? = null

desc

val desc: String

entries

val entries: EnumEntries<ReplLineMagic>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

nameForUser

val nameForUser: String

ordinal

val ordinal: Int

visibleInHelp

val visibleInHelp: Boolean = true

Functions

valueOf

fun valueOf(value: String): ReplLineMagic

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<ReplLineMagic>

Returns an array containing the constants of this enum type, in the order they're declared.