The common-lisp-jupyter Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The common-lisp-jupyter Reference Manual

This is the common-lisp-jupyter Reference Manual, version 0.1, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Fri May 24 08:40:33 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

common-lisp-jupyter

Binder Quicklisp Build Status Build status

A Common Lisp kernel for Jupyter along with a library for building Jupyter kernels, based on Maxima-Jupyter by Robert Dodier which was based on cl-jupyter by Frederic Peschanski.

This file describes the installation and usage of common-lisp-jupyter on a local machine, but you can try out common-lisp-jupyter without installing anything by clicking on the Binder badge above.

Motivation

In developing Maxima-Jupyter there were a number of enhancements and features added that cl-jupyter does not support. Because the structure of Maxima-Jupyter is significantly different from cl-jupyter back-porting these changes would probably be difficult. Therefore common-lisp-jupyter was created as library to support both Maxima-Jupyter and the included Common Lisp kernel. The library component handles all Jupyter messaging and most of the common kernel management tasks. This leaves only code evaluation and completion testing left to the derived kernel.

Examples

Comparison to cl-jupyter

In comparison to cl-jupyter the included kernel common-lisp has the following features.

Installation

common-lisp-jupyter may be installed on a machine using a local installation, a repo2docker installation, or via a Docker image.

Local Installation

Requirements

Installing via Roswell

export PATH=$PATH:~/.roswell/bin
ros install common-lisp-jupyter

Installing via Quicklisp

(ql:quickload :common-lisp-jupyter)
(cl-jupyter:install)

Running common-lisp-jupyter

common-lisp-jupyter may be run from a local installation in console mode by the following.

jupyter console --kernel=common-lisp

Notebook mode is initiated by the following.

jupyter notebook

repo2docker Usage

common-lisp-jupyter may be run as a Docker image managed by repo2docker which will fetch the current code from GitHub and handle all the details of running the Jupyter Notebook server.

First you need to install repo2docker (sudo may be required)

pip install jupyter-repo2docker

Once repo2docker is installed then the following will build and start the server. Directions on accessing the server will be displayed once the image is built.

jupyter-repo2docker --user-id=1000 --user-name=jupyter https://github.com/yitzchak/common-lisp-jupyter

Docker Image

A prebuilt docker image is available via Docker Hub. This image maybe run run the following command.

docker run --network=host -it yitzchak/common-lisp-jupyter jupyter notebook --ip=127.0.0.1

A local Docker image of common-lisp-jupyter may be built after this repo has been cloned using the following command (sudo may be required). This image is based on the docker image archlinux/base.

docker build --tag=common-lisp-jupyter .

After the image is built the console may be run with

docker run -it common-lisp-jupyter jupyter console --kernel=common-lisp

Writing Jupyter Kernels

New Jupyter kernels can be created by defining a new sub-class of jupyter:kernel and by defining methods for the generic functions jupyter:evaluate-code and jupyter:code-is-complete. For reference, please see cl-jupyter.lisp for the Common Lisp kernel that is included in the package.

The derived class of jupyter:kernel should initialize the following slots. Most of these slots are used to reply to kernel_info messages. Documentation for each can be found in the declaration of jupyter:kernel.

The method jupyter:evaluate-code should evaluate all code included in the input argument and return a list of evaluation results. Each result should be wrapped in an appropriate sub-class of jupyter:result. For instance, to return a S-Expr result one would call jupyter:make-lisp-result. jupyter:evaluate-code will be called with the package declared in the kernel class as the current default. For example, the Common Lisp kernel evaluates code in the COMMON-LISP-USER package.

The Jupyter message is_complete_request is also supported via the code-is-complete method. The return result should be one of allowed status messages, i.e. "complete", "incomplete", "invalid", or "unknown".

User level installation of kernels can be accomplished by a call to jupyter:install-kernel. cl-jupyter.lisp has an example of this call made during the installation phase of Roswell.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 common-lisp-jupyter

Author

Tarn W. Burton

License

MIT

Description

A Common Lisp kernel for Jupyter along with a library for building Jupyter kernels.

Version

0.1

Dependencies
Source

common-lisp-jupyter.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 common-lisp-jupyter/res

Parent

common-lisp-jupyter (system)

Location

res/

Component

logo-64x64.png (file)


Next: , Previous: , Up: Modules   [Contents][Index]

3.2 common-lisp-jupyter/src

Parent

common-lisp-jupyter (system)

Location

src/

Components

Previous: , Up: Modules   [Contents][Index]

3.3 common-lisp-jupyter/src/widgets

Dependency

comm.lisp (file)

Parent

src (module)

Location

src/widgets/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Next: , Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 common-lisp-jupyter.asd

Location

common-lisp-jupyter.asd

Systems

