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 3.0 "Montgomery Scott" on Mon Apr 19 15:44:15 2021 GMT+0.


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

1 Introduction

common-lisp-jupyter

Binder 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

Install Quicklisp and use (ql:add-to-init-file). If you already have Quicklisp installed you may need to update your distribution with (ql:update-dist "quicklisp") to resolve package conflicts.

Installing via Quicklisp [version 20190521 and earlier]

Install Quicklisp and use (ql:add-to-init-file). If you already have Quicklisp installed you may need to update your distribution with (ql:update-dist "quicklisp") to resolve package conflicts.

Start your Lisp implementation and evaluate the following. The install command will try to deduce the correct command line arguments for your implementation. The keyword parameters :bin-path and :ev-flag can be used to customize these arguments. For example, for SBCL :bin-path is sbcl and :ev-flag is --eval. To install a kernel image using uiop:dump-image use cl-jupyter:install-image instead of cl-jupyter:install. install-image takes no arguments.

(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

Home Page

https://yitzchak.github.io/common-lisp-jupyter/

Bug Tracker

https://github.com/yitzchak/common-lisp-jupyter/issues

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/

Components

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

3.2 common-lisp-jupyter/res/ccl

Parent

res (module)

Location

res/ccl/

Component

logo-64x64.png (file)


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

3.3 common-lisp-jupyter/res/cl

Parent

res (module)

Location

res/cl/

Component

logo-64x64.png (file)


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

3.4 common-lisp-jupyter/res/clisp

Parent

res (module)

Location

res/clisp/

Component

logo-64x64.png (file)


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

3.5 common-lisp-jupyter/res/ecl

Parent

res (module)

Location

res/ecl/

Component

logo-64x64.png (file)


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

3.6 common-lisp-jupyter/res/sbcl

Parent

res (module)

Location

res/sbcl/

Component

logo-64x64.png (file)


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

3.7 common-lisp-jupyter/src

Parent

common-lisp-jupyter (system)

Location

src/

Components

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

3.8 common-lisp-jupyter/src/formatters

Dependency

comm.lisp (file)

Parent

src (module)

Location

src/formatters/

Component

markdown.lisp (file)


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

3.9 common-lisp-jupyter/src/widgets

Dependency

formatters (module)

Parent

src (module)

Location

src/widgets/

Components

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

3.10 common-lisp-jupyter/src/cl-jupyter

Dependency

installer.lisp (file)

Parent

src (module)

Location

src/cl-jupyter/

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

make-uuid (function)

Internal Definitions

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

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

Dependency

utils.lisp (file)

Parent

src (module)

Location

src/queue.lisp

Internal Definitions

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

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

Dependency

queue.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.6 common-lisp-jupyter/src/log.lisp

Dependency

config.lisp (file)

Parent

src (module)

Location

src/log.lisp

Exported Definitions
Internal Definitions

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

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

Dependency

log.lisp (file)

Parent

src (module)

Location

src/mac.lisp

Exported Definitions
Internal Definitions

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

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

Dependency

mac.lisp (file)

Parent

src (module)

Location

src/channel.lisp

Exported Definitions
Internal Definitions

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

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

Dependency

channel.lisp (file)

Parent

src (module)

Location

src/heartbeat.lisp

Exported Definitions

start (method)

Internal Definitions

hb-channel (class)


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

4.1.10 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.11 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.12 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.13 common-lisp-jupyter/src/control.lisp

Dependency

stdin.lisp (file)

Parent

src (module)

Location

src/control.lisp

Internal Definitions

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

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

Dependency

control.lisp (file)

Parent

src (module)

Location

src/iopub.lisp

Internal Definitions

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

4.1.15 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.16 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.17 common-lisp-jupyter/src/formatters/markdown.lisp

Parent

formatters (module)

Location

src/formatters/markdown.lisp

Exported Definitions
Internal Definitions

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

4.1.18 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.19 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.20 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.21 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.22 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.23 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.24 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.25 common-lisp-jupyter/src/widgets/combobox.lisp

Dependency

checkbox.lisp (file)

Parent

widgets (module)

Location

src/widgets/combobox.lisp

Exported Definitions

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

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

Dependency

combobox.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.27 common-lisp-jupyter/src/widgets/button.lisp

Dependency

box.lisp (file)

Parent

widgets (module)

Location

src/widgets/button.lisp

Exported Definitions
Internal Definitions

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

4.1.28 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.29 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.30 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.31 common-lisp-jupyter/src/widgets/file-upload.lisp

Dependency

date-picker.lisp (file)

Parent

widgets (module)

Location

src/widgets/file-upload.lisp

Exported Definitions
Internal Definitions

file-upload-value-notify (function)


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

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

Dependency

file-upload.lisp (file)

Parent

widgets (module)

Location

src/widgets/label.lisp

Exported Definitions

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

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

Dependency

label.lisp (file)

Parent

widgets (module)

Location

src/widgets/link.lisp

Exported Definitions
Internal Definitions

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

4.1.34 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.35 common-lisp-jupyter/src/widgets/output.lisp

Dependency

media.lisp (file)

Parent

widgets (module)

Location

src/widgets/output.lisp

Exported Definitions
Internal Definitions

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

4.1.36 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.37 common-lisp-jupyter/src/widgets/select.lisp

Dependency

progress.lisp (file)

Parent

widgets (module)

Location

src/widgets/select.lisp

Exported Definitions
Internal Definitions

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

4.1.38 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.39 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.40 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.41 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.42 common-lisp-jupyter/src/widgets/interactive.lisp

Dependency

valid.lisp (file)

Parent

widgets (module)

Location

src/widgets/interactive.lisp

Exported Definitions
Internal Definitions

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

4.1.43 common-lisp-jupyter/src/widgets/register-widgets.lisp

Dependency

interactive.lisp (file)

Parent

widgets (module)

Location

src/widgets/register-widgets.lisp

Exported Definitions

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

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

Dependency

widgets (module)

Parent

src (module)

Location

src/history.lisp

Exported Definitions
Internal Definitions

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

4.1.45 common-lisp-jupyter/src/matches.lisp

Dependency

history.lisp (file)

Parent

src (module)

Location

src/matches.lisp

Exported Definitions
Internal Definitions

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

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

Dependency

matches.lisp (file)

Parent

src (module)

Location

src/kernel.lisp

Exported Definitions
Internal Definitions

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

4.1.47 common-lisp-jupyter/src/installer.lisp

Dependency

kernel.lisp (file)

Parent

src (module)

Location

src/installer.lisp

Exported Definitions
Internal Definitions

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

4.1.48 common-lisp-jupyter/src/cl-jupyter/utils.lisp

Parent

cl-jupyter (module)

Location

src/cl-jupyter/utils.lisp

Internal Definitions

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

4.1.49 common-lisp-jupyter/src/cl-jupyter/parser.lisp

Dependency

utils.lisp (file)

Parent

cl-jupyter (module)

Location

src/cl-jupyter/parser.lisp

Internal Definitions

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

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

Dependency

parser.lisp (file)

Parent

cl-jupyter (module)

Location

src/cl-jupyter/kernel.lisp

Exported Definitions
Internal Definitions

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

4.1.51 common-lisp-jupyter/src/cl-jupyter/complete.lisp

Dependency

kernel.lisp (file)

Parent

cl-jupyter (module)

Location

src/cl-jupyter/complete.lisp

Exported Definitions
Internal Definitions

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

4.1.52 common-lisp-jupyter/src/cl-jupyter/inspect.lisp

Dependency

complete.lisp (file)

Parent

cl-jupyter (module)

Location

src/cl-jupyter/inspect.lisp

Exported Definitions

inspect-code (method)

Internal Definitions

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

4.1.53 common-lisp-jupyter/src/cl-jupyter/installer.lisp

Dependency

inspect.lisp (file)

Parent

cl-jupyter (module)

Location

src/cl-jupyter/installer.lisp

Exported Definitions
Internal Definitions

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

4.1.54 common-lisp-jupyter/src/cl-jupyter/overrides.lisp

Dependency

installer.lisp (file)

Parent

cl-jupyter (module)

Location

src/cl-jupyter/overrides.lisp


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

4.1.55 common-lisp-jupyter/src/cl-jupyter/ros-install.lisp

Dependency

overrides.lisp (file)

Parent

cl-jupyter (module)

Location

src/cl-jupyter/ros-install.lisp


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

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

Dependency

cl-jupyter (module)

Parent

src (module)

Location

src/convert.lisp

Exported Definitions

to-notebook (function)

Internal Definitions

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

4.2 Static


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

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

Parent

ccl (module)

Location

res/ccl/logo-64x64.png


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

4.2.2 common-lisp-jupyter/res/cl/logo-64x64.png

Parent

cl (module)

Location

res/cl/logo-64x64.png


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

4.2.3 common-lisp-jupyter/res/clisp/logo-64x64.png

Parent

clisp (module)

Location

res/clisp/logo-64x64.png


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

4.2.4 common-lisp-jupyter/res/ecl/logo-64x64.png

Parent

ecl (module)

Location

res/ecl/logo-64x64.png


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

4.2.5 common-lisp-jupyter/res/sbcl/logo-64x64.png

Parent

sbcl (module)

Location

res/sbcl/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

Provides Common Lisp kernel support.

Source

packages.lisp (file)

Nicknames
Use List
Exported Definitions
Internal Definitions

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

5.2 jupyter-widgets

Package for core Jupyter Widget support.

Source

packages.lisp (file)

Nickname

jw

Use List
Exported Definitions
Internal Definitions

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

5.3 jupyter-convert

Provides LISP source code conversion to notebooks.

Source

packages.lisp (file)

Use List
Exported Definitions

to-notebook (function)

Internal Definitions

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

5.4 jupyter

Core package for Jupyter support including kernel and installer abstract classes.

Source

packages.lisp (file)

Nickname

j

Use List
Exported Definitions
Internal Definitions

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

5.5 jupyter/markdown-formatter

Various format extensions for markdown

Source

packages.lisp (file)

Nickname

mdf

Use List

common-lisp

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: *debugger*
Package

jupyter

Source

kernel.lisp (file)

Special Variable: *indent-level*
Package

jupyter/markdown-formatter

Source

markdown.lisp (file)

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: debugging-errors &body BODY
Package

jupyter

Source

kernel.lisp (file)

Macro: handling-errors &body BODY

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

Package

jupyter

Source

kernel.lisp (file)

Macro: make-interactive-alist SCHEMAS PLACE &key KEY TEST OWNER NAME
Package

jupyter-widgets

Source

interactive.lisp (file)

Macro: make-interactive-hash-table SCHEMAS PLACE &key OWNER NAME
Package

jupyter-widgets

Source

interactive.lisp (file)

Macro: make-interactive-plist SCHEMAS PLACE &key OWNER NAME
Package

jupyter-widgets

Source

interactive.lisp (file)

Macro: register-widgets &rest NAMES
Package

jupyter-widgets

Source

widget.lisp (file)

Macro: with-output OUTPUT &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: code STREAM VALUE COLON AT &rest ARGS
Package

jupyter/markdown-formatter

Source

markdown.lisp (file)

Function: display WIDGET &rest ARGS &key &allow-other-keys
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 USE-IMPLEMENTATION SYSTEM BUNDLE LOCAL PREFIX ROOT

Install Common Lisp kernel based on the current implementation.
- ‘bin-path‘ specifies path to LISP binary.
- ‘use-implementation‘ toggles including implementation details in kernel name.
- ‘system‘ toggles system versus user installation.
- ‘bundle‘ creates a quicklisp bundle for system installations.
- ‘local‘ toggles ‘/usr/local/share versus‘ ‘/usr/share‘ for system installations.
- ‘prefix‘ key specifies directory prefix for packaging.
- ‘root‘ key specifies the root under which the Jupyter folder is found. Is automatically determined if not provided.

Package

common-lisp-jupyter

Source

installer.lisp (file)

Function: install-image &key USE-IMPLEMENTATION PREFIX ROOT

Install Common Lisp kernel based on image of current implementation.
- ‘use-implementation‘ toggles including implementation details in kernel name.
- ‘prefix‘ key specifies directory prefix for packaging.
- ‘root‘ key specifies the root under which the Jupyter folder is found. Is automatically determined if not provided.

Package

common-lisp-jupyter

Source

installer.lisp (file)

Function: install-roswell &key IMPLEMENTATION

Install Common Lisp kernel using Roswell. ‘implementation‘ key toggles including implementation details in kernel name.

Package

common-lisp-jupyter

Source

installer.lisp (file)

Function: installer-path INSTANCE &rest PARTS

Resolve each of the path parts then combine all into a single path using merge-pathnames.

Package

jupyter

Source

installer.lisp (file)

Function: javascript VALUE &optional DISPLAY-DATA

Create a JavaScript text result based on an inline value.

Package

jupyter

Source

results.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: latex VALUE &optional DISPLAY-DATA

Create a LaTeX result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: make-accordion &rest INITARGS &key LAYOUT BOX-STYLE CHILDREN SELECTED-INDEX &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-audio &rest INITARGS &key VALUE FORMAT LAYOUT AUTOPLAY CONTROLS LOOP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-bounded-float-text &rest INITARGS &key MAX MIN VALUE STEP CONTINUOUS-UPDATE DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-bounded-int-text &rest INITARGS &key MAX MIN VALUE STEP CONTINUOUS-UPDATE DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-box &rest INITARGS &key LAYOUT BOX-STYLE CHILDREN &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-button &rest INITARGS &key TOOLTIP ICON DISABLED BUTTON-STYLE LAYOUT STYLE DESCRIPTION &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-button-style &rest INITARGS &key BUTTON-COLOR FONT-WEIGHT &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-checkbox &rest INITARGS &key VALUE DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP INDENT &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-color-picker &rest INITARGS &key DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP CONCISE VALUE &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-combobox &rest INITARGS &key VALUE PLACEHOLDER DISABLED CONTINUOUS-UPDATE LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP ENSURE-OPTION OPTIONS &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-controller &rest INITARGS &key LAYOUT AXES BUTTONS CONNECTED INDEX MAPPING NAME TIMESTAMP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-controller-axis &rest INITARGS &key VALUE LAYOUT &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-controller-button &rest INITARGS &key VALUE LAYOUT PRESSED &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-date-picker &rest INITARGS &key DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP VALUE &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-description-style &rest INITARGS &key DESCRIPTION-WIDTH &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-dropdown &rest INITARGS &key INDEX DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP ROWS OPTIONS &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.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-file-upload &rest INITARGS &key ICON DISABLED BUTTON-STYLE LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP ACCEPT DATA ERROR METADATA MULTIPLE &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-float-log-slider &rest INITARGS &key VALUE STEP MAX MIN CONTINUOUS-UPDATE ORIENTATION DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP READOUT READOUT-FORMAT BASE &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-float-progress &rest INITARGS &key VALUE MAX MIN ORIENTATION LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP BAR-STYLE &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-float-range-slider &rest INITARGS &key STEP MAX MIN CONTINUOUS-UPDATE ORIENTATION DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP READOUT READOUT-FORMAT VALUE &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-float-slider &rest INITARGS &key VALUE STEP MAX MIN CONTINUOUS-UPDATE ORIENTATION DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP READOUT READOUT-FORMAT &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-float-text &rest INITARGS &key VALUE STEP CONTINUOUS-UPDATE DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-grid-box &rest INITARGS &key LAYOUT BOX-STYLE CHILDREN &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-h-box &rest INITARGS &key LAYOUT BOX-STYLE CHILDREN &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-html &rest INITARGS &key VALUE PLACEHOLDER LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-html-math &rest INITARGS &key VALUE PLACEHOLDER LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-image &rest INITARGS &key VALUE WIDTH HEIGHT FORMAT LAYOUT &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.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-int-progress &rest INITARGS &key VALUE MAX MIN ORIENTATION LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP BAR-STYLE &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-int-range-slider &rest INITARGS &key STEP MAX MIN CONTINUOUS-UPDATE ORIENTATION DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP READOUT READOUT-FORMAT VALUE &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-int-slider &rest INITARGS &key VALUE STEP MAX MIN CONTINUOUS-UPDATE ORIENTATION DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP READOUT READOUT-FORMAT &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-int-text &rest INITARGS &key VALUE STEP CONTINUOUS-UPDATE DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-label &rest INITARGS &key VALUE PLACEHOLDER LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-layout &rest INITARGS &key ALIGN-CONTENT ALIGN-ITEMS ALIGN-SELF BORDER BOTTOM DISPLAY FLEX FLEX-FLOW GRID-AREA GRID-AUTO-COLUMNS GRID-AUTO-FLOW GRID-AUTO-ROWS GRID-COLUMN GRID-GAP GRID-ROW GRID-TEMPLATE-AREAS GRID-TEMPLATE-COLUMNS GRID-TEMPLATE-ROWS HEIGHT JUSTIFY-CONTENT JUSTIFY-ITEMS LEFT MARGIN MAX-HEIGHT MAX-WIDTH MIN-HEIGHT MIN-WIDTH OBJECT-FIT OBJECT-POSITION ORDER OVERFLOW OVERFLOW-X OVERFLOW-Y PADDING RIGHT TOP VISIBILITY WIDTH &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Package

jupyter-widgets

Source

register-widgets.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-offset-match-set &key (PARENT PARENT) (OFFSET OFFSET)
Package

jupyter

Source

matches.lisp (file)

Function: make-output &rest INITARGS &key LAYOUT MSG-ID OUTPUTS &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-password &rest INITARGS &key VALUE PLACEHOLDER CONTINUOUS-UPDATE DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-play &rest INITARGS &key VALUE STEP MAX MIN DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP INTERVAL SHOW-REPEAT &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-progress-style &rest INITARGS &key DESCRIPTION-WIDTH BAR-COLOR &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-radio-buttons &rest INITARGS &key INDEX DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP ROWS OPTIONS &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-select &rest INITARGS &key INDEX DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP ROWS OPTIONS &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-select-multiple &rest INITARGS &key DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP ROWS INDEX OPTIONS &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-selection-range-slider &rest INITARGS &key CONTINUOUS-UPDATE ORIENTATION DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP READOUT READOUT-FORMAT OPTIONS INDEX &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-selection-slider &rest INITARGS &key INDEX CONTINUOUS-UPDATE ORIENTATION DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP READOUT READOUT-FORMAT OPTIONS &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-slider-style &rest INITARGS &key DESCRIPTION-WIDTH HANDLE-COLOR &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-tab &rest INITARGS &key LAYOUT BOX-STYLE CHILDREN SELECTED-INDEX &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-text &rest INITARGS &key VALUE PLACEHOLDER CONTINUOUS-UPDATE DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-text-area &rest INITARGS &key VALUE PLACEHOLDER CONTINUOUS-UPDATE DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP ROWS &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-toggle-button &rest INITARGS &key VALUE TOOLTIP ICON DISABLED BUTTON-STYLE LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-toggle-buttons &rest INITARGS &key INDEX DISABLED BUTTON-STYLE LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP ICONS OPTIONS TOOLTIPS &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-toggle-buttons-style &rest INITARGS &key BUTTON-WIDTH DESCRIPTION-WIDTH FONT-WEIGHT &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-uuid &optional AS-BYTES
Package

jupyter

Source

utils.lisp (file)

Function: make-v-box &rest INITARGS &key LAYOUT BOX-STYLE CHILDREN &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-valid &rest INITARGS &key VALUE DISABLED LAYOUT STYLE DESCRIPTION DESCRIPTION-TOOLTIP READOUT &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: make-video &rest INITARGS &key WIDTH HEIGHT VALUE FORMAT LAYOUT AUTOPLAY CONTROLS LOOP &allow-other-keys
Package

jupyter-widgets

Source

register-widgets.lisp (file)

Function: markdown VALUE &optional DISPLAY-DATA

Create a Markdown result based on an inline value.

Package

jupyter

Source

results.lisp (file)

Function: notify-trait-change OBJECT TYPE NAME OLD-VALUE NEW-VALUE &optional SOURCE
Package

jupyter-widgets

Source

traits.lisp (file)

Function: observe INSTANCE NAME/S HANDLER
Package

jupyter-widgets

Source

widget.lisp (file)

Function: on-button-click WIDGET HANDLER
Package

jupyter-widgets

Source

button.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: pre STREAM VALUE COLON AT &rest ARGS
Package

jupyter/markdown-formatter

Source

markdown.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 &optional KEEP-KERNEL
Package

jupyter

Source

kernel.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-custom WIDGET CONTENT &optional BUFFERS
Package

jupyter-widgets

Source

widget.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: text STREAM VALUE COLON AT &rest ARGS
Package

jupyter/markdown-formatter

Source

markdown.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: %display WIDGET &rest ARGS &key &allow-other-keys

Prepare widget for display

Package

jupyter-widgets

Source

widget.lisp (file)

Methods
Method: %display WIDGET &rest ARGS &key &allow-other-keys
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

complete.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: command-line INSTANCE

Get the command line for an installer instance.

Package

jupyter

Source

installer.lisp (file)

Methods
Method: command-line (INSTANCE user-roswell-installer)

Get the command line for a roswell installation.

Source

installer.lisp (file)

Method: command-line (INSTANCE system-bundle-installer)

Get the command line for a system bundle installation.

Source

installer.lisp (file)

Method: command-line (INSTANCE system-installer)

Get the command line for a user installation.

Source

installer.lisp (file)

Method: command-line (INSTANCE user-installer)

Get the command line for a user installation.

Source

installer.lisp (file)

Method: command-line (INSTANCE user-image-installer)

Get the command for a user image installer.

Generic Function: complete-code KERNEL MATCH-SET CODE CURSOR-POS

Complete code at cursor-pos. Successful matches should be added to match-set via match-set-add.

Package

jupyter

Source

kernel.lisp (file)

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

complete.lisp (file)

Method: complete-code KERNEL MATCH-SET 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

Create a link between traits in the client if possible

Package

jupyter-widgets

Source

link.lisp (file)

Methods
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

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

inspect.lisp (file)

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

Install a kernel based on an installer instance.

Package

jupyter

Source

installer.lisp (file)

Methods
Method: install (INSTANCE system-bundle-installer)

Install system bundle kernel.

Method: install (INSTANCE system-installer)

Install system kernel.

Method: install (INSTANCE user-installer)

Install user kernel.

Method: install (INSTANCE user-image-installer)

Create an image for the user image based kernels.

Method: install (INSTANCE installer) before

Do common installation tasks before the specific ones association with this instance.

Generic Function: installer-class OBJECT
Generic Function: (setf installer-class) NEW-VALUE OBJECT
Package

jupyter

Methods
Method: installer-class (INSTALLER installer)
Method: (setf installer-class) NEW-VALUE (INSTALLER installer)

Class that implements the kernel. Used by image based installations.

Source

installer.lisp (file)

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

jupyter

Methods
Method: installer-display-name (INSTALLER installer)
Method: (setf installer-display-name) NEW-VALUE (INSTALLER installer)

Name of the kernel displayed to the user.

Source

installer.lisp (file)

Generic Function: installer-implementation OBJECT
Generic Function: (setf installer-implementation) NEW-VALUE OBJECT
Package

jupyter

Methods
Method: installer-implementation (INSTALLER installer)
Method: (setf installer-implementation) NEW-VALUE (INSTALLER installer)

Path to specific binary used by the kernel.

Source

installer.lisp (file)

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

jupyter

Methods
Method: installer-kernel-name (INSTALLER installer)
Method: (setf installer-kernel-name) NEW-VALUE (INSTALLER installer)

Name of the kernel.

Source

installer.lisp (file)

Generic Function: installer-language OBJECT
Generic Function: (setf installer-language) NEW-VALUE OBJECT
Package

jupyter

Methods
Method: installer-language (INSTALLER installer)
Method: (setf installer-language) NEW-VALUE (INSTALLER installer)

Language that the kernel supports.

Source

installer.lisp (file)

Generic Function: installer-local OBJECT
Generic Function: (setf installer-local) NEW-VALUE OBJECT
Package

jupyter

Methods
Method: installer-local (INSTALLER installer)
Method: (setf installer-local) NEW-VALUE (INSTALLER installer)

Is the installation a local or packaged installation?

Source

installer.lisp (file)

Generic Function: installer-local-systems OBJECT
Generic Function: (setf installer-local-systems) NEW-VALUE OBJECT
Package

jupyter

Methods
Method: installer-local-systems (INSTALLER installer)
Method: (setf installer-local-systems) NEW-VALUE (INSTALLER installer)

List of systems to package into local-projects.

Source

installer.lisp (file)

Generic Function: installer-prefix OBJECT
Generic Function: (setf installer-prefix) NEW-VALUE OBJECT
Package

jupyter

Methods
Method: installer-prefix (INSTALLER installer)
Method: (setf installer-prefix) NEW-VALUE (INSTALLER installer)

Directory to put installed files into. Used by packaging system, should be nil otherwise.

Source

installer.lisp (file)

Generic Function: installer-resources OBJECT
Generic Function: (setf installer-resources) NEW-VALUE OBJECT
Package

jupyter

Methods
Method: installer-resources (INSTALLER installer)
Method: (setf installer-resources) NEW-VALUE (INSTALLER installer)

List of paths of resource files such as icons.

Source

installer.lisp (file)

Generic Function: installer-systems OBJECT
Generic Function: (setf installer-systems) NEW-VALUE OBJECT
Package

jupyter

Methods
Method: installer-systems (INSTALLER installer)
Method: (setf installer-systems) NEW-VALUE (INSTALLER installer)

List of systems to bundle for system installs.

Source

installer.lisp (file)

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)

Create a link between traits in the client if possible

Package

jupyter-widgets

Source

link.lisp (file)

Methods
Generic Function: match-set-add INSTANCE TEXT START END &key TYPE
Package

jupyter

Source

matches.lisp (file)

Methods
Method: match-set-add (MS offset-match-set) TEXT START END &key TYPE
Method: match-set-add (MS match-set) TEXT START END &key TYPE
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 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-custom-message WIDGET CONTENT BUFFERS
Package

jupyter-widgets

Source

widget.lisp (file)

Methods
Method: on-custom-message (W button) CONTENT BUFFERS
Source

button.lisp (file)

Method: on-custom-message WIDGET CONTENT BUFFERS
Generic Function: on-trait-change OBJECT TYPE NAME OLD-VALUE NEW-VALUE SOURCE
Package

jupyter-widgets

Source

traits.lisp (file)

Methods
Method: on-trait-change (INSTANCE toggle-buttons) TYPE (NAME (eql index)) OLD-VALUE NEW-VALUE SOURCE after
Source

toggle-button.lisp (file)

Method: on-trait-change (INSTANCE selection-slider) TYPE (NAME (eql index)) OLD-VALUE NEW-VALUE SOURCE after
Source

slider.lisp (file)

Method: on-trait-change (INSTANCE selection-range-slider) TYPE (NAME (eql index)) OLD-VALUE NEW-VALUE SOURCE after
Source

slider.lisp (file)

Method: on-trait-change (INSTANCE select-multiple) TYPE (NAME (eql index)) OLD-VALUE NEW-VALUE SOURCE after
Source

select.lisp (file)

Method: on-trait-change (INSTANCE select) TYPE (NAME (eql index)) OLD-VALUE NEW-VALUE SOURCE after
Source

select.lisp (file)

Method: on-trait-change (INSTANCE file-upload) TYPE (NAME (eql metadata)) OLD-VALUE NEW-VALUE SOURCE after
Source

file-upload.lisp (file)

Method: on-trait-change (INSTANCE file-upload) TYPE (NAME (eql data)) OLD-VALUE NEW-VALUE SOURCE after
Source

file-upload.lisp (file)

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

widget.lisp (file)

Method: on-trait-change (W has-traits) TYPE NAME OLD-VALUE NEW-VALUE SOURCE after
Method: on-trait-change OBJECT TYPE NAME OLD-VALUE NEW-VALUE SOURCE
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 (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: start CH

Start the resource.

Package

jupyter

Source

channel.lisp (file)

Methods
Method: start (K kernel) after
Source

kernel.lisp (file)

Method: start (K kernel)
Source

kernel.lisp (file)

Method: start (H history)
Source

history.lisp (file)

Method: start (HB hb-channel) after
Source

heartbeat.lisp (file)

Method: start (CH channel)
Method: start (M mac)
Source

mac.lisp (file)

Method: start (L sink)
Source

log.lisp (file)

Generic Function: stop CH

Stop the resource.

Package

jupyter

Source

channel.lisp (file)

Methods
Method: stop (K kernel)
Source

kernel.lisp (file)

Method: stop (H history)
Source

history.lisp (file)

Method: stop (CH channel)
Method: stop (CH channel) before
Method: stop (M mac)
Source

mac.lisp (file)

Method: stop (L sink)
Source

log.lisp (file)

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-accept OBJECT
Generic Function: (setf widget-accept) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-accept (FILE-UPLOAD file-upload)
Method: (setf widget-accept) NEW-VALUE (FILE-UPLOAD file-upload)

If set, ensure value is in options. Implies continuous_update=False. File types to accept, empty string for all.

Source

file-upload.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-data OBJECT
Generic Function: (setf widget-data) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-data (FILE-UPLOAD file-upload)
Method: (setf widget-data) NEW-VALUE (FILE-UPLOAD file-upload)

List of file content (bytes)

Source

file-upload.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-ensure-option OBJECT
Generic Function: (setf widget-ensure-option) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-ensure-option (COMBOBOX combobox)
Method: (setf widget-ensure-option) NEW-VALUE (COMBOBOX combobox)

If set, ensure value is in options. Implies continuous_update=False.

Source

combobox.lisp (file)

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

jupyter-widgets

Methods
Method: widget-error (FILE-UPLOAD file-upload)
Method: (setf widget-error) NEW-VALUE (FILE-UPLOAD file-upload)

Error message

Source

file-upload.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-auto-rows OBJECT
Generic Function: (setf widget-grid-auto-rows) NEW-VALUE OBJECT
Package

jupyter-widgets

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

The grid-auto-rows 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-row OBJECT
Generic Function: (setf widget-grid-row) NEW-VALUE OBJECT
Package

jupyter-widgets

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

The grid-row 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-justify-items OBJECT
Generic Function: (setf widget-justify-items) NEW-VALUE OBJECT
Package

jupyter-widgets

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

The justify-items 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-metadata OBJECT
Generic Function: (setf widget-metadata) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-metadata (FILE-UPLOAD file-upload)
Method: (setf widget-metadata) NEW-VALUE (FILE-UPLOAD file-upload)

List of file metadata

Source

file-upload.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-multiple OBJECT
Generic Function: (setf widget-multiple) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-multiple (FILE-UPLOAD file-upload)
Method: (setf widget-multiple) NEW-VALUE (FILE-UPLOAD file-upload)

If True, allow for multiple files upload

Source

file-upload.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-object-fit OBJECT
Generic Function: (setf widget-object-fit) NEW-VALUE OBJECT
Package

jupyter-widgets

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

The object-fit CSS attribute.

Source

dom-widget.lisp (file)

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

jupyter-widgets

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

The object-position CSS attribute.

Source

dom-widget.lisp (file)

Generic Function: widget-on-trait-change OBJECT
Generic Function: (setf widget-on-trait-change) NEW-VALUE OBJECT
Package

jupyter-widgets

Methods
Method: widget-on-trait-change (HAS-TRAITS has-traits)
Method: (setf widget-on-trait-change) NEW-VALUE (HAS-TRAITS has-traits)

Instance specific trait notification

Source

traits.lisp (file)

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

jupyter-widgets

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

The option values that correspond to the labels

Source

toggle-button.lisp (file)

Method: widget-options (LABEL-SLIDER label-slider)
Method: (setf widget-options) NEW-VALUE (LABEL-SLIDER label-slider)

The option values that correspond to the labels

Source

slider.lisp (file)

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

The option values that correspond to the labels

Source

select.lisp (file)

Method: widget-options (SELECT select)
Method: (setf widget-options) NEW-VALUE (SELECT select)

The option values that correspond to the labels

Source

select.lisp (file)

Method: widget-options (COMBOBOX combobox)
Method: (setf widget-options) NEW-VALUE (COMBOBOX combobox)

Dropdown options for the combobox

Source

combobox.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 (INSTANCE toggle-buttons)
Method: (setf widget-value) NEW-VALUE (INSTANCE toggle-buttons)
Source

toggle-button.lisp (file)

Method: widget-value (INSTANCE selection-slider)
Method: (setf widget-value) NEW-VALUE (INSTANCE selection-slider)
Source

slider.lisp (file)

Method: widget-value (INSTANCE selection-range-slider)
Method: (setf widget-value) NEW-VALUE (INSTANCE selection-range-slider)
Source

slider.lisp (file)

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 (INSTANCE select-multiple)
Method: (setf widget-value) NEW-VALUE (INSTANCE select-multiple)
Source

select.lisp (file)

Method: widget-value (INSTANCE select)
Method: (setf widget-value) NEW-VALUE (INSTANCE select)
Source

select.lisp (file)

Method: widget-value (INSTANCE file-upload)
Source

file-upload.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

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-instance ’html :value "<em>Box Example</em>")) (defvar slider (make-instance ’int-slider))
(make-instance ’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)

Slot: on-click
Initargs

:on-click

Readers

widget-on-click (generic function)

Writers

(setf widget-on-click) (generic function)

Direct Default Initargs
InitargValue
:%model-name"buttonmodel"
:%view-name"buttonview"
:style(make-instance (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: combobox ()
Package

jupyter-widgets

Source

combobox.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: ensure-option

If set, ensure value is in options. Implies continuous_update=False.

Initargs

:ensure-option

Initform

t

Readers

widget-ensure-option (generic function)

Writers

(setf widget-ensure-option) (generic function)

Slot: options

Dropdown options for the combobox

Initargs

:options

Readers

widget-options (generic function)

Writers

(setf widget-options) (generic function)

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

jupyter

Source

comm.lisp (file)

Direct superclasses

source (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)

Direct Default Initargs
InitargValue
:sink(when jupyter::*kernel* (jupyter::source-sink jupyter::*kernel*))
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

(make-instance (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

select.lisp (file)

Direct superclasses

select (class)

Direct Default Initargs
InitargValue
:%model-name"dropdownmodel"
:%view-name"dropdownview"
Class: file-upload ()
Package

jupyter-widgets

Source

file-upload.lisp (file)

Direct superclasses
Direct methods