Options
All
  • Public
  • Public/Protected
  • All
Menu

jupyter-js-notebook

Index

Modules

Classes

Interfaces

Type aliases

Functions

Type aliases

EdgeLocation

EdgeLocation: "top" | "bottom"

The location of requested edges.

JSONPrimitive

JSONPrimitive: boolean | number | string

A type alias for a JSON primitive.

JSONValue

JSONValue: JSONPrimitive | JSONObject | JSONArray

A type alias for a JSON value.

NotebookMode

NotebookMode: "command" | "edit"

The interactivity modes for the notebook.

Functions

deepEqual

  • Compare two JSON values for deep equality.

    Parameters

    • first: JSONValue

      The first JSON value of interest.

    • second: JSONValue

      The second JSON value of interest.

    Returns boolean

    true if the values are equivalent, false otherwise.

executeCode

  • executeCode(code: string, kernel: IKernel, outputs: ObservableOutputs): Promise<IExecuteReply>

  • Execute code on a kernel and send outputs to an observable output.

    Parameters

    Returns Promise<IExecuteReply>

isArray

  • Test whether a JSON value is an array.

    Parameters

    • value: JSONValue

      The JSON value of interest.

    Returns boolean

    true if the value is a an array, false otherwise.

isObject

  • Test whether a JSON value is an object.

    Parameters

    • value: JSONValue

      The JSON value of interest.

    Returns boolean

    true if the value is a an object, false otherwise.

isPrimitive

  • Test whether a JSON value is a primitive.

    Parameters

    • value: JSONValue

      The JSON value of interest.

    Returns boolean

    true if the value is a primitive or null, false otherwise.

mimetypeForLanguage

  • mimetypeForLanguage(info: IKernelLanguageInfo): string

  • Get the appropriate codemirror mimetype given language info.

    Parameters

    • info: IKernelLanguageInfo

    Returns string

trustNotebook

  • trustNotebook(model: INotebookModel, host?: HTMLElement): Promise<void>

  • Trust the notebook after prompting the user.

    Parameters

    • model: INotebookModel

      The notebook model.

    • Optional host: HTMLElement

      The host node for the confirmation dialog (defaults to body).

    Returns Promise<void>

    a promise that resolves when the transaction is finished.

    Notes

    No dialog will be presented if the notebook is already trusted.

Generated using TypeDoc