common-lisp-jupyter (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 common-lisp-jupyter/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 common-lisp-jupyter/src/utils.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/utils.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 common-lisp-jupyter/src/config.lisp

Dependency

utils.lisp (file)

Parent

src (module)

Location

src/config.lisp

Internal Definitions

+kernel-protocol-version+ (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 common-lisp-jupyter/src/log.lisp

Dependency

config.lisp (file)

Parent

src (module)

Location

src/log.lisp

Exported Definitions

inform (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 common-lisp-jupyter/src/mac.lisp

Dependency

log.lisp (file)

Parent

src (module)

Location

src/mac.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 common-lisp-jupyter/src/channel.lisp

Dependency

mac.lisp (file)

Parent

src (module)

Location

src/channel.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 common-lisp-jupyter/src/heartbeat.lisp

Dependency

channel.lisp (file)

Parent

src (module)

Location

src/heartbeat.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 common-lisp-jupyter/src/message.lisp

Dependency

heartbeat.lisp (file)

Parent

src (module)

Location

src/message.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 common-lisp-jupyter/src/shell.lisp

Dependency

message.lisp (file)

Parent

src (module)

Location

src/shell.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 common-lisp-jupyter/src/stdin.lisp

Dependency

shell.lisp (file)

Parent

src (module)

Location

src/stdin.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 common-lisp-jupyter/src/iopub.lisp

Dependency

stdin.lisp (file)

Parent

src (module)

Location

src/iopub.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.13 common-lisp-jupyter/src/results.lisp

Dependency

iopub.lisp (file)

Parent

src (module)

Location

src/results.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.14 common-lisp-jupyter/src/comm.lisp

Dependency

results.lisp (file)

Parent

src (module)

Location

src/comm.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.15 common-lisp-jupyter/src/widgets/traits.lisp

Parent

widgets (module)

Location

src/widgets/traits.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.16 common-lisp-jupyter/src/widgets/widget.lisp

Dependency

traits.lisp (file)

Parent

widgets (module)

Location

src/widgets/widget.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.17 common-lisp-jupyter/src/widgets/trait-types.lisp

Dependency

widget.lisp (file)

Parent

widgets (module)

Location

src/widgets/trait-types.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.18 common-lisp-jupyter/src/widgets/shared-slots.lisp

Dependency

trait-types.lisp (file)

Parent

widgets (module)

Location

src/widgets/shared-slots.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.19 common-lisp-jupyter/src/widgets/dom-widget.lisp

Dependency

shared-slots.lisp (file)

Parent

widgets (module)

Location

src/widgets/dom-widget.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.20 common-lisp-jupyter/src/widgets/style.lisp

Dependency

dom-widget.lisp (file)

Parent

widgets (module)

Location

src/widgets/style.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.21 common-lisp-jupyter/src/widgets/checkbox.lisp

Dependency

style.lisp (file)

Parent

widgets (module)

Location

src/widgets/checkbox.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.22 common-lisp-jupyter/src/widgets/box.lisp

Dependency

checkbox.lisp (file)

Parent

widgets (module)

Location

src/widgets/box.lisp

Exported Definitions
Internal Definitions

validate-trait (method)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.23 common-lisp-jupyter/src/widgets/button.lisp

Dependency

box.lisp (file)

Parent

widgets (module)

Location

src/widgets/button.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.24 common-lisp-jupyter/src/widgets/color-picker.lisp

Dependency

button.lisp (file)

Parent

widgets (module)

Location

src/widgets/color-picker.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.25 common-lisp-jupyter/src/widgets/controller.lisp

Dependency

color-picker.lisp (file)

Parent

widgets (module)

Location

src/widgets/controller.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.26 common-lisp-jupyter/src/widgets/date-picker.lisp

Dependency

controller.lisp (file)

Parent

widgets (module)

Location

src/widgets/date-picker.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.27 common-lisp-jupyter/src/widgets/label.lisp

Dependency

date-picker.lisp (file)

Parent

widgets (module)

Location

src/widgets/label.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.28 common-lisp-jupyter/src/widgets/link.lisp

Dependency

label.lisp (file)

Parent

widgets (module)

Location

src/widgets/link.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.29 common-lisp-jupyter/src/widgets/media.lisp

Dependency

link.lisp (file)

Parent

widgets (module)

Location

src/widgets/media.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.30 common-lisp-jupyter/src/widgets/output.lisp

Dependency

media.lisp (file)

Parent

widgets (module)

Location

src/widgets/output.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.31 common-lisp-jupyter/src/widgets/progress.lisp

Dependency

output.lisp (file)

Parent

widgets (module)

Location

src/widgets/progress.lisp

Exported Definitions
Internal Definitions

base-progress (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.32 common-lisp-jupyter/src/widgets/radio-buttons.lisp

Dependency

progress.lisp (file)

Parent

widgets (module)

Location

src/widgets/radio-buttons.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.33 common-lisp-jupyter/src/widgets/select.lisp

Dependency

radio-buttons.lisp (file)

Parent

widgets (module)

Location

src/widgets/select.lisp

Exported Definitions
Internal Definitions

base-select (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.34 common-lisp-jupyter/src/widgets/slider.lisp

Dependency

select.lisp (file)

Parent

widgets (module)

Location

src/widgets/slider.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.35 common-lisp-jupyter/src/widgets/text.lisp

Dependency

slider.lisp (file)

Parent

widgets (module)

Location

src/widgets/text.lisp

Exported Definitions
Internal Definitions

base-text (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.36 common-lisp-jupyter/src/widgets/toggle-button.lisp

Dependency

text.lisp (file)

Parent

widgets (module)

Location

src/widgets/toggle-button.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.37 common-lisp-jupyter/src/widgets/valid.lisp

Dependency

toggle-button.lisp (file)

Parent

widgets (module)

Location

src/widgets/valid.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.38 common-lisp-jupyter/src/history.lisp

Dependency

widgets (module)

Parent

src (module)

Location

src/history.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.39 common-lisp-jupyter/src/kernel.lisp

Dependency

history.lisp (file)

Parent

src (module)

Location

src/kernel.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.40 common-lisp-jupyter/src/cl-kernel.lisp

Dependency

kernel.lisp (file)

Parent

src (module)

Location

src/cl-kernel.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.41 common-lisp-jupyter/src/ros-install.lisp

Dependency

cl-kernel.lisp (file)

Parent

src (module)

Location

src/ros-install.lisp


Previous: , Up: Lisp files   [Contents][Index]

4.1.42 common-lisp-jupyter/src/convert.lisp

Dependency

ros-install.lisp (file)

Parent

src (module)

Location

src/convert.lisp

Exported Definitions

to-notebook (function)

Internal Definitions

Previous: , Up: Files   [Contents][Index]

4.2 Other


Previous: , Up: Other files   [Contents][Index]

4.2.1 common-lisp-jupyter/res/logo-64x64.png

Parent

res (module)

Location

res/logo-64x64.png


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 common-lisp-jupyter

Source

packages.lisp (file)

Nickname

cl-jupyter

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 jupyter-widgets

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.3 jupyter-convert

Source

packages.lisp (file)

Use List
Exported Definitions

to-notebook (function)

Internal Definitions

Previous: , Up: Packages   [Contents][Index]

5.4 jupyter

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *page-output*

Output stream sent to Jupyter pager. Available during calls to evaluate-code.

Package

jupyter

Source

kernel.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: handling-errors &body BODY

Macro for catching any conditions including quit-conditions during code evaluation.

Package

jupyter

Source

kernel.lisp (file)

Macro: with-output O &body BODY

Evaluate body with all output sent to the output widget.

Package

jupyter-widgets

Source

output.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Functions

Function: clear &optional WAIT

Send clear output message to frontend.

Package

jupyter

Source

kernel.lisp (file)

Function: display WIDGET

Display a widget in the notebook.

Package

jupyter-widgets

Source

widget.lisp (file)

Function: enqueue-input KERNEL CODE

Add code to input queue.

Package

jupyter

Source

kernel.lisp (file)

Function: file PATH &optional DISPLAY-DATA

Create a result based on a file path. The mime type with automatically be determined from the file extension.

Package

jupyter

Source

results.lisp (file)

Function: get-comm ID
Package

jupyter

Source

comm.lisp (file)

Function: gif-file PATH &optional DISPLAY-DATA

Create a GIF image result based on a file path.

Package

jupyter

Source

results.lisp (file)

Function: html VALUE &optional DISPLAY-DATA

Create a HTML result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: inform LEVEL SRC FORMAT-CONTROL &rest FORMAT-ARGUMENTS
Package

jupyter

Source

log.lisp (file)

Function: inline-result VALUE MIME-TYPE &optional DISPLAY-DATA

Create a result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: install &key BIN-PATH EV-FLAG PREAMBLE USE-IMPLEMENTATION SYSTEM

Install Common Lisp kernel based on the current implementation

Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: install-image &key USE-IMPLEMENTATION SYSTEM

Install Common Lisp kernel based on image of current implementation

Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: install-kernel &key ARGV CLASS DISPLAY-NAME KERNEL-NAME LANGUAGE RESOURCES SYSTEM

Install a kernel spec file given a kernel name and a language name.

Package

jupyter

Source

utils.lisp (file)

Function: install-roswell &key IMPLEMENTATION

Install Common Lisp kernel using Roswell

Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: jpeg VALUE &optional DISPLAY-DATA

Create a JPEG image result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: jpeg-file PATH &optional DISPLAY-DATA

Create a JPEG image result based on a file path.

Package

jupyter

Source

results.lisp (file)

Function: json-getf OBJECT INDICATOR &optional DEFAULT

Safe accessor for the internal JSON format that behaves like getf

Package

jupyter

Source

utils.lisp (file)

Function: latex VALUE &optional DISPLAY-DATA

Create a LaTeX result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: make-error-result ENAME EVALUE &key QUIT TRACEBACK

Make a result based on an error. The quit the parameter indicates that the kernel should exit. The handle argument is used by the convenience functions to instantly process the result.

Package

jupyter

Source

results.lisp (file)

Function: make-file-result PATH &key MIME-TYPE DISPLAY-DATA HANDLE

Make a result based on a file. The handle argument is used by the convenience functions to instantly process the result.

Package

jupyter

Source

results.lisp (file)

Function: make-inline-result VALUE &key MIME-TYPE DISPLAY-DATA HANDLE

Make a result based on an inline value. The handle argument is used by the convenience functions to instantly process the result.

Package

jupyter

Source

results.lisp (file)

Function: make-lisp-result VALUE &key DISPLAY-DATA

Make a lisp result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: make-widget CLASS &rest REST &key &allow-other-keys

Create a Jupyter widget and inform the frontend to create a synchronized model.

Package

jupyter-widgets

Source

widget.lisp (file)

Function: markdown VALUE &optional DISPLAY-DATA

Create a Markdown result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: pdf-file PATH &optional DISPLAY-DATA

Create a PDF result based on a file path.

Package

jupyter

Source

results.lisp (file)

Function: png VALUE &optional DISPLAY-DATA

Create a PNG image result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: png-file PATH &optional DISPLAY-DATA

Create a PNG image result based on a file path.

Package

jupyter

Source

results.lisp (file)

Function: ps-file PATH &optional DISPLAY-DATA

Create a PostScript result based on a file path.

Package

jupyter

Source

results.lisp (file)

Function: quit-eval-error-p RESULT

Predicate to determine if result is an quit result.

Package

jupyter

Source

results.lisp (file)

Function: run-kernel KERNEL-CLASS CONNECTION-FILE

Run a kernel based on a kernel class and a connection file.

Package

jupyter

Source

kernel.lisp (file)

Function: send-comm-close COMM &optional DATA METADATA BUFFERS
Package

jupyter

Source

comm.lisp (file)

Function: send-comm-message COMM &optional DATA METADATA BUFFERS
Package

jupyter

Source

comm.lisp (file)

Function: send-comm-open COMM &optional DATA METADATA BUFFERS
Package

jupyter

Source

comm.lisp (file)

Function: send-result RESULT

Send a result either as display data or an execute result.

Package

jupyter

Source

kernel.lisp (file)

Function: svg VALUE &optional DISPLAY-DATA

Create a SVG result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: svg-file PATH &optional DISPLAY-DATA

Create a SVG result based on a file path.

Package

jupyter

Source

results.lisp (file)

Function: text VALUE &optional DISPLAY-DATA

Create a plain text result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: to-notebook SRC DEST

Convert Lisp source to Jupyter notebook

Package

jupyter-convert

Source

convert.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Generic functions

Generic Function: code-is-complete KERNEL CODE

Check code for completeness. Kernel implementations should
result one of the permitted values of complete, incomplete, unknown or invalid.

Package

jupyter

Source

kernel.lisp (file)

Methods
Method: code-is-complete (K kernel) CODE
Source

cl-kernel.lisp (file)

Method: code-is-complete KERNEL CODE
Generic Function: comm-id OBJECT
Package

jupyter

Methods
Method: comm-id (COMM comm)

automatically generated reader method

Source

comm.lisp (file)

Generic Function: complete-code KERNEL CODE CURSOR-POS

Complete code at cursor-pos. Successful completion should
return three values, first a list of strings, then the cursor start position and finally the cursor end position.

Package

jupyter

Source

kernel.lisp (file)

Methods
Method: complete-code (K kernel) CODE CURSOR-POS
Source

cl-kernel.lisp (file)

Method: complete-code KERNEL CODE CURSOR-POS
Generic Function: create-comm TARGET-NAME ID DATA METADATA BUFFERS
Package

jupyter

Source

comm.lisp (file)

Methods
Method: create-comm (TARGET-NAME (eql jupyter.widget)) ID DATA METADATA BUFFERS
Source

widget.lisp (file)

Method: create-comm TARGET-NAME ID DATA METADATA BUFFERS
Generic Function: evaluate-code KERNEL CODE

Evaluate code along with paged output. Kernel implementations
must return a list of evaluated results. Each result should be wrapped with an appropriate ‘result‘ class instance. Sending the results to the client will be handled by the calling method.

Package

jupyter

Source

kernel.lisp (file)

Methods
Method: evaluate-code (K kernel) CODE
Source

cl-kernel.lisp (file)

Method: evaluate-code KERNEL CODE
Generic Function: inspect-code KERNEL CODE CURSOR-POS DETAIL-LEVEL

Inspect code at cursor-pos with detail-level. Successful inspection should return a single wrapped result.

Package

jupyter

Source

kernel.lisp (file)

Methods
Method: inspect-code (K kernel) CODE CURSOR-POS DETAIL-LEVEL
Source

cl-kernel.lisp (file)

Method: inspect-code KERNEL CODE CURSOR-POS DETAIL-LEVEL
Generic Function: kernel-prompt-prefix OBJECT
Package

jupyter

Methods
Method: kernel-prompt-prefix (KERNEL kernel)

String prefix using in *standard-output* to indicate the start of prompt.

Source

kernel.lisp (file)

Generic Function: kernel-prompt-suffix OBJECT
Package

jupyter

Methods
Method: kernel-prompt-suffix (KERNEL kernel)

String suffix using in *standard-output* to indicate the end of prompt.

Source

kernel.lisp (file)

Generic Function: on-button-click W

This method is called when the button receives a click message.

Package

jupyter-widgets

Source

button.lisp (file)

Methods
Method: on-button-click W
Generic Function: on-comm-close COMM DATA METADATA BUFFERS
Package

jupyter

Source

comm.lisp (file)

Methods
Method: on-comm-close COMM DATA METADATA BUFFERS
Generic Function: on-comm-message COMM DATA METADATA BUFFERS
Package

jupyter

Source

comm.lisp (file)

Methods
Method: on-comm-message (W button) DATA METADATA BUFFERS
Source

button.lisp (file)

Method: on-comm-message (W widget) DATA METADATA BUFFERS
Source

widget.lisp (file)

Method: on-comm-message COMM DATA METADATA BUFFERS
Generic Function: on-comm-open COMM DATA METADATA BUFFERS
Package

jupyter

Source

comm.lisp (file)

Methods
Method: on-comm-open COMM DATA METADATA BUFFERS
Generic Function: on-trait-change OBJECT TYPE NAME OLD-VALUE NEW-VALUE
Package

jupyter-widgets

Source

traits.lisp (file)

Methods
Method: on-trait-change (W widget) TYPE NAME OLD-VALUE NEW-VALUE after
Source

widget.lisp (file)

Method: on-trait-change OBJECT TYPE NAME OLD-VALUE NEW-VALUE
Generic Function: render RESULT

Render evaluation result as a mime bundle for execute_result or display_data.

Package

jupyter

Source

results.lisp (file)

Methods
Method: render (RES inspect-result)
Source

cl-kernel.lisp (file)

Method: render (W widget)
Source

widget.lisp (file)

Method: render (RES file-result)
Method: render (RES inline-result)
Method: render (RES sexpr-result)
Method: render RES
Generic Function: widget-%dom-classes OBJECT
Generic Function: (setf widget-%dom-classes) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-%dom-classes (DOM-WIDGET dom-widget)
Method: (setf widget-%dom-classes) NEW-VALUE (DOM-WIDGET dom-widget)

CSS classes applied to widget DOM element

Source

dom-widget.lisp (file)

Generic Function: widget-%module-module OBJECT
Package

jupyter-widgets

Methods
Method: widget-%module-module (WIDGET widget)

The namespace for the model.

Source

widget.lisp (file)

Generic Function: widget-%module-module-version OBJECT
Package

jupyter-widgets

Methods
Method: widget-%module-module-version (WIDGET widget)

A semver requirement for namespace version containing the model.

Source

widget.lisp (file)

Generic Function: widget-%module-name OBJECT
Package

jupyter-widgets

Methods
Method: widget-%module-name (WIDGET widget)

Name of the model.

Source

widget.lisp (file)

Generic Function: widget-%options-labels OBJECT
Generic Function: (setf widget-%options-labels) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-%options-labels (%OPTIONS-LABELS-SLOT %options-labels-slot)
Method: (setf widget-%options-labels) NEW-VALUE (%OPTIONS-LABELS-SLOT %options-labels-slot)

The labels for the options.

Source

shared-slots.lisp (file)

Generic Function: widget-%playing OBJECT
Generic Function: (setf widget-%playing) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-%playing (PLAY play)
Method: (setf widget-%playing) NEW-VALUE (PLAY play)

Whether the control is currently playing.

Source

media.lisp (file)

Generic Function: widget-%repeat OBJECT
Generic Function: (setf widget-%repeat) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-%repeat (PLAY play)
Method: (setf widget-%repeat) NEW-VALUE (PLAY play)

Whether the control will repeat in a continous loop.

Source

media.lisp (file)

Generic Function: widget-%titles OBJECT
Generic Function: (setf widget-%titles) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-%titles (ACCORDION accordion)
Method: (setf widget-%titles) NEW-VALUE (ACCORDION accordion)

Titles of the pages.

Source

box.lisp (file)

Generic Function: widget-%view-module OBJECT
Package

jupyter-widgets

Methods
Method: widget-%view-module (WIDGET widget)

The namespace for the view.

Source

widget.lisp (file)

Generic Function: widget-%view-module-version OBJECT
Package

jupyter-widgets

Methods
Method: widget-%view-module-version (WIDGET widget)

A semver requirement for namespace version containing the view.

Source

widget.lisp (file)

Generic Function: widget-%view-name OBJECT
Package

jupyter-widgets

Methods
Method: widget-%view-name (WIDGET widget)

Name of the view.

Source

widget.lisp (file)

Generic Function: widget-align-content OBJECT
Generic Function: (setf widget-align-content) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-align-content (LAYOUT layout)
Method: (setf widget-align-content) NEW-VALUE (LAYOUT layout)

The align-content CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-align-items OBJECT
Generic Function: (setf widget-align-items) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-align-items (LAYOUT layout)
Method: (setf widget-align-items) NEW-VALUE (LAYOUT layout)

The align-items CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-align-self OBJECT
Generic Function: (setf widget-align-self) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-align-self (LAYOUT layout)
Method: (setf widget-align-self) NEW-VALUE (LAYOUT layout)

The align-self CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-autoplay OBJECT
Generic Function: (setf widget-autoplay) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-autoplay (AUDIO audio)
Method: (setf widget-autoplay) NEW-VALUE (AUDIO audio)

When true, the audio starts when it’s displayed.

Source

media.lisp (file)

Generic Function: widget-axes OBJECT
Generic Function: (setf widget-axes) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-axes (CONTROLLER controller)
Method: (setf widget-axes) NEW-VALUE (CONTROLLER controller)

The axes on the gamepad.

Source

controller.lisp (file)

Generic Function: widget-bar-color OBJECT
Generic Function: (setf widget-bar-color) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-bar-color (PROGRESS-STYLE progress-style)
Method: (setf widget-bar-color) NEW-VALUE (PROGRESS-STYLE progress-style)

Color of the slider handle.

Source

style.lisp (file)

Generic Function: widget-bar-style OBJECT
Generic Function: (setf widget-bar-style) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-bar-style (BASE-PROGRESS base-progress)
Method: (setf widget-bar-style) NEW-VALUE (BASE-PROGRESS base-progress)

Use a predefined styling for the progess bar.

Source

progress.lisp (file)

Generic Function: widget-base OBJECT
Generic Function: (setf widget-base) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-base (FLOAT-LOG-SLIDER float-log-slider)
Method: (setf widget-base) NEW-VALUE (FLOAT-LOG-SLIDER float-log-slider)

Base for the logarithm

Source

slider.lisp (file)

Generic Function: widget-border OBJECT
Generic Function: (setf widget-border) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-border (LAYOUT layout)
Method: (setf widget-border) NEW-VALUE (LAYOUT layout)

The border CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-bottom OBJECT
Generic Function: (setf widget-bottom) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-bottom (LAYOUT layout)
Method: (setf widget-bottom) NEW-VALUE (LAYOUT layout)

The bottom CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-box-style OBJECT
Generic Function: (setf widget-box-style) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-box-style (BOX box)
Method: (setf widget-box-style) NEW-VALUE (BOX box)

Use a predefined styling for the box.

Source

box.lisp (file)

Generic Function: widget-button-color OBJECT
Generic Function: (setf widget-button-color) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-button-color (BUTTON-STYLE button-style)
Method: (setf widget-button-color) NEW-VALUE (BUTTON-STYLE button-style)

Color of the button

Source

style.lisp (file)

Generic Function: widget-button-style OBJECT
Generic Function: (setf widget-button-style) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-button-style (BUTTON-STYLE-SLOT button-style-slot)
Method: (setf widget-button-style) NEW-VALUE (BUTTON-STYLE-SLOT button-style-slot)

Use a predefined styling for the button.

Source

shared-slots.lisp (file)

Generic Function: widget-button-width OBJECT
Generic Function: (setf widget-button-width) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-button-width (TOGGLE-BUTTONS-STYLE toggle-buttons-style)
Method: (setf widget-button-width) NEW-VALUE (TOGGLE-BUTTONS-STYLE toggle-buttons-style)

The width of each button.

Source

style.lisp (file)

Generic Function: widget-buttons OBJECT
Generic Function: (setf widget-buttons) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-buttons (CONTROLLER controller)
Method: (setf widget-buttons) NEW-VALUE (CONTROLLER controller)

The buttons on the gamepad.

Source

controller.lisp (file)

Generic Function: widget-children OBJECT
Generic Function: (setf widget-children) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-children (BOX box)
Method: (setf widget-children) NEW-VALUE (BOX box)

List of widget children.

Source

box.lisp (file)

Generic Function: widget-concise OBJECT
Generic Function: (setf widget-concise) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-concise (COLOR-PICKER color-picker)
Method: (setf widget-concise) NEW-VALUE (COLOR-PICKER color-picker)

Display short version with just a color selector.

Source

color-picker.lisp (file)

Generic Function: widget-connected OBJECT
Generic Function: (setf widget-connected) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-connected (CONTROLLER controller)
Method: (setf widget-connected) NEW-VALUE (CONTROLLER controller)

Whether the gamepad is connected.

Source

controller.lisp (file)

Generic Function: widget-continuous-update OBJECT
Generic Function: (setf widget-continuous-update) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-continuous-update (CONTINUOUS-UPDATE-SLOT continuous-update-slot)
Method: (setf widget-continuous-update) NEW-VALUE (CONTINUOUS-UPDATE-SLOT continuous-update-slot)

Update the value of the widget as the user is holding the slider.

Source

shared-slots.lisp (file)

Generic Function: widget-controls OBJECT
Generic Function: (setf widget-controls) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-controls (AUDIO audio)
Method: (setf widget-controls) NEW-VALUE (AUDIO audio)

Specifies that media controls should be displayed (such as a play/pause button etc)

Source

media.lisp (file)

Generic Function: widget-description OBJECT
Generic Function: (setf widget-description) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-description (BUTTON button)
Method: (setf widget-description) NEW-VALUE (BUTTON button)

Button label.

Source

button.lisp (file)

Method: widget-description (DESCRIPTION-WIDGET description-widget)
Method: (setf widget-description) NEW-VALUE (DESCRIPTION-WIDGET description-widget)

Description of the control.

Source

style.lisp (file)

Generic Function: widget-description-tooltip OBJECT
Generic Function: (setf widget-description-tooltip) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-description-tooltip (DESCRIPTION-WIDGET description-widget)
Method: (setf widget-description-tooltip) NEW-VALUE (DESCRIPTION-WIDGET description-widget)

Tooltip for the description (defaults to description).

Source

style.lisp (file)

Generic Function: widget-description-width OBJECT
Generic Function: (setf widget-description-width) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-description-width (TOGGLE-BUTTONS-STYLE toggle-buttons-style)
Method: (setf widget-description-width) NEW-VALUE (TOGGLE-BUTTONS-STYLE toggle-buttons-style)

Width of the description to the side of the control.

Source

style.lisp (file)

Method: widget-description-width (DESCRIPTION-STYLE description-style)
Method: (setf widget-description-width) NEW-VALUE (DESCRIPTION-STYLE description-style)

Width of the description to the side of the control.

Source

style.lisp (file)

Generic Function: widget-disabled OBJECT
Generic Function: (setf widget-disabled) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-disabled (DISABLED-SLOT disabled-slot)
Method: (setf widget-disabled) NEW-VALUE (DISABLED-SLOT disabled-slot)

Enable or disable user changes.

Source

shared-slots.lisp (file)

Generic Function: widget-display OBJECT
Generic Function: (setf widget-display) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-display (LAYOUT layout)
Method: (setf widget-display) NEW-VALUE (LAYOUT layout)

The display CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-flex OBJECT
Generic Function: (setf widget-flex) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-flex (LAYOUT layout)
Method: (setf widget-flex) NEW-VALUE (LAYOUT layout)

The flex CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-flex-flow OBJECT
Generic Function: (setf widget-flex-flow) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-flex-flow (LAYOUT layout)
Method: (setf widget-flex-flow) NEW-VALUE (LAYOUT layout)

The flex-flow CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-font-weight OBJECT
Generic Function: (setf widget-font-weight) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-font-weight (TOGGLE-BUTTONS-STYLE toggle-buttons-style)
Method: (setf widget-font-weight) NEW-VALUE (TOGGLE-BUTTONS-STYLE toggle-buttons-style)

Text font weight of each button.

Source

style.lisp (file)

Method: widget-font-weight (BUTTON-STYLE button-style)
Method: (setf widget-font-weight) NEW-VALUE (BUTTON-STYLE button-style)

Button text font weight.

Source

style.lisp (file)

Generic Function: widget-format OBJECT
Generic Function: (setf widget-format) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-format (FORMAT-SLOT format-slot)
Method: (setf widget-format) NEW-VALUE (FORMAT-SLOT format-slot)

The format of the media.

Source

shared-slots.lisp (file)

Generic Function: widget-grid-area OBJECT
Generic Function: (setf widget-grid-area) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-grid-area (LAYOUT layout)
Method: (setf widget-grid-area) NEW-VALUE (LAYOUT layout)

The grid-area CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-grid-auto-columns OBJECT
Generic Function: (setf widget-grid-auto-columns) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-grid-auto-columns (LAYOUT layout)
Method: (setf widget-grid-auto-columns) NEW-VALUE (LAYOUT layout)

The grid-auto-columns CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-grid-auto-flow OBJECT
Generic Function: (setf widget-grid-auto-flow) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-grid-auto-flow (LAYOUT layout)
Method: (setf widget-grid-auto-flow) NEW-VALUE (LAYOUT layout)

The grid-auto-flow CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-grid-column OBJECT
Generic Function: (setf widget-grid-column) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-grid-column (LAYOUT layout)
Method: (setf widget-grid-column) NEW-VALUE (LAYOUT layout)

The grid-column CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-grid-gap OBJECT
Generic Function: (setf widget-grid-gap) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-grid-gap (LAYOUT layout)
Method: (setf widget-grid-gap) NEW-VALUE (LAYOUT layout)

The grid-gap CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-grid-template-areas OBJECT
Generic Function: (setf widget-grid-template-areas) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-grid-template-areas (LAYOUT layout)
Method: (setf widget-grid-template-areas) NEW-VALUE (LAYOUT layout)

The grid-template-areas CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-grid-template-columns OBJECT
Generic Function: (setf widget-grid-template-columns) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-grid-template-columns (LAYOUT layout)
Method: (setf widget-grid-template-columns) NEW-VALUE (LAYOUT layout)

The grid-template-columns CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-grid-template-rows OBJECT
Generic Function: (setf widget-grid-template-rows) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-grid-template-rows (LAYOUT layout)
Method: (setf widget-grid-template-rows) NEW-VALUE (LAYOUT layout)

The grid-template-rows CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-handle-color OBJECT
Generic Function: (setf widget-handle-color) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-handle-color (SLIDER-STYLE slider-style)
Method: (setf widget-handle-color) NEW-VALUE (SLIDER-STYLE slider-style)

Color of the slider handle.

Source

style.lisp (file)

Generic Function: widget-height OBJECT
Generic Function: (setf widget-height) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-height (LAYOUT layout)
Method: (setf widget-height) NEW-VALUE (LAYOUT layout)

The height CSS attribute.

Source

dom-widget.lisp (file)

Method: widget-height (HEIGHT-SLOT height-slot)
Method: (setf widget-height) NEW-VALUE (HEIGHT-SLOT height-slot)

Height of the media in pixels.

Source

shared-slots.lisp (file)

Generic Function: widget-icon OBJECT
Generic Function: (setf widget-icon) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-icon (ICON-SLOT icon-slot)
Method: (setf widget-icon) NEW-VALUE (ICON-SLOT icon-slot)

Font-awesome icon name, without the ’fa-’ prefix.

Source

shared-slots.lisp (file)

Generic Function: widget-icons OBJECT
Generic Function: (setf widget-icons) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-icons (TOGGLE-BUTTONS toggle-buttons)
Method: (setf widget-icons) NEW-VALUE (TOGGLE-BUTTONS toggle-buttons)

Icons names for each button (FontAwesome names without the fa- prefix).

Source

toggle-button.lisp (file)

Generic Function: widget-indent OBJECT
Generic Function: (setf widget-indent) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-indent (CHECKBOX checkbox)
Method: (setf widget-indent) NEW-VALUE (CHECKBOX checkbox)

Indent the control to align with other controls with a description.

Source

checkbox.lisp (file)

Generic Function: widget-index OBJECT
Generic Function: (setf widget-index) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-index (SELECTION-RANGE-SLIDER selection-range-slider)
Method: (setf widget-index) NEW-VALUE (SELECTION-RANGE-SLIDER selection-range-slider)

Min and max selected indices

Source

slider.lisp (file)

Method: widget-index (SELECT-MULTIPLE select-multiple)
Method: (setf widget-index) NEW-VALUE (SELECT-MULTIPLE select-multiple)

Selected indicies

Source

select.lisp (file)

Method: widget-index (CONTROLLER controller)
Method: (setf widget-index) NEW-VALUE (CONTROLLER controller)

The id number of the controller.

Source

controller.lisp (file)

Method: widget-index (INDEX-SLOT index-slot)
Method: (setf widget-index) NEW-VALUE (INDEX-SLOT index-slot)

Selected index

Source

shared-slots.lisp (file)

Generic Function: widget-interval OBJECT
Generic Function: (setf widget-interval) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-interval (PLAY play)
Method: (setf widget-interval) NEW-VALUE (PLAY play)

The maximum value for the play control.

Source

media.lisp (file)

Generic Function: widget-justify-content OBJECT
Generic Function: (setf widget-justify-content) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-justify-content (LAYOUT layout)
Method: (setf widget-justify-content) NEW-VALUE (LAYOUT layout)

The justify-content CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-layout OBJECT
Generic Function: (setf widget-layout) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-layout (DOM-WIDGET dom-widget)
Method: (setf widget-layout) NEW-VALUE (DOM-WIDGET dom-widget)

Reference to layout widget.

Source

dom-widget.lisp (file)

Generic Function: widget-left OBJECT
Generic Function: (setf widget-left) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-left (LAYOUT layout)
Method: (setf widget-left) NEW-VALUE (LAYOUT layout)

The left CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-loop OBJECT
Generic Function: (setf widget-loop) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-loop (AUDIO audio)
Method: (setf widget-loop) NEW-VALUE (AUDIO audio)

When true, the audio will start from the beginning after finishing

Source

media.lisp (file)

Generic Function: widget-mapping OBJECT
Generic Function: (setf widget-mapping) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-mapping (CONTROLLER controller)
Method: (setf widget-mapping) NEW-VALUE (CONTROLLER controller)

The name of the control mapping.

Source

controller.lisp (file)

Generic Function: widget-margin OBJECT
Generic Function: (setf widget-margin) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-margin (LAYOUT layout)
Method: (setf widget-margin) NEW-VALUE (LAYOUT layout)

The margin CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-max OBJECT
Generic Function: (setf widget-max) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-max (INT-MIN-MAX-SLOTS int-min-max-slots)
Method: (setf widget-max) NEW-VALUE (INT-MIN-MAX-SLOTS int-min-max-slots)

Max value

Source

shared-slots.lisp (file)

Method: widget-max (FLOAT-MIN-MAX-SLOTS float-min-max-slots)
Method: (setf widget-max) NEW-VALUE (FLOAT-MIN-MAX-SLOTS float-min-max-slots)

Max value

Source

shared-slots.lisp (file)

Generic Function: widget-max-height OBJECT
Generic Function: (setf widget-max-height) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-max-height (LAYOUT layout)
Method: (setf widget-max-height) NEW-VALUE (LAYOUT layout)

The max-height CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-max-width OBJECT
Generic Function: (setf widget-max-width) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-max-width (LAYOUT layout)
Method: (setf widget-max-width) NEW-VALUE (LAYOUT layout)

The max-width CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-min OBJECT
Generic Function: (setf widget-min) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-min (INT-MIN-MAX-SLOTS int-min-max-slots)
Method: (setf widget-min) NEW-VALUE (INT-MIN-MAX-SLOTS int-min-max-slots)

Min value

Source

shared-slots.lisp (file)

Method: widget-min (FLOAT-MIN-MAX-SLOTS float-min-max-slots)
Method: (setf widget-min) NEW-VALUE (FLOAT-MIN-MAX-SLOTS float-min-max-slots)

Min value

Source

shared-slots.lisp (file)

Generic Function: widget-min-height OBJECT
Generic Function: (setf widget-min-height) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-min-height (LAYOUT layout)
Method: (setf widget-min-height) NEW-VALUE (LAYOUT layout)

The min-height CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-min-width OBJECT
Generic Function: (setf widget-min-width) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-min-width (LAYOUT layout)
Method: (setf widget-min-width) NEW-VALUE (LAYOUT layout)

The min-width CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-msg-id OBJECT
Generic Function: (setf widget-msg-id) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-msg-id (OUTPUT output)
Method: (setf widget-msg-id) NEW-VALUE (OUTPUT output)

Parent message id of messages to capture

Source

output.lisp (file)

Generic Function: widget-name OBJECT
Generic Function: (setf widget-name) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-name (CONTROLLER controller)
Method: (setf widget-name) NEW-VALUE (CONTROLLER controller)

The name of the controller.

Source

controller.lisp (file)

Generic Function: widget-order OBJECT
Generic Function: (setf widget-order) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-order (LAYOUT layout)
Method: (setf widget-order) NEW-VALUE (LAYOUT layout)

The order CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-orientation OBJECT
Generic Function: (setf widget-orientation) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-orientation (ORIENTATION-SLOT orientation-slot)
Method: (setf widget-orientation) NEW-VALUE (ORIENTATION-SLOT orientation-slot)

Vertical or horizontal.

Source

shared-slots.lisp (file)

Generic Function: widget-outputs OBJECT
Generic Function: (setf widget-outputs) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-outputs (OUTPUT output)
Method: (setf widget-outputs) NEW-VALUE (OUTPUT output)

The output messages synced from the frontend.

Source

output.lisp (file)

Generic Function: widget-overflow OBJECT
Generic Function: (setf widget-overflow) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-overflow (LAYOUT layout)
Method: (setf widget-overflow) NEW-VALUE (LAYOUT layout)

The overflow CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-overflow-x OBJECT
Generic Function: (setf widget-overflow-x) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-overflow-x (LAYOUT layout)
Method: (setf widget-overflow-x) NEW-VALUE (LAYOUT layout)

The overflow-x CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-overflow-y OBJECT
Generic Function: (setf widget-overflow-y) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-overflow-y (LAYOUT layout)
Method: (setf widget-overflow-y) NEW-VALUE (LAYOUT layout)

The overflow-y CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-padding OBJECT
Generic Function: (setf widget-padding) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-padding (LAYOUT layout)
Method: (setf widget-padding) NEW-VALUE (LAYOUT layout)

The padding CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-placeholder OBJECT
Generic Function: (setf widget-placeholder) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-placeholder (PLACEHOLDER-SLOT placeholder-slot)
Method: (setf widget-placeholder) NEW-VALUE (PLACEHOLDER-SLOT placeholder-slot)

Placeholder text to display when nothing has been typed.

Source

shared-slots.lisp (file)

Generic Function: widget-pressed OBJECT
Generic Function: (setf widget-pressed) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-pressed (CONTROLLER-BUTTON controller-button)
Method: (setf widget-pressed) NEW-VALUE (CONTROLLER-BUTTON controller-button)

Whether the button is pressed.

Source

controller.lisp (file)

Generic Function: widget-readout OBJECT
Generic Function: (setf widget-readout) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-readout (VALID valid)
Method: (setf widget-readout) NEW-VALUE (VALID valid)

Message displayed when the value is False

Source

valid.lisp (file)

Method: widget-readout (BASE-SLIDER base-slider)
Method: (setf widget-readout) NEW-VALUE (BASE-SLIDER base-slider)

Display the current value of the slider next to it.

Source

slider.lisp (file)

Generic Function: widget-readout-format OBJECT
Generic Function: (setf widget-readout-format) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-readout-format (NUMBER-SLIDER number-slider)
Method: (setf widget-readout-format) NEW-VALUE (NUMBER-SLIDER number-slider)

Format for the readout

Source

slider.lisp (file)

Method: widget-readout-format (BASE-SLIDER base-slider)
Method: (setf widget-readout-format) NEW-VALUE (BASE-SLIDER base-slider)

Format for the readout

Source

slider.lisp (file)

Generic Function: widget-right OBJECT
Generic Function: (setf widget-right) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-right (LAYOUT layout)
Method: (setf widget-right) NEW-VALUE (LAYOUT layout)

The right CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-rows OBJECT
Generic Function: (setf widget-rows) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-rows (TEXT-AREA text-area)
Method: (setf widget-rows) NEW-VALUE (TEXT-AREA text-area)

The number of rows to display.

Source

text.lisp (file)

Method: widget-rows (BASE-SELECT base-select)
Method: (setf widget-rows) NEW-VALUE (BASE-SELECT base-select)

The number of rows to display.

Source

select.lisp (file)

Generic Function: widget-selected-index OBJECT
Generic Function: (setf widget-selected-index) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-selected-index (ACCORDION accordion)
Method: (setf widget-selected-index) NEW-VALUE (ACCORDION accordion)

The index of the selected page. This is either an integer selecting a particular sub-widget, or nil to have no widgets selected.

Source

box.lisp (file)

Generic Function: widget-show-repeat OBJECT
Generic Function: (setf widget-show-repeat) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-show-repeat (PLAY play)
Method: (setf widget-show-repeat) NEW-VALUE (PLAY play)

Show the repeat toggle button in the widget.

Source

media.lisp (file)

Generic Function: widget-source OBJECT
Generic Function: (setf widget-source) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-source (LINK link)

automatically generated reader method

Source

link.lisp (file)

Method: (setf widget-source) NEW-VALUE (LINK link)

automatically generated writer method

Source

link.lisp (file)

Generic Function: widget-step OBJECT
Generic Function: (setf widget-step) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-step (INT-STEP-SLOT int-step-slot)
Method: (setf widget-step) NEW-VALUE (INT-STEP-SLOT int-step-slot)

Minimum step to increment the value

Source

shared-slots.lisp (file)

Method: widget-step (FLOAT-STEP-SLOT float-step-slot)
Method: (setf widget-step) NEW-VALUE (FLOAT-STEP-SLOT float-step-slot)

Minimum step to increment the value

Source

shared-slots.lisp (file)

Generic Function: widget-style OBJECT
Generic Function: (setf widget-style) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-style (STYLED-WIDGET styled-widget)
Method: (setf widget-style) NEW-VALUE (STYLED-WIDGET styled-widget)

Reference to style widget.

Source

style.lisp (file)

Generic Function: widget-target OBJECT
Generic Function: (setf widget-target) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-target (LINK link)

automatically generated reader method

Source

link.lisp (file)

Method: (setf widget-target) NEW-VALUE (LINK link)

automatically generated writer method

Source

link.lisp (file)

Generic Function: widget-timestamp OBJECT
Generic Function: (setf widget-timestamp) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-timestamp (CONTROLLER controller)
Method: (setf widget-timestamp) NEW-VALUE (CONTROLLER controller)

The last time the data from this gamepad was updated.

Source

controller.lisp (file)

Generic Function: widget-tooltip OBJECT
Generic Function: (setf widget-tooltip) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-tooltip (TOOLTIP-SLOT tooltip-slot)
Method: (setf widget-tooltip) NEW-VALUE (TOOLTIP-SLOT tooltip-slot)

Tooltip caption.

Source

shared-slots.lisp (file)

Generic Function: widget-tooltips OBJECT
Generic Function: (setf widget-tooltips) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-tooltips (TOGGLE-BUTTONS toggle-buttons)
Method: (setf widget-tooltips) NEW-VALUE (TOGGLE-BUTTONS toggle-buttons)

Tooltips for each button.

Source

toggle-button.lisp (file)

Generic Function: widget-top OBJECT
Generic Function: (setf widget-top) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-top (LAYOUT layout)
Method: (setf widget-top) NEW-VALUE (LAYOUT layout)

The top CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-value OBJECT
Generic Function: (setf widget-value) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-value (INT-RANGE-SLIDER int-range-slider)
Method: (setf widget-value) NEW-VALUE (INT-RANGE-SLIDER int-range-slider)

Int range value

Source

slider.lisp (file)

Method: widget-value (FLOAT-RANGE-SLIDER float-range-slider)
Method: (setf widget-value) NEW-VALUE (FLOAT-RANGE-SLIDER float-range-slider)

Float range

Source

slider.lisp (file)

Method: widget-value (DATE-PICKER date-picker)
Method: (setf widget-value) NEW-VALUE (DATE-PICKER date-picker)

The date value.

Source

date-picker.lisp (file)

Method: widget-value (COLOR-PICKER color-picker)
Method: (setf widget-value) NEW-VALUE (COLOR-PICKER color-picker)

The color value.

Source

color-picker.lisp (file)

Method: widget-value (STRING-VALUE-SLOT string-value-slot)
Method: (setf widget-value) NEW-VALUE (STRING-VALUE-SLOT string-value-slot)

String value

Source

shared-slots.lisp (file)

Method: widget-value (INT-VALUE-SLOT int-value-slot)
Method: (setf widget-value) NEW-VALUE (INT-VALUE-SLOT int-value-slot)

Int value

Source

shared-slots.lisp (file)

Method: widget-value (FLOAT-VALUE-SLOT float-value-slot)
Method: (setf widget-value) NEW-VALUE (FLOAT-VALUE-SLOT float-value-slot)

Float value

Source

shared-slots.lisp (file)

Method: widget-value (BYTE-VALUE-SLOT byte-value-slot)
Method: (setf widget-value) NEW-VALUE (BYTE-VALUE-SLOT byte-value-slot)

The value as a byte string.

Source

shared-slots.lisp (file)

Method: widget-value (BOOL-VALUE-SLOT bool-value-slot)
Method: (setf widget-value) NEW-VALUE (BOOL-VALUE-SLOT bool-value-slot)

Bool value

Source

shared-slots.lisp (file)

Generic Function: widget-visibility OBJECT
Generic Function: (setf widget-visibility) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-visibility (LAYOUT layout)
Method: (setf widget-visibility) NEW-VALUE (LAYOUT layout)

The visibility CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-width OBJECT
Generic Function: (setf widget-width) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-width (LAYOUT layout)
Method: (setf widget-width) NEW-VALUE (LAYOUT layout)

The width CSS attribute.

Source

dom-widget.lisp (file)

Method: widget-width (WIDTH-SLOT width-slot)
Method: (setf widget-width) NEW-VALUE (WIDTH-SLOT width-slot)

Width of the media in pixels.

Source

shared-slots.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 Conditions

Condition: quit-condition ()

A condition for identifying a request for kernel shutdown.

Package

jupyter

Source

kernel.lisp (file)

Direct superclasses

error (condition)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.6 Classes

Class: accordion ()

Displays children each on a separate accordion page.

Package

jupyter-widgets

Source

box.lisp (file)

Direct superclasses

box (class)

Direct subclasses

tab (class)

Direct methods
Direct slots
Slot: %titles

Titles of the pages.

Initargs

:%titles

Initform

""

Readers

widget-%titles (generic function)

Writers

(setf widget-%titles) (generic function)

Slot: selected-index

The index of the selected page. This is either an integer selecting a particular sub-widget, or nil to have no widgets selected.

Initargs

:selected-index

Readers

widget-selected-index (generic function)

Writers

(setf widget-selected-index) (generic function)

Direct Default Initargs
InitargValue
:%model-name"accordionmodel"
:%view-name"accordionview"
Class: audio ()

Displays an audio clip as a widget.

The ‘value‘ of this widget accepts a byte string. The byte string is the raw audio data that you want the browser to display. You can explicitly define the format of the byte string using the ‘format‘ trait (which defaults to "mp3").

If you pass ‘"url"‘ to the ‘"format"‘ trait, ‘value‘ will be interpreted as a URL as bytes encoded in UTF-8.

Package

jupyter-widgets

Source

media.lisp (file)

Direct superclasses
Direct subclasses

video (class)

Direct methods
Direct slots
Slot: autoplay

When true, the audio starts when it’s displayed.

Initargs

:autoplay

Initform

t

Readers

widget-autoplay (generic function)

Writers

(setf widget-autoplay) (generic function)

Slot: controls

Specifies that media controls should be displayed (such as a play/pause button etc)

Initargs

:controls

Initform

t

Readers

widget-controls (generic function)

Writers

(setf widget-controls) (generic function)

Slot: loop

When true, the audio will start from the beginning after finishing

Initargs

:loop

Initform

t

Readers

widget-loop (generic function)

Writers

(setf widget-loop) (generic function)

Direct Default Initargs
InitargValue
:%model-name"audiomodel"
:%view-name"audioview"
:format"mp3"
Class: bounded-float-text ()

Displays a float value within a textbox. Value must be within the range specified. For a textbox in which the value doesn’t need to be within a specific range, use float-text.

Package

jupyter-widgets

Source

text.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"boundedfloattextmodel"
:%view-name"floattextview"
Class: bounded-int-text ()

Textbox widget that represents an integer bounded from above and below.

Package

jupyter-widgets

Source

text.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"boundedinttextmodel"
Class: box ()

Displays multiple widgets in a group. The widgets are laid out horizontally.

### Example

“‘common-lisp
(use-package :jupyter-widgets)
(defvar title-widget (make-widget ’html :value "<em>Box Example</em>")) (defvar slider (make-widget ’int-slider))
(make-widget ’box :children (list title-widget slider))
“‘

Package

jupyter-widgets

Source

box.lisp (file)

Direct superclasses

dom-widget (class)

Direct subclasses
Direct methods
Direct slots
Slot: box-style

Use a predefined styling for the box.

Initargs

:box-style

Initform

""

Readers

widget-box-style (generic function)

Writers

(setf widget-box-style) (generic function)

Slot: children

List of widget children.

Initargs

:children

Readers

widget-children (generic function)

Writers

(setf widget-children) (generic function)

Direct Default Initargs
InitargValue
:%model-name"boxmodel"
:%view-name"boxview"
Class: button ()

Button widget.
This widget has an ‘on-button-click‘ method that allows you to listen for the user clicking on the button. The click event itself is stateless.

Package

jupyter-widgets

Source

button.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: description

Button label.

Initargs

:description

Readers

widget-description (generic function)

Writers

(setf widget-description) (generic function)

Direct Default Initargs
InitargValue
:%model-name"buttonmodel"
:%view-name"buttonview"
:style(jupyter-widgets:make-widget (quote jupyter-widgets:button-style))
Class: button-style ()

Button style widget

Package

jupyter-widgets

Source

style.lisp (file)

Direct superclasses

style (class)

Direct methods
Direct slots
Slot: button-color

Color of the button

Initargs

:button-color

Readers

widget-button-color (generic function)

Writers

(setf widget-button-color) (generic function)

Slot: font-weight

Button text font weight.

Initargs

:font-weight

Readers

widget-font-weight (generic function)

Writers

(setf widget-font-weight) (generic function)

Direct Default Initargs
InitargValue
:%model-name"buttonstylemodel"
Class: checkbox ()

Displays a boolean ‘value‘ in the form of a checkbox.

Package

jupyter-widgets

Source

checkbox.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: indent

Indent the control to align with other controls with a description.

Initargs

:indent

Initform

t

Readers

widget-indent (generic function)

Writers

(setf widget-indent) (generic function)

Direct Default Initargs
InitargValue
:%model-name"checkboxmodel"
:%view-name"checkboxview"
Class: color-picker ()

Color picker widget

Package

jupyter-widgets

Source

color-picker.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: concise

Display short version with just a color selector.

Initargs

:concise

Readers

widget-concise (generic function)

Writers

(setf widget-concise) (generic function)

Slot: value

The color value.

Initargs

:value

Initform

"black"

Readers

widget-value (generic function)

Writers

(setf widget-value) (generic function)

Direct Default Initargs
InitargValue
:%model-name"colorpickermodel"
:%view-name"colorpickerview"
Class: comm ()
Package

jupyter

Source

comm.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

widget (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Initform

(jupyter::make-uuid)

Readers

comm-id (generic function)

Slot: target-name
Initargs

:target-name

Readers

comm-target-name (generic function)

Slot: kernel
Initargs

:kernel

Initform

jupyter::*kernel*

Readers

comm-kernel (generic function)

Class: controller ()

Represents a game controller.

Package

jupyter-widgets

Source

controller.lisp (file)

Direct superclasses

dom-widget (class)

Direct methods
Direct slots
Slot: axes

The axes on the gamepad.

Initargs

:axes

Readers

widget-axes (generic function)

Writers

(setf widget-axes) (generic function)

Slot: buttons

The buttons on the gamepad.

Initargs

:buttons

Readers

widget-buttons (generic function)

Writers

(setf widget-buttons) (generic function)

Slot: connected

Whether the gamepad is connected.

Initargs

:connected

Readers

widget-connected (generic function)

Writers

(setf widget-connected) (generic function)

Slot: index

The id number of the controller.

Initargs

:index

Initform

0

Readers

widget-index (generic function)

Writers

(setf widget-index) (generic function)

Slot: mapping

The name of the control mapping.

Initargs

:mapping

Initform

""

Readers

widget-mapping (generic function)

Writers

(setf widget-mapping) (generic function)

Slot: name

The name of the controller.

Initargs

:name

Initform

""

Readers

widget-name (generic function)

Writers

(setf widget-name) (generic function)

Slot: timestamp

The last time the data from this gamepad was updated.

Initargs

:timestamp

Initform

0.0d0

Readers

widget-timestamp (generic function)

Writers

(setf widget-timestamp) (generic function)

Direct Default Initargs
InitargValue
:%model-name"controllermodel"
:%view-name"controllerview"
Class: controller-axis ()

Represents a gamepad or joystick axis.

Package

jupyter-widgets

Source

controller.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"controlleraxismodel"
:%view-name"controlleraxisview"
Class: controller-button ()

Represents a gamepad or joystick button.

Package

jupyter-widgets

Source

controller.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: pressed

Whether the button is pressed.

Initargs

:pressed

Readers

widget-pressed (generic function)

Writers

(setf widget-pressed) (generic function)

Direct Default Initargs
InitargValue
:%model-name"controllerbuttonmodel"
:%view-name"controllerbuttonview"
Class: date-picker ()

Date picker widget

Package

jupyter-widgets

Source

date-picker.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: value

The date value.

Initargs

:value

Readers

widget-value (generic function)

Writers

(setf widget-value) (generic function)

Direct Default Initargs
InitargValue
:%model-name"datepickermodel"
:%view-name"datepickerview"
Class: description-style ()
Package

jupyter-widgets

Source

style.lisp (file)

Direct superclasses

style (class)

Direct subclasses
Direct methods
Direct slots
Slot: description-width

Width of the description to the side of the control.

Initargs

:description-width

Readers

widget-description-width (generic function)

Writers

(setf widget-description-width) (generic function)

Direct Default Initargs
InitargValue
:%model-name"descriptionstylemodel"

A directional link

Package

jupyter-widgets

Source

link.lisp (file)

Direct superclasses

link (class)

Direct Default Initargs
InitargValue
:%model-name"directionallinkmodel"
Class: dom-widget ()

Base class for all Jupyter widgets which have DOM view.

Package

jupyter-widgets

Source

dom-widget.lisp (file)

Direct superclasses

widget (class)

Direct subclasses
Direct methods
Direct slots
Slot: %dom-classes

CSS classes applied to widget DOM element

Initargs

:%dom-classes

Readers

widget-%dom-classes (generic function)

Writers

(setf widget-%dom-classes) (generic function)

Slot: layout

Reference to layout widget.

Initargs

:layout

Initform

(jupyter-widgets:make-widget (quote jupyter-widgets:layout))

Readers

widget-layout (generic function)

Writers

(setf widget-layout) (generic function)

Direct Default Initargs
InitargValue
:%model-name"domwidgetmodel"
:%model-modulejupyter-widgets::+controls-module+
:%model-module-versionjupyter-widgets::+controls-module-version+
:%view-name""
:%view-modulejupyter-widgets::+controls-module+
:%view-module-versionjupyter-widgets::+controls-module-version+
Class: dropdown ()

Allows you to select a single item from a dropdown.

Package

jupyter-widgets

Source

radio-buttons.lisp (file)

Direct superclasses

radio-buttons (class)

Direct Default Initargs
InitargValue
:%model-name"dropdownmodel"
:%view-name"dropdownview"
Class: float-log-slider ()

Slider/trackbar of logarithmic floating values with the specified range.

Package

jupyter-widgets

Source

slider.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: base

Base for the logarithm

Initargs

:base

Initform

10.0d0

Readers

widget-base (generic function)

Writers

(setf widget-base) (generic function)

Direct Default Initargs
InitargValue
:%model-name"floatlogslidermodel"
:%view-name"floatlogsliderview"
:readout-format".3g"
:max4.0d0
Class: float-progress ()

Displays a progress bar.

Package

jupyter-widgets

Source

progress.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"floatprogressmodel"
Class: float-range-slider ()

Slider/trackbar that represents a pair of floats bounded by minimum and maximum value.

Package

jupyter-widgets

Source

slider.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: value

Float range

Initargs

:value

Initform

(quote (0.0d0 1.0d0))

Readers

widget-value (generic function)

Writers

(setf widget-value) (generic function)

Direct Default Initargs
InitargValue
:%model-name"floatrangeslidermodel"
:%view-name"floatrangesliderview"
:readout-format".2f"
Class: float-slider ()

Slider/trackbar of floating values with the specified range.

Package

jupyter-widgets

Source

slider.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"floatslidermodel"
:%view-name"floatsliderview"
:readout-format".2f"
Class: float-text ()

Displays a float value within a textbox. For a textbox in which the value must be within a specific range, use BoundedFloatText.

Package

jupyter-widgets

Source

text.lisp (file)

Direct superclasses
Direct subclasses

bounded-float-text (class)

Direct Default Initargs
InitargValue
:%model-name"floattextmodel"
:%view-name"floattextview"
Class: grid-box ()
Package

jupyter-widgets

Source

box.lisp (file)

Direct superclasses

box (class)

Direct Default Initargs
InitargValue
:%model-name"gridboxmodel"
:%view-name"gridboxview"
Class: h-box ()

Displays multiple widgets horizontally using the flexible box model.

### Example

“‘common-lisp
(use-package :jupyter-widgets)
(defvar title-widget (make-widget ’html :value "<em>Box Example</em>")) (defvar slider (make-widget ’int-slider))
(make-widget ’h-box :children (list title-widget slider))
“‘

Package

jupyter-widgets

Source

box.lisp (file)

Direct superclasses

box (class)

Direct Default Initargs
InitargValue
:%model-name"hboxmodel"
:%view-name"hboxview"
Class: html ()

Renders the string ‘value‘ as HTML.

Package

jupyter-widgets

Source

label.lisp (file)

Direct superclasses

label (class)

Direct Default Initargs
InitargValue
:%model-name"htmlmodel"
:%view-name"htmlview"
Class: html-math ()

Renders the string ‘value‘ as HTML, and render mathematics.

Package

jupyter-widgets

Source

label.lisp (file)

Direct superclasses

label (class)

Direct Default Initargs
InitargValue
:%model-name"htmlmathmodel"
:%view-name"htmlmathview"
Class: image ()

Displays an image as a widget.

The ‘value‘ of this widget accepts a byte string. The byte string is the raw image data that you want the browser to display. You can explicitly define the format of the byte string using the ‘format‘ trait (which defaults to "png").

If you pass ‘"url"‘ to the ‘"format"‘ trait, ‘value‘ will be interpreted as a URL as bytes encoded in UTF-8.

Package

jupyter-widgets

Source

media.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"imagemodel"
:%view-name"imageview"
:format"png"
Class: inline-result ()
Package

jupyter

Source

results.lisp (file)

Direct superclasses

result (class)

Direct methods
Direct slots
Slot: value
Initargs

:value

Readers

inline-result-value (generic function)

Slot: mime-type
Initargs

:mime-type

Readers

inline-result-mime-type (generic function)

Class: int-progress ()

Progress bar that represents an integer bounded from above and below.

Package

jupyter-widgets

Source

progress.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"intprogressmodel"
Class: int-range-slider ()

Slider/trackbar that represents a pair of ints bounded by minimum and maximum value.

Package

jupyter-widgets

Source

slider.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: value

Int range value

Initargs

:value

Initform

(quote (0 1))

Readers

widget-value (generic function)

Writers

(setf widget-value) (generic function)

Direct Default Initargs
InitargValue
:%model-name"intrangeslidermodel"
:%view-name"intrangesliderview"
:readout-format"d"
Class: int-slider ()

Slider widget that represents an integer bounded from above and below.

Package

jupyter-widgets

Source

slider.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"intslidermodel"
:%view-name"intsliderview"
:readout-format"d"
Class: int-text ()

Textbox widget that represents an integer.

Package

jupyter-widgets

Source

text.lisp (file)

Direct superclasses
Direct subclasses

bounded-int-text (class)

Direct Default Initargs
InitargValue
:%model-name"inttextmodel"
:%view-name"inttextview"
Class: kernel ()
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Direct superclasses

kernel (class)

Direct methods
Direct Default Initargs
InitargValue
:name"common-lisp"
:package(find-package :common-lisp-user)
:version"0.1"
:banner"common-lisp-jupyter: a common lisp jupyter kernel (c) 2019 tarn burton (mit)"
:language-name"common-lisp"
:language-version(uiop/os:lisp-version-string)
:mime-type"text/x-common-lisp"
:file-extension".lisp"
:pygments-lexer"common-lisp"
:codemirror-mode"text/x-common-lisp"
:help-links(quote (("common lisp documentation" . "https://common-lisp.net/documentation") ("common lisp hyperspec" . "http://www.lispworks.com/documentation/hyperspec/front/index.htm")))
Class: kernel ()

Kernel state representation.

Package

jupyter

Source

kernel.lisp (file)

Direct superclasses

source (class)

Direct subclasses

kernel (class)

Direct methods
Direct slots
Slot: name

Kernel name. Used as a unique identifier in kernel description.

Initargs

:name

Initform

""

Readers

kernel-name (generic function)

Slot: version

Kernel version.

Initargs

:version

Initform

""

Readers

kernel-version (generic function)

Slot: banner

Banner text used to describe kernel. Used in kernel_info_reply messages.

Initargs

:banner

Initform

""

Readers

kernel-banner (generic function)

Slot: language-name

Display name of implementation language. Used in kernel_info_reply messages.

Initargs

:language-name

Initform

""

Readers

kernel-language-name (generic function)

Slot: language-version

Version of implementation language. Used in kernel_info_reply messages.

Initargs

:language-version

Initform

""

Readers

kernel-language-version (generic function)

Slot: mime-type

Default MIME type for source files. Used in kernel_info_reply messages.

Initargs

:mime-type

Initform

""

Readers

kernel-mime-type (generic function)

Slot: file-extension

Default file extension for source files. Used in kernel_info_reply messages.

Initargs

:file-extension

Initform

""

Readers

kernel-file-extension (generic function)

Slot: pygments-lexer

Name of Pygments lexer for source files. Used in kernel_info_reply messages.

Initargs

:pygments-lexer

Initform

""

Readers

kernel-pygments-lexer (generic function)

Slot: codemirror-mode

CodeMirror mode for source files. Used in kernel_info_reply messages.

Initargs

:codemirror-mode

Initform

""

Readers

kernel-codemirror-mode (generic function)

An association list of help links. The car is the
description and the cdr is URL. Used in kernel_info_reply messages.

Initargs

:help-links

Readers

kernel-help-links (generic function)

Slot: package

The package in which evaluate-code, code-is-complete and others are called.

Initargs

:package

Readers

kernel-package (generic function)

Writers

(setf kernel-package) (generic function)

Slot: connection-file

Pathname of connection file.

Initargs

:connection-file

Readers

kernel-connection-file (generic function)

Slot: transport

Transport protocol from connection file.

Type

string

Readers

kernel-transport (generic function)

Writers

(setf kernel-transport) (generic function)

Slot: ip

IP address from connection file.

Type

string

Readers

kernel-ip (generic function)

Writers

(setf kernel-ip) (generic function)

Slot: shell-port

SHELL port from connection file.

Type

fixnum

Readers

kernel-shell-port (generic function)

Writers

(setf kernel-shell-port) (generic function)

Slot: stdin-port

STDIN port from connection file.

Type

fixnum

Readers

kernel-stdin-port (generic function)

Writers

(setf kernel-stdin-port) (generic function)

Slot: iopub-port

IOPUB port from connection file.

Type

fixnum

Readers

kernel-iopub-port (generic function)

Writers

(setf kernel-iopub-port) (generic function)

Slot: control-port

CONTROL port from connection file.

Type

fixnum

Readers

kernel-control-port (generic function)

Writers

(setf kernel-control-port) (generic function)

Slot: hb-port

HB port from connection file.

Type

fixnum

Readers

kernel-hb-port (generic function)

Writers

(setf kernel-hb-port) (generic function)

Slot: signature-scheme

Signature scheme from connection file.

Type

string

Readers

kernel-signature-scheme (generic function)

Writers

(setf kernel-signature-scheme) (generic function)

Slot: key

Signing key from connection file.

Readers

kernel-key (generic function)

Writers

(setf kernel-key) (generic function)

Slot: prompt-prefix

String prefix using in *standard-output* to indicate the start of prompt.

Initargs

:prompt-prefix

Initform

(coerce (quote (#\esc #\latin_capital_letter_x)) (quote string))

Readers

kernel-prompt-prefix (generic function)

Slot: prompt-suffix

String suffix using in *standard-output* to indicate the end of prompt.

Initargs

:prompt-suffix

Initform

(coerce (quote (#\esc #\reverse_solidus)) (quote string))

Readers

kernel-prompt-suffix (generic function)

Slot: ctx

pzmq ctx handle.

Readers

kernel-ctx (generic function)

Writers

(setf kernel-ctx) (generic function)

Slot: mac

Message authification.

Readers

kernel-mac (generic function)

Writers

(setf kernel-mac) (generic function)

Slot: hb

Heartbeat channel.

Readers

kernel-hb (generic function)

Writers

(setf kernel-hb) (generic function)

Slot: shell

SHELL channel.

Readers

kernel-shell (generic function)

Writers

(setf kernel-shell) (generic function)

Slot: stdin

STDIN channel.

Readers

kernel-stdin (generic function)

Writers

(setf kernel-stdin) (generic function)

Slot: iopub

IOPUB channel.

Readers

kernel-iopub (generic function)

Writers

(setf kernel-iopub) (generic function)

Slot: session

Session identifier.

Readers

kernel-session (generic function)

Writers

(setf kernel-session) (generic function)

Slot: input-queue

Input queue used to feed values into execute_result payloads.

Initargs

:input-queue

Initform

(make-instance (quote metabang.cl-containers:basic-queue))

Readers

kernel-input-queue (generic function)

Slot: history

Kernel history manager.

Readers

kernel-history (generic function)

Writers

(setf kernel-history) (generic function)

Slot: execution-count

Kernel execution count.

Initform

0

Readers

history-execution-count (generic function)

Writers

(setf history-execution-count) (generic function)

Slot: comms

Currently open comms.

Initform

(make-hash-table :test (function equal))

Readers

kernel-comms (generic function)

Class: label ()

Label widget.

It also renders math inside the string ‘value‘ as Latex (requires $ $ or $$ $$ and similar latex tags).

Package

jupyter-widgets

Source

label.lisp (file)

Direct superclasses
Direct subclasses
Direct Default Initargs
InitargValue
:%model-name"labelmodel"
:%view-name"labelview"
Class: layout ()

Layout specification

Defines a layout that can be expressed using CSS. Supports a subset of https://developer.mozilla.org/en-US/docs/Web/CSS/Reference

When a property is also accessible via a shorthand property, we only expose the shorthand.

Package

jupyter-widgets

Source

dom-widget.lisp (file)

Direct superclasses

widget (class)

Direct methods
Direct slots
Slot: align-content

The align-content CSS attribute.

Initargs

:align-content

Readers

widget-align-content (generic function)

Writers

(setf widget-align-content) (generic function)

Slot: align-items

The align-items CSS attribute.

Initargs

:align-items

Readers

widget-align-items (generic function)

Writers

(setf widget-align-items) (generic function)

Slot: align-self

The align-self CSS attribute.

Initargs

:align-self

Readers

widget-align-self (generic function)

Writers

(setf widget-align-self) (generic function)

Slot: border

The border CSS attribute.

Initargs

:border

Readers

widget-border (generic function)

Writers

(setf widget-border) (generic function)

Slot: bottom

The bottom CSS attribute.

Initargs

:bottom

Readers

widget-bottom (generic function)

Writers

(setf widget-bottom) (generic function)

Slot: display

The display CSS attribute.

Initargs

:display

Readers

widget-display (generic function)

Writers

(setf widget-display) (generic function)

Slot: flex

The flex CSS attribute.

Initargs

:flex

Readers

widget-flex (generic function)

Writers

(setf widget-flex) (generic function)

Slot: flex-flow

The flex-flow CSS attribute.

Initargs

:flex-flow

Readers

widget-flex-flow (generic function)

Writers

(setf widget-flex-flow) (generic function)

Slot: grid-area

The grid-area CSS attribute.

Initargs

:grid-area

Readers

widget-grid-area (generic function)

Writers

(setf widget-grid-area) (generic function)

Slot: grid-auto-columns

The grid-auto-columns CSS attribute.

Initargs

:grid-auto-columns

Readers

widget-grid-auto-columns (generic function)

Writers

(setf widget-grid-auto-columns) (generic function)

Slot: grid-auto-flow

The grid-auto-flow CSS attribute.

Initargs

:grid-auto-flow

Readers

widget-grid-auto-flow (generic function)

Writers

(setf widget-grid-auto-flow) (generic function)

Slot: grid-column

The grid-column CSS attribute.

Initargs

:grid-column

Readers

widget-grid-column (generic function)

Writers

(setf widget-grid-column) (generic function)

Slot: grid-gap

The grid-gap CSS attribute.

Initargs

:grid-gap

Readers

widget-grid-gap (generic function)

Writers

(setf widget-grid-gap) (generic function)

Slot: grid-template-areas

The grid-template-areas CSS attribute.

Initargs

:grid-template-areas

Readers

widget-grid-template-areas (generic function)

Writers

(setf widget-grid-template-areas) (generic function)

Slot: grid-template-columns

The grid-template-columns CSS attribute.

Initargs

:grid-template-columns

Readers

widget-grid-template-columns (generic function)

Writers

(setf widget-grid-template-columns) (generic function)

Slot: grid-template-rows

The grid-template-rows CSS attribute.

Initargs

:grid-template-rows

Readers

widget-grid-template-rows (generic function)

Writers

(setf widget-grid-template-rows) (generic function)

Slot: height

The height CSS attribute.

Initargs

:height

Readers

widget-height (generic function)

Writers

(setf widget-height) (generic function)

Slot: justify-content

The justify-content CSS attribute.

Initargs

:justify-content

Readers

widget-justify-content (generic function)

Writers

(setf widget-justify-content) (generic function)

Slot: left

The left CSS attribute.

Initargs

:left

Readers

widget-left (generic function)

Writers

(setf widget-left) (generic function)

Slot: margin

The margin CSS attribute.

Initargs

:margin

Readers

widget-margin (generic function)

Writers

(setf widget-margin) (generic function)

Slot: max-height

The max-height CSS attribute.

Initargs

:max-height

Readers

widget-max-height (generic function)

Writers

(setf widget-max-height) (generic function)

Slot: max-width

The max-width CSS attribute.

Initargs

:max-width

Readers

widget-max-width (generic function)

Writers

(setf widget-max-width) (generic function)

Slot: min-height

The min-height CSS attribute.

Initargs

:min-height

Readers

widget-min-height (generic function)

Writers

(setf widget-min-height) (generic function)

Slot: min-width

The min-width CSS attribute.

Initargs

:min-width

Readers

widget-min-width (generic function)

Writers

(setf widget-min-width) (generic function)

Slot: order

The order CSS attribute.

Initargs

:order

Readers

widget-order (generic function)

Writers

(setf widget-order) (generic function)

Slot: overflow

The overflow CSS attribute.

Initargs

:overflow

Readers

widget-overflow (generic function)

Writers

(setf widget-overflow) (generic function)

Slot: overflow-x

The overflow-x CSS attribute.

Initargs

:overflow-x

Readers

widget-overflow-x (generic function)

Writers

(setf widget-overflow-x) (generic function)

Slot: overflow-y

The overflow-y CSS attribute.

Initargs

:overflow-y

Readers

widget-overflow-y (generic function)

Writers

(setf widget-overflow-y) (generic function)

Slot: padding

The padding CSS attribute.

Initargs

:padding

Readers

widget-padding (generic function)

Writers

(setf widget-padding) (generic function)

Slot: right

The right CSS attribute.

Initargs

:right

Readers

widget-right (generic function)

Writers

(setf widget-right) (generic function)

Slot: top

The top CSS attribute.

Initargs

:top

Readers

widget-top (generic function)

Writers

(setf widget-top) (generic function)

Slot: visibility

The visibility CSS attribute.

Initargs

:visibility

Readers

widget-visibility (generic function)

Writers

(setf widget-visibility) (generic function)

Slot: width

The width CSS attribute.

Initargs

:width

Readers

widget-width (generic function)

Writers

(setf widget-width) (generic function)

Direct Default Initargs
InitargValue
:%model-name"layoutmodel"
:%model-modulejupyter-widgets::+base-module+
:%model-module-versionjupyter-widgets::+base-module-version+
:%view-name"layoutview"
:%view-modulejupyter-widgets::+base-module+
:%view-module-versionjupyter-widgets::+base-module-version+

Link Widget

Package

jupyter-widgets

Source

link.lisp (file)

Direct superclasses

widget (class)

Direct subclasses

directional-link (class)

Direct methods
Direct slots
Slot: source
Initargs

:source

Readers

widget-source (generic function)

Writers

(setf widget-source) (generic function)

Slot: target
Initargs

:target

Readers

widget-target (generic function)

Writers

(setf widget-target) (generic function)

Direct Default Initargs
InitargValue
:%model-name"linkmodel"
:%model-modulejupyter-widgets::+controls-module+
:%model-module-versionjupyter-widgets::+controls-module-version+
:%view-name""
:%view-modulejupyter-widgets::+controls-module+
:%view-module-versionjupyter-widgets::+controls-module-version+
Class: output ()

Widget used as a context manager to display output.

This widget can capture and display stdout, stderr, and rich output. To use it, create an instance of it and display it.

You can then use the widget as a context manager: any output produced while in the context will be captured and displayed in the widget instead of the standard output area.

### Example

“‘common-lisp
(use-package :jupyter-widgets)
(defvar out (make-widget ’output))
(with-output out
(print "prints to output area")
“‘

Package

jupyter-widgets

Source

output.lisp (file)

Direct superclasses

dom-widget (class)

Direct methods
Direct slots
Slot: msg-id

Parent message id of messages to capture

Initargs

:msg-id

Initform

""

Readers

widget-msg-id (generic function)

Writers

(setf widget-msg-id) (generic function)

Slot: outputs

The output messages synced from the frontend.

Initargs

:outputs

Readers

widget-outputs (generic function)

Writers

(setf widget-outputs) (generic function)

Direct Default Initargs
InitargValue
:%model-name"outputmodel"
:%model-modulejupyter-widgets::+output-module+
:%model-module-versionjupyter-widgets::+output-module-version+
:%view-name"outputview"
:%view-modulejupyter-widgets::+output-module+
:%view-module-versionjupyter-widgets::+output-module-version+
Class: password ()

Single line textbox widget.

Package

jupyter-widgets

Source

text.lisp (file)

Direct superclasses

text (class)

Direct Default Initargs
InitargValue
:%model-name"passwordmodel"
:%view-name"passwordview"
Class: play ()

Play/repeat buttons to step through values automatically, and optionally loop.

Package

jupyter-widgets

Source

media.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: %playing

Whether the control is currently playing.

Initargs

:%playing

Readers

widget-%playing (generic function)

Writers

(setf widget-%playing) (generic function)

Slot: %repeat

Whether the control will repeat in a continous loop.

Initargs

:%repeat

Readers

widget-%repeat (generic function)

Writers

(setf widget-%repeat) (generic function)

Slot: interval

The maximum value for the play control.

Initargs

:interval

Initform

100

Readers

widget-interval (generic function)

Writers

(setf widget-interval) (generic function)

Slot: show-repeat

Show the repeat toggle button in the widget.

Initargs

:show-repeat

Initform

t

Readers

widget-show-repeat (generic function)

Writers

(setf widget-show-repeat) (generic function)

Direct Default Initargs
InitargValue
:%model-name"playmodel"
:%view-name"playview"
Class: progress-style ()

Progress style widget.

Package

jupyter-widgets

Source

style.lisp (file)

Direct superclasses

description-style (class)

Direct methods
Direct slots
Slot: bar-color

Color of the slider handle.

Initargs

:bar-color

Readers

widget-bar-color (generic function)

Writers

(setf widget-bar-color) (generic function)

Direct Default Initargs
InitargValue
:%model-name"progressstylemodel"
Class: radio-buttons ()

Group of radio buttons that represent an enumeration. Only one radio button can be toggled at any point in time.

Package

jupyter-widgets

Source

radio-buttons.lisp (file)

Direct superclasses
Direct subclasses

dropdown (class)

Direct Default Initargs
InitargValue
:%model-name"radiobuttonsmodel"
:%view-name"radiobuttonsview"
Class: result ()

Base class for encapsulation of evaluation result.

Package

jupyter

Source

results.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: display-data

Show result as display_data in client.

Initargs

:display-data

Readers

result-display-data (generic function)

Writers

(setf result-display-data) (generic function)

Class: select ()

Listbox that only allows one item to be selected at any given time.

Package

jupyter-widgets

Source

select.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"selectmodel"
:%view-name"selectview"
Class: select-multiple ()

Listbox that allows many items to be selected at any given time.

Package

jupyter-widgets

Source

select.lisp (file)

Direct superclasses

base-select (class)

Direct methods
Direct slots
Slot: index

Selected indicies

Initargs

:index

Readers

widget-index (generic function)

Writers

(setf widget-index) (generic function)

Direct Default Initargs
InitargValue
:%model-name"selectmultiplemodel"
:%view-name"selectmultipleview"
Class: selection-range-slider ()

Slider to select multiple contiguous items from a list.

Package

jupyter-widgets

Source

slider.lisp (file)

Direct superclasses

label-slider (class)

Direct methods
Direct slots
Slot: index

Min and max selected indices

Initargs

:index

Initform

(quote (0 0))

Readers

widget-index (generic function)

Writers

(setf widget-index) (generic function)

Direct Default Initargs
InitargValue
:%model-name"selectionrangeslidermodel"
:%view-name"selectionrangesliderview"
Class: selection-slider ()

Slider to select a single item from a list or dictionary.

Package

jupyter-widgets

Source

slider.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"selectionslidermodel"
:%view-name"selectionsliderview"
Class: slider-style ()
Package

jupyter-widgets

Source

style.lisp (file)

Direct superclasses

description-style (class)

Direct methods
Direct slots
Slot: handle-color

Color of the slider handle.

Initargs

:handle-color

Readers

widget-handle-color (generic function)

Writers

(setf widget-handle-color) (generic function)

Direct Default Initargs
InitargValue
:%model-name"sliderstylemodel"
Class: tab ()

Displays children each on a separate accordion tab.

Package

jupyter-widgets

Source

box.lisp (file)

Direct superclasses

accordion (class)

Direct Default Initargs
InitargValue
:%model-name"tabmodel"
:%view-name"tabview"
Class: text ()

Single line textbox widget.

Package

jupyter-widgets

Source

text.lisp (file)

Direct superclasses
Direct subclasses
Direct Default Initargs
InitargValue
:%model-name"textmodel"
:%view-name"textview"
Class: text-area ()

Multiline text area widget.

Package

jupyter-widgets

Source

text.lisp (file)

Direct superclasses

text (class)

Direct methods
Direct slots
Slot: rows

The number of rows to display.

Initargs

:rows

Readers

widget-rows (generic function)

Writers

(setf widget-rows) (generic function)

Direct Default Initargs
InitargValue
:%model-name"textareamodel"
:%view-name"textareaview"
Class: toggle-button ()

Displays a boolean ‘value‘ in the form of a toggle button.

Package

jupyter-widgets

Source

toggle-button.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"togglebuttonmodel"
:%view-name"togglebuttonview"
Class: toggle-buttons ()

Group of toggle buttons that represent an enumeration. Only one toggle button can be toggled at any point in time.

Package

jupyter-widgets

Source

toggle-button.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: icons

Icons names for each button (FontAwesome names without the fa- prefix).

Initargs

:icons

Initform

""

Readers

widget-icons (generic function)

Writers

(setf widget-icons) (generic function)

Slot: tooltips

Tooltips for each button.

Initargs

:tooltips

Readers

widget-tooltips (generic function)

Writers

(setf widget-tooltips) (generic function)

Direct Default Initargs
InitargValue
:%model-name"togglebuttonsmodel"
:%view-name"togglebuttonsview"
Class: v-box ()

Displays multiple widgets vertically using the flexible box model.

### Example

“‘common-lisp
(use-package :jupyter-widgets)
(defvar title-widget (make-widget ’html :value "<em>Box Example</em>")) (defvar slider (make-widget ’int-slider))
(make-widget ’v-box :children (list title-widget slider))
“‘

Package

jupyter-widgets

Source

box.lisp (file)

Direct superclasses

box (class)

Direct Default Initargs
InitargValue
:%model-name"vboxmodel"
:%view-name"vboxview"
Class: valid ()

Displays a boolean ‘value‘ in the form of a green check (True / valid) or a red cross (False / invalid).

Package

jupyter-widgets

Source

valid.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: readout

Message displayed when the value is False

Initargs

:readout

Initform

"invalid"

Readers

widget-readout (generic function)

Writers

(setf widget-readout) (generic function)

Direct Default Initargs
InitargValue
:%model-name"validmodel"
:%view-name"validview"
Class: video ()

Displays a video as a widget.

The ‘value‘ of this widget accepts a byte string. The byte string is the raw video data that you want the browser to display. You can explicitly define the format of the byte string using the ‘format‘ trait (which defaults to "mp4").

If you pass ‘"url"‘ to the ‘"format"‘ trait, ‘value‘ will be interpreted as a URL as bytes encoded in UTF-8.

Package

jupyter-widgets

Source

media.lisp (file)

Direct superclasses
Direct Default Initargs
InitargValue
:%model-name"videomodel"
:%view-name"videoview"
:format"mp4"
Class: widget ()

Base class for all Jupyter widgets.

Package

jupyter-widgets

Source

widget.lisp (file)

Direct superclasses
Direct subclasses
Direct methods
Direct slots
Slot: %model-name

Name of the model.

Initargs

:%model-name

Readers

widget-%module-name (generic function)

Slot: %model-module

The namespace for the model.

Initargs

:%model-module

Readers

widget-%module-module (generic function)

Slot: %model-module-version

A semver requirement for namespace version containing the model.

Initargs

:%model-module-version

Readers

widget-%module-module-version (generic function)

Slot: %view-name

Name of the view.

Initargs

:%view-name

Readers

widget-%view-name (generic function)

Slot: %view-module

The namespace for the view.

Initargs

:%view-module

Readers

widget-%view-module (generic function)

Slot: %view-module-version

A semver requirement for namespace version containing the view.

Initargs

:%view-module-version

Readers

widget-%view-module-version (generic function)

Direct Default Initargs
InitargValue
:display-datat
:target-namejupyter-widgets::+target-name+

Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *color-names*
Package

jupyter-widgets

Source

trait-types.lisp (file)

Special Variable: *gif-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *hex-digits*
Package

jupyter-widgets

Source

trait-types.lisp (file)

Special Variable: *html-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *iopub-stream-size*
Package

jupyter

Source

iopub.lisp (file)

Special Variable: *javascript-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *jpeg-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *json-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *kernel*
Package

jupyter

Source

kernel.lisp (file)

Special Variable: *latex-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *lisp-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *markdown-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *message*
Package

jupyter

Source

kernel.lisp (file)

Special Variable: *payload*
Package

jupyter

Source

kernel.lisp (file)

Special Variable: *pdf-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *plain-text-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *png-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *ps-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *state-lock*
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: *stdin-stream-size*
Package

jupyter

Source

stdin.lisp (file)

Special Variable: *svg-mime-type*
Package

jupyter

Source

results.lisp (file)

Special Variable: *trait-hold*
Package

jupyter-widgets

Source

traits.lisp (file)

Special Variable: *trait-notifications*
Package

jupyter-widgets

Source

traits.lisp (file)

Special Variable: *trait-silence*
Package

jupyter-widgets

Source

traits.lisp (file)

Special Variable: *widgets*
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: +base-module+
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: +base-module-version+
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: +body-length+
Package

jupyter

Source

message.lisp (file)

Special Variable: +controls-module+
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: +controls-module-version+
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: +display-name+
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Special Variable: +history-size+
Package

jupyter

Source

history.lisp (file)

Special Variable: +ids-msg-delimiter+
Package

jupyter

Source

message.lisp (file)

Special Variable: +kernel-protocol-version+
Package

jupyter

Source

config.lisp (file)

Special Variable: +language+
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Special Variable: +output-module+
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: +output-module-version+
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: +protocol-version+
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: +resources+
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Special Variable: +target-name+
Package

jupyter-widgets

Source

widget.lisp (file)

Special Variable: +widget-prefix+
Package

jupyter-widgets

Source

trait-types.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Macros

Macro: lock-file PATH &body BODY
Package

jupyter

Source

history.lisp (file)

Macro: register-widget NAME
Package

jupyter-widgets

Source

widget.lisp (file)

Macro: with-trait-hold &body BODY
Package

jupyter-widgets

Source

traits.lisp (file)

Macro: with-trait-silence &body BODY
Package

jupyter-widgets

Source

traits.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Functions

Function: add-cell HISTORY NUMBER INPUT
Package

jupyter

Source

history.lisp (file)

Function: check-mime-db ()
Package

jupyter

Source

results.lisp (file)

Function: compute-signature M PARTS
Package

jupyter

Source

mac.lisp (file)

Function: eval-error-p RESULT

Predicate to determine if result is an error result.

Package

jupyter

Source

results.lisp (file)

Function: extract-buffers STATE &optional PATH
Package

jupyter-widgets

Source

widget.lisp (file)

Function: extract-major-version SEMVER
Package

jupyter-widgets

Source

widget.lisp (file)

Function: find-qualified-symbol NAME DEFAULT-PACKAGE
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: handle-comm-close KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-comm-info-request KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-comm-message KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-comm-open KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-complete-request KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-execute-request KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-history-request KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-inspect-request KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-is-complete-request KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-kernel-info-request KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-message KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: handle-shutdown-request KERNEL MSG
Package

jupyter

Source

kernel.lisp (file)

Function: history-range HISTORY SESS START STOP
Package

jupyter

Source

history.lisp (file)

Function: history-search HISTORY N PATTERN UNIQUE
Package

jupyter

Source

history.lisp (file)

Function: history-tail HISTORY N
Package

jupyter

Source

history.lisp (file)

Function: inject-buffer STATE BUFFER-PATH BUFFER
Package

jupyter-widgets

Source

widget.lisp (file)

Function: inject-buffers STATE BUFFER-PATHS BUFFERS
Package

jupyter-widgets

Source

widget.lisp (file)

Function: kernel-home &key KERNEL-NAME SYSTEM
Package

jupyter

Source

utils.lisp (file)

Function: make-eval-error ERR MSG &key QUIT
Package

jupyter

Source

kernel.lisp (file)

Function: make-iopub-stream IOPUB PARENT-MSG NAME PROMPT-PREFIX PROMPT-SUFFIX
Package

jupyter

Source

iopub.lisp (file)

Function: make-message PARENT-MSG MSG-TYPE CONTENT &optional METADATA BUFFERS
Package

jupyter

Source

message.lisp (file)

Function: make-orphan-message SESSION-ID MSG-TYPE CONTENT &optional METADATA BUFFERS
Package

jupyter

Source

message.lisp (file)

Function: make-stdin-stream STDIN PARENT-MSG
Package

jupyter

Source

stdin.lisp (file)

Function: make-uuid ()
Package

jupyter

Source

utils.lisp (file)

Function: mangle-symbol-case NAME
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: message-recv CH
Package

jupyter

Source

message.lisp (file)

Function: message-send CH MSG
Package

jupyter

Source

message.lisp (file)

Function: more-parts CH MSG
Package

jupyter

Source

message.lisp (file)

Function: my-eval EXPR
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: my-read &optional INPUT-STREAM EOF-ERROR-P EOF-VALUE RECURSIVE-P
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: my-read VALUE
Package

jupyter-convert

Source

convert.lisp (file)

Function: normalize-symbol-case NAME
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: octets-to-hex-string BYTES
Package

jupyter

Source

mac.lisp (file)

Function: outside-closed-interval VALUE LEFT RIGHT
Package

jupyter-widgets

Source

shared-slots.lisp (file)

Function: outside-left-closed-interval VALUE LEFT RIGHT
Package

jupyter-widgets

Source

shared-slots.lisp (file)

Function: package-char-p CH
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: page RESULT &optional START
Package

jupyter

Source

kernel.lisp (file)

Function: prompt-and-read STREAM
Package

jupyter

Source

stdin.lisp (file)

Function: read-binary-part CH MSG
Package

jupyter

Source

message.lisp (file)

Function: read-history HISTORY
Package

jupyter

Source

history.lisp (file)

Function: read-raw-string STREAM C1 C2
Package

jupyter

Source

utils.lisp (file)

Function: read-string-part CH MSG
Package

jupyter

Source

message.lisp (file)

Function: recv-parts CH
Package

jupyter

Source

message.lisp (file)

Function: send-binary-part CH PART
Package

jupyter

Source

message.lisp (file)

Function: send-clear-output IOPUB PARENT-MSG WAIT
Package

jupyter

Source

iopub.lisp (file)

Function: send-comm-close-orphan IOPUB SESSION COMM-ID &optional DATA
Package

jupyter

Source

iopub.lisp (file)

Function: send-comm-info-reply SHELL PARENT-MSG COMMS
Package

jupyter

Source

shell.lisp (file)

Function: send-complete-reply-error SHELL PARENT-MSG ENAME EVALUE
Package

jupyter

Source

shell.lisp (file)

Function: send-complete-reply-ok SHELL PARENT-MSG MATCHES START END
Package

jupyter

Source

shell.lisp (file)

Function: send-display-data IOPUB PARENT-MSG DATA
Package

jupyter

Source

iopub.lisp (file)

Function: send-execute-code IOPUB PARENT-MSG EXECUTION-COUNT CODE
Package

jupyter

Source

iopub.lisp (file)

Function: send-execute-error IOPUB PARENT-MSG EXECUTION-COUNT ENAME EVALUE
Package

jupyter

Source

iopub.lisp (file)

Function: send-execute-reply-error SHELL PARENT-MSG EXECUTION-COUNT ENAME EVALUE
Package

jupyter

Source

shell.lisp (file)

Function: send-execute-reply-ok SHELL PARENT-MSG EXECUTION-COUNT PAYLOAD
Package

jupyter

Source

shell.lisp (file)

Function: send-execute-result IOPUB PARENT-MSG EXECUTION-COUNT DATA
Package

jupyter

Source

iopub.lisp (file)

Function: send-history-reply SHELL PARENT-MSG HISTORY
Package

jupyter

Source

shell.lisp (file)

Function: send-input-request STDIN PARENT-MSG PROMPT
Package

jupyter

Source

stdin.lisp (file)

Function: send-inspect-reply-error SHELL PARENT-MSG ENAME EVALUE
Package

jupyter

Source

shell.lisp (file)

Function: send-inspect-reply-ok SHELL PARENT-MSG DATA
Package

jupyter

Source

shell.lisp (file)

Function: send-is-complete-reply SHELL PARENT-MSG STATUS
Package

jupyter

Source

shell.lisp (file)

Function: send-parts CH IDENTITIES BODY BUFFERS
Package

jupyter

Source

message.lisp (file)

Function: send-shutdown-reply SHELL PARENT-MSG RESTART
Package

jupyter

Source

shell.lisp (file)

Function: send-state W &optional NAME
Package

jupyter-widgets

Source

widget.lisp (file)

Function: send-status IOPUB SESSION STATUS
Package

jupyter

Source

iopub.lisp (file)

Function: send-status-update IOPUB PARENT-MSG STATUS
Package

jupyter

Source

iopub.lisp (file)

Function: send-stream IOPUB PARENT-MSG STREAM-NAME DATA
Package

jupyter

Source

iopub.lisp (file)

Function: send-string-part CH PART
Package

jupyter

Source

message.lisp (file)

Function: set-next-input TEXT &optional REPLACE
Package

jupyter

Source

kernel.lisp (file)

Function: sexpr-to-text VALUE
Package

jupyter

Source

results.lisp (file)

Function: split-qualified-name NAME
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: string-match-p VALUE PATTERN
Package

jupyter

Source

history.lisp (file)

Function: symbol-char-p C
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: symbol-name-to-qualified-name NAME PACKAGE-NAME PACKAGE
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: symbol-string-at-position VALUE POS
Package

common-lisp-jupyter

Source

cl-kernel.lisp (file)

Function: symbol-to-key S
Package

jupyter-widgets

Source

widget.lisp (file)

Function: update-state W DATA BUFFERS
Package

jupyter-widgets

Source

widget.lisp (file)

Function: widget-registry-name MODEL-MODULE MODEL-MODULE-VERSION MODEL-NAME VIEW-MODULE VIEW-MODULE-VERSION VIEW-NAME
Package

jupyter-widgets

Source

widget.lisp (file)

Function: write-history HISTORY
Package

jupyter

Source

history.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Generic functions

Generic Function: cell-markdown OBJECT
Generic Function: (setf cell-markdown) NEW-VALUE OBJECT
Package

jupyter-convert

Methods
Method: cell-markdown (CELL cell)

automatically generated reader method

Source

convert.lisp (file)

Method: (setf cell-markdown) NEW-VALUE (CELL cell)

automatically generated writer method

Source

convert.lisp (file)

Generic Function: cell-source OBJECT
Generic Function: (setf cell-source) NEW-VALUE OBJECT
Package

jupyter-convert

Methods
Method: cell-source (CELL cell)

automatically generated reader method

Source

convert.lisp (file)

Method: (setf cell-source) NEW-VALUE (CELL cell)

automatically generated writer method

Source

convert.lisp (file)

Generic Function: channel-ip OBJECT
Package

jupyter

Methods
Method: channel-ip (CHANNEL channel)

Channel IP address

Source

channel.lisp (file)

Generic Function: channel-mac OBJECT
Package

jupyter

Methods
Method: channel-mac (CHANNEL channel)

Shared channel authentification handler.

Source

channel.lisp (file)

Generic Function: channel-port OBJECT
Package

jupyter

Methods
Method: channel-port (CHANNEL channel)

Channel port number

Source

channel.lisp (file)

Generic Function: channel-recv-lock OBJECT
Package

jupyter

Methods
Method: channel-recv-lock (CHANNEL channel)

Lock used during recv actions

Source

channel.lisp (file)

Generic Function: channel-send-lock OBJECT
Package

jupyter

Methods
Method: channel-send-lock (CHANNEL channel)

Lock used during send actions

Source