Skip to main content Link Search Menu Expand Document (external link)

JUPYTER/WIDGETS

Package for core Jupyter Widget support.

Nicknames

jupyter-widgets, jw

Exports

accordion, audio, blur, bounded-float-text, bounded-int-text, box, button, button-style, checkbox, color-picker, combobox, controller, controller-axis, controller-button, date-picker, defwidget, description-style, directional-link, dom-widget, dropdown, file-upload, float-log-slider, float-progress, float-range-slider, float-slider, float-text, focus, grid-box, h-box, has-traits, html, html-math, image, int-progress, int-range-slider, int-slider, int-text, label, layout, link, make-accordion, make-audio, make-bounded-float-text, make-bounded-int-text, make-box, make-button, make-button-style, make-checkbox, make-color-picker, make-combobox, make-controller, make-controller-axis, make-controller-button, make-date-picker, make-description-style, make-directional-link, make-dropdown, make-file-upload, make-float-log-slider, make-float-progress, make-float-range-slider, make-float-slider, make-float-text, make-grid-box, make-h-box, make-html, make-html-math, make-image, make-int-progress, make-int-range-slider, make-int-slider, make-int-text, make-interactive-alist, make-interactive-hash-table, make-interactive-plist, make-label, make-layout, make-link, make-output, make-output-widget-stream, make-password, make-play, make-progress-style, make-radio-buttons, make-select, make-select-multiple, make-selection-range-slider, make-selection-slider, make-sidecar, make-slider-style, make-tab, make-text, make-text-area, make-toggle-button, make-toggle-buttons, make-toggle-buttons-style, make-v-box, make-valid, make-video, notify-trait-change, observe, on-button-click, on-custom-message, on-trait-change, output, password, play, progress-style, radio-buttons, register-widgets, select, select-multiple, selection-range-slider, selection-slider, send-custom, sidecar, slider-style, style, styled-widget, tab, text, text-area, toggle-button, toggle-button-style, toggle-buttons, trait-metaclass, v-box, valid, video, widget, widget-%dom-classes, widget-%module-module, widget-%module-module-version, widget-%module-name, widget-%options-labels, widget-%playing, widget-%repeat, widget-%titles, widget-%view-module, widget-%view-module-version, widget-%view-name, widget-accept, widget-align-content, widget-align-items, widget-align-self, widget-autoplay, widget-axes, widget-bar-color, widget-bar-style, widget-base, widget-border, widget-bottom, widget-box-style, widget-button-color, widget-button-style, widget-button-width, widget-buttons, widget-children, widget-concise, widget-connected, widget-continuous-update, widget-controls, widget-data, widget-description, widget-description-tooltip, widget-description-width, widget-disabled, widget-display, widget-ensure-option, widget-error, widget-flex, widget-flex-flow, widget-font-weight, widget-format, widget-grid-area, widget-grid-auto-columns, widget-grid-auto-flow, widget-grid-auto-rows, widget-grid-column, widget-grid-gap, widget-grid-row, widget-grid-template-areas, widget-grid-template-columns, widget-grid-template-rows, widget-handle-color, widget-height, widget-icon, widget-icons, widget-indent, widget-index, widget-interval, widget-justify-content, widget-justify-items, widget-layout, widget-left, widget-loop, widget-mapping, widget-margin, widget-max, widget-max-height, widget-max-width, widget-metadata, widget-min, widget-min-height, widget-min-width, widget-msg-id, widget-multiple, widget-name, widget-object-fit, widget-object-position, widget-on-trait-change, widget-options, widget-order, widget-orientation, widget-outputs, widget-overflow, widget-overflow-x, widget-overflow-y, widget-padding, widget-placeholder, widget-pressed, widget-readout, widget-readout-format, widget-right, widget-rows, widget-selected-index, widget-show-repeat, widget-source, widget-step, widget-style, widget-target, widget-timestamp, widget-tooltip, widget-tooltips, widget-top, widget-value, widget-visibility, widget-width,

accordion

Class

Displays children each on a separate accordion page.

Precedence List

accordion, box, dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • box-style — Use a predefined styling for the box.
    • :initarg :box-style
  • children — List of widget children.
    • :initarg :children
  • %titles — Titles of the pages.
    • :initarg :%titles
  • 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.
    • :initarg :selected-index
Methods
  • validate-trait

      (validate-trait (w accordion) (type (eql int)) name value)
    
  • widget-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.

      (setf (widget-selected-index (accordion accordion)) new-value)
    
  • widget-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.

      (widget-selected-index (accordion accordion))
    
  • widget-%titles — Titles of the pages.

      (setf (widget-%titles (accordion accordion)) new-value)
    
  • widget-%titles — Titles of the pages.

      (widget-%titles (accordion accordion))
    
  • widget-children — List of widget children.

      (setf (widget-children (box box)) new-value)
    
  • widget-children — List of widget children.

      (widget-children (box box))
    
  • widget-box-style — Use a predefined styling for the box.

      (setf (widget-box-style (box box)) new-value)
    
  • widget-box-style — Use a predefined styling for the box.

      (widget-box-style (box box))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

audio

Class

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.

Precedence List

audio, dom-widget, widget, has-traits, comm, source, format-slot, byte-value-slot, standard-object, slot-object, t

Slots
  • value — The value as a byte string.
    • :initarg :value
  • format — The format of the media.
    • :initarg :format
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • autoplay — When true, the audio starts when it’s displayed.
    • :initarg :autoplay
  • controls — Specifies that media controls should be displayed (such as a play/pause button etc)
    • :initarg :controls
  • loop — When true, the audio will start from the beginning after finishing
    • :initarg :loop
Methods
  • widget-loop — When true, the audio will start from the beginning after finishing

      (setf (widget-loop (audio audio)) new-value)
    
  • widget-loop — When true, the audio will start from the beginning after finishing

      (widget-loop (audio audio))
    
  • widget-controls — Specifies that media controls should be displayed (such as a play/pause button etc)

      (setf (widget-controls (audio audio)) new-value)
    
  • widget-controls — Specifies that media controls should be displayed (such as a play/pause button etc)

      (widget-controls (audio audio))
    
  • widget-autoplay — When true, the audio starts when it’s displayed.

      (setf (widget-autoplay (audio audio)) new-value)
    
  • widget-autoplay — When true, the audio starts when it’s displayed.

      (widget-autoplay (audio audio))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-format — The format of the media.

      (setf (widget-format (format-slot format-slot)) new-value)
    
  • widget-format — The format of the media.

      (widget-format (format-slot format-slot))
    
  • widget-value — The value as a byte string.

      (setf (widget-value (byte-value-slot byte-value-slot)) new-value)
    
  • widget-value — The value as a byte string.

      (widget-value (byte-value-slot byte-value-slot))
    

blur

Function

(blur widget)

bounded-float-text

Class

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.

Precedence List

bounded-float-text, float-text, base-text, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, continuous-update-slot, float-step-slot, float-value-slot, float-min-max-slots, standard-object, slot-object, t

Slots
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • value — Float value
    • :initarg :value
  • step — Minimum step to increment the value
    • :initarg :step
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (float-step-slot float-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (float-step-slot float-step-slot))
    
  • widget-value — Float value

      (setf (widget-value (float-value-slot float-value-slot)) new-value)
    
  • widget-value — Float value

      (widget-value (float-value-slot float-value-slot))
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float-list)) name value)
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float)) name value)
    
  • widget-min — Min value

      (setf (widget-min (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (float-min-max-slots float-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (float-min-max-slots float-min-max-slots))
    

bounded-int-text

Class

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

Precedence List

bounded-int-text, int-text, base-text, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, continuous-update-slot, int-step-slot, int-value-slot, int-min-max-slots, standard-object, slot-object, t

Slots
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • value — Int value
    • :initarg :value
  • step — Minimum step to increment the value
    • :initarg :step
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (int-step-slot int-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (int-step-slot int-step-slot))
    
  • widget-value — Int value

      (setf (widget-value (int-value-slot int-value-slot)) new-value)
    
  • widget-value — Int value

      (widget-value (int-value-slot int-value-slot))
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int)) name value)
    
  • widget-min — Min value

      (setf (widget-min (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (int-min-max-slots int-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (int-min-max-slots int-min-max-slots))
    

box

Class

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

Example

(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))
Precedence List

box, dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • box-style — Use a predefined styling for the box.
    • :initarg :box-style
  • children — List of widget children.
    • :initarg :children
Methods
  • widget-children — List of widget children.

      (setf (widget-children (box box)) new-value)
    
  • widget-children — List of widget children.

      (widget-children (box box))
    
  • widget-box-style — Use a predefined styling for the box.

      (setf (widget-box-style (box box)) new-value)
    
  • widget-box-style — Use a predefined styling for the box.

      (widget-box-style (box box))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

button

Class

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.

Precedence List

button, styled-widget, dom-widget, widget, has-traits, comm, source, button-style-slot, disabled-slot, icon-slot, tooltip-slot, standard-object, slot-object, t

Slots
  • tooltip — Tooltip caption.
    • :initarg :tooltip
  • icon — Font-awesome icon name, without the ‘fa-‘ prefix.
    • :initarg :icon
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • button-style — Use a predefined styling for the button.
    • :initarg :button-style
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Button label.
    • :initarg :description
  • on-click
    • :initarg :on-click
Methods
  • on-custom-message

      (on-custom-message (w button) content buffers)
    
  • widget-on-click — automatically generated writer method

      (setf (widget-on-click (button button)) new-value)
    
  • widget-on-click — automatically generated reader method

      (widget-on-click (button button))
    
  • widget-description — Button label.

      (setf (widget-description (button button)) new-value)
    
  • widget-description — Button label.

      (widget-description (button button))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-button-style — Use a predefined styling for the button.

      (setf (widget-button-style (button-style-slot button-style-slot)) new-value)
    
  • widget-button-style — Use a predefined styling for the button.

      (widget-button-style (button-style-slot button-style-slot))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-icon — Font-awesome icon name, without the ‘fa-‘ prefix.

      (setf (widget-icon (icon-slot icon-slot)) new-value)
    
  • widget-icon — Font-awesome icon name, without the ‘fa-‘ prefix.

      (widget-icon (icon-slot icon-slot))
    
  • widget-tooltip — Tooltip caption.

      (setf (widget-tooltip (tooltip-slot tooltip-slot)) new-value)
    
  • widget-tooltip — Tooltip caption.

      (widget-tooltip (tooltip-slot tooltip-slot))
    

button-style

Class

Button style widget

Precedence List

button-style, style, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • button-color — Color of the button
    • :initarg :button-color
  • font-weight — Button text font weight.
    • :initarg :font-weight
Methods
  • widget-font-weight — Button text font weight.

      (setf (widget-font-weight (button-style button-style)) new-value)
    
  • widget-font-weight — Button text font weight.

      (widget-font-weight (button-style button-style))
    
  • widget-button-color — Color of the button

      (setf (widget-button-color (button-style button-style)) new-value)
    
  • widget-button-color — Color of the button

      (widget-button-color (button-style button-style))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

checkbox

Class

Displays a boolean value in the form of a checkbox.

Precedence List

checkbox, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, bool-value-slot, standard-object, slot-object, t

Slots
  • value — Bool value
    • :initarg :value
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • indent — Indent the control to align with other controls with a description.
    • :initarg :indent
Methods
  • widget-indent — Indent the control to align with other controls with a description.

      (setf (widget-indent (checkbox checkbox)) new-value)
    
  • widget-indent — Indent the control to align with other controls with a description.

      (widget-indent (checkbox checkbox))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-value — Bool value

      (setf (widget-value (bool-value-slot bool-value-slot)) new-value)
    
  • widget-value — Bool value

      (widget-value (bool-value-slot bool-value-slot))
    

color-picker

Class

Color picker widget

Precedence List

color-picker, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, standard-object, slot-object, t

Slots
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • concise — Display short version with just a color selector.
    • :initarg :concise
  • value — The color value.
    • :initarg :value
Methods
  • widget-value — The color value.

      (setf (widget-value (color-picker color-picker)) new-value)
    
  • widget-value — The color value.

      (widget-value (color-picker color-picker))
    
  • widget-concise — Display short version with just a color selector.

      (setf (widget-concise (color-picker color-picker)) new-value)
    
  • widget-concise — Display short version with just a color selector.

      (widget-concise (color-picker color-picker))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    

combobox

Class

Precedence List

combobox, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, continuous-update-slot, disabled-slot, placeholder-slot, string-value-slot, standard-object, slot-object, t

Slots
  • value — String value
    • :initarg :value
  • placeholder — Placeholder text to display when nothing has been typed.
    • :initarg :placeholder
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • ensure-option — If set, ensure value is in options. Implies continuous_update=False.
    • :initarg :ensure-option
  • options — Dropdown options for the combobox
    • :initarg :options
Methods
  • widget-options — Dropdown options for the combobox

      (setf (widget-options (combobox combobox)) new-value)
    
  • widget-options — Dropdown options for the combobox

      (widget-options (combobox combobox))
    
  • widget-ensure-option — If set, ensure value is in options. Implies continuous_update=False.

      (setf (widget-ensure-option (combobox combobox)) new-value)
    
  • widget-ensure-option — If set, ensure value is in options. Implies continuous_update=False.

      (widget-ensure-option (combobox combobox))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (setf (widget-placeholder (placeholder-slot placeholder-slot)) new-value)
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (widget-placeholder (placeholder-slot placeholder-slot))
    
  • widget-value — String value

      (setf (widget-value (string-value-slot string-value-slot)) new-value)
    
  • widget-value — String value

      (widget-value (string-value-slot string-value-slot))
    

controller

Class

Represents a game controller.

Precedence List

controller, dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • axes — The axes on the gamepad.
    • :initarg :axes
  • buttons — The buttons on the gamepad.
    • :initarg :buttons
  • connected — Whether the gamepad is connected.
    • :initarg :connected
  • index — The id number of the controller.
    • :initarg :index
  • mapping — The name of the control mapping.
    • :initarg :mapping
  • name — The name of the controller.
    • :initarg :name
  • timestamp — The last time the data from this gamepad was updated.
    • :initarg :timestamp
Methods
  • widget-timestamp — The last time the data from this gamepad was updated.

      (setf (widget-timestamp (controller controller)) new-value)
    
  • widget-timestamp — The last time the data from this gamepad was updated.

      (widget-timestamp (controller controller))
    
  • widget-name — The name of the controller.

      (setf (widget-name (controller controller)) new-value)
    
  • widget-name — The name of the controller.

      (widget-name (controller controller))
    
  • widget-mapping — The name of the control mapping.

      (setf (widget-mapping (controller controller)) new-value)
    
  • widget-mapping — The name of the control mapping.

      (widget-mapping (controller controller))
    
  • widget-index — The id number of the controller.

      (setf (widget-index (controller controller)) new-value)
    
  • widget-index — The id number of the controller.

      (widget-index (controller controller))
    
  • widget-connected — Whether the gamepad is connected.

      (setf (widget-connected (controller controller)) new-value)
    
  • widget-connected — Whether the gamepad is connected.

      (widget-connected (controller controller))
    
  • widget-buttons — The buttons on the gamepad.

      (setf (widget-buttons (controller controller)) new-value)
    
  • widget-buttons — The buttons on the gamepad.

      (widget-buttons (controller controller))
    
  • widget-axes — The axes on the gamepad.

      (setf (widget-axes (controller controller)) new-value)
    
  • widget-axes — The axes on the gamepad.

      (widget-axes (controller controller))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

controller-axis

Class

Represents a gamepad or joystick axis.

Precedence List

controller-axis, dom-widget, widget, has-traits, comm, source, float-value-slot, standard-object, slot-object, t

Slots
  • value — Float value
    • :initarg :value
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
Methods
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-value — Float value

      (setf (widget-value (float-value-slot float-value-slot)) new-value)
    
  • widget-value — Float value

      (widget-value (float-value-slot float-value-slot))
    

controller-button

Class

Represents a gamepad or joystick button.

Precedence List

controller-button, dom-widget, widget, has-traits, comm, source, float-value-slot, standard-object, slot-object, t

Slots
  • value — Float value
    • :initarg :value
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • pressed — Whether the button is pressed.
    • :initarg :pressed
Methods
  • widget-pressed — Whether the button is pressed.

      (setf (widget-pressed (controller-button controller-button)) new-value)
    
  • widget-pressed — Whether the button is pressed.

      (widget-pressed (controller-button controller-button))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-value — Float value

      (setf (widget-value (float-value-slot float-value-slot)) new-value)
    
  • widget-value — Float value

      (widget-value (float-value-slot float-value-slot))
    

date-picker

Class

Date picker widget

Precedence List

date-picker, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, standard-object, slot-object, t

Slots
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • value — The date value.
    • :initarg :value
Methods
  • widget-value — The date value.

      (setf (widget-value (date-picker date-picker)) new-value)
    
  • widget-value — The date value.

      (widget-value (date-picker date-picker))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    

defwidget

Macro

(defwidget name &rest rest)

description-style

Class

Precedence List

description-style, style, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • description-width — Width of the description to the side of the control.
    • :initarg :description-width
Methods
  • widget-description-width — Width of the description to the side of the control.

      (setf (widget-description-width (description-style description-style))
              new-value)
    
  • widget-description-width — Width of the description to the side of the control.

      (widget-description-width (description-style description-style))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

Generic Function

Create a link between traits in the client if possible

(directional-link source source-trait target target-trait &optional sync)

Class

A directional link

Precedence List

directional-link, link, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • source
    • :initarg :source
  • target
    • :initarg :target
Methods
  • widget-target — automatically generated writer method

      (setf (widget-target (link link)) new-value)
    
  • widget-target — automatically generated reader method

      (widget-target (link link))
    
  • widget-source — automatically generated writer method

      (setf (widget-source (link link)) new-value)
    
  • widget-source — automatically generated reader method

      (widget-source (link link))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

dom-widget

Class

Base class for all Jupyter widgets which have DOM view.

Precedence List

dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
Methods
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

Class

Allows you to select a single item from a dropdown.

Precedence List

dropdown, select, base-select, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, %options-labels-slot, disabled-slot, index-slot, standard-object, slot-object, t

Slots
  • index — Selected index
    • :initarg :index
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • %options-labels — The labels for the options.
    • :initarg :%options-labels
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • rows — The number of rows to display.
    • :initarg :rows
  • options — The option values that correspond to the labels
    • :initarg :options
Methods
  • on-trait-change

      (on-trait-change (instance select) type (name (eql index)) old-value
                       new-value source)
    
  • widget-value

      (setf (widget-value (instance select)) new-value)
    
  • widget-value

      (widget-value (instance select))
    
  • widget-options — The option values that correspond to the labels

      (setf (widget-options (select select)) new-value)
    
  • widget-options — The option values that correspond to the labels

      (widget-options (select select))
    
  • widget-rows — The number of rows to display.

      (setf (widget-rows (base-select base-select)) new-value)
    
  • widget-rows — The number of rows to display.

      (widget-rows (base-select base-select))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int)) name value)
    
  • widget-%options-labels — The labels for the options.

      (setf (widget-%options-labels (%options-labels-slot %options-labels-slot))
              new-value)
    
  • widget-%options-labels — The labels for the options.

      (widget-%options-labels (%options-labels-slot %options-labels-slot))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-index — Selected index

      (setf (widget-index (index-slot index-slot)) new-value)
    
  • widget-index — Selected index

      (widget-index (index-slot index-slot))
    

file-upload

Class

Precedence List

file-upload, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, button-style-slot, disabled-slot, icon-slot, standard-object, slot-object, t

Slots
  • icon — Font-awesome icon name, without the ‘fa-‘ prefix.
    • :initarg :icon
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • button-style — Use a predefined styling for the button.
    • :initarg :button-style
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • accept — If set, ensure value is in options. Implies continuous_update=False. File types to accept, empty string for all.
    • :initarg :accept
  • data — List of file content (bytes)
    • :initarg :data
  • error — Error message
    • :initarg :error
  • metadata — List of file metadata
    • :initarg :metadata
  • multiple — If True, allow for multiple files upload
    • :initarg :multiple
Methods
  • on-trait-change

      (on-trait-change (instance file-upload) type (name (eql metadata))
                       old-value new-value source)
    
  • on-trait-change

      (on-trait-change (instance file-upload) type (name (eql data)) old-value
                       new-value source)
    
  • widget-value

      (widget-value (instance file-upload))
    
  • widget-multiple — If True, allow for multiple files upload

      (setf (widget-multiple (file-upload file-upload)) new-value)
    
  • widget-multiple — If True, allow for multiple files upload

      (widget-multiple (file-upload file-upload))
    
  • widget-metadata — List of file metadata

      (setf (widget-metadata (file-upload file-upload)) new-value)
    
  • widget-metadata — List of file metadata

      (widget-metadata (file-upload file-upload))
    
  • widget-error — Error message

      (setf (widget-error (file-upload file-upload)) new-value)
    
  • widget-error — Error message

      (widget-error (file-upload file-upload))
    
  • widget-data — List of file content (bytes)

      (setf (widget-data (file-upload file-upload)) new-value)
    
  • widget-data — List of file content (bytes)

      (widget-data (file-upload file-upload))
    
  • widget-accept — If set, ensure value is in options. Implies continuous_update=False. File types to accept, empty string for all.

      (setf (widget-accept (file-upload file-upload)) new-value)
    
  • widget-accept — If set, ensure value is in options. Implies continuous_update=False. File types to accept, empty string for all.

      (widget-accept (file-upload file-upload))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-button-style — Use a predefined styling for the button.

      (setf (widget-button-style (button-style-slot button-style-slot)) new-value)
    
  • widget-button-style — Use a predefined styling for the button.

      (widget-button-style (button-style-slot button-style-slot))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-icon — Font-awesome icon name, without the ‘fa-‘ prefix.

      (setf (widget-icon (icon-slot icon-slot)) new-value)
    
  • widget-icon — Font-awesome icon name, without the ‘fa-‘ prefix.

      (widget-icon (icon-slot icon-slot))
    

float-log-slider

Class

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

Precedence List

float-log-slider, number-slider, base-slider, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, orientation-slot, continuous-update-slot, float-min-max-slots, float-step-slot, float-value-slot, standard-object, slot-object, t

Slots
  • value — Float value
    • :initarg :value
  • step — Minimum step to increment the value
    • :initarg :step
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • orientation — Vertical or horizontal.
    • :initarg :orientation
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • readout — Display the current value of the slider next to it.
    • :initarg :readout
  • readout-format — Format for the readout
    • :initarg :readout-format
  • base — Base for the logarithm
    • :initarg :base
Methods
  • widget-base — Base for the logarithm

      (setf (widget-base (float-log-slider float-log-slider)) new-value)
    
  • widget-base — Base for the logarithm

      (widget-base (float-log-slider float-log-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (number-slider number-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (number-slider number-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (base-slider base-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (base-slider base-slider))
    
  • widget-readout — Display the current value of the slider next to it.

      (setf (widget-readout (base-slider base-slider)) new-value)
    
  • widget-readout — Display the current value of the slider next to it.

      (widget-readout (base-slider base-slider))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-orientation — Vertical or horizontal.

      (setf (widget-orientation (orientation-slot orientation-slot)) new-value)
    
  • widget-orientation — Vertical or horizontal.

      (widget-orientation (orientation-slot orientation-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float-list)) name value)
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float)) name value)
    
  • widget-min — Min value

      (setf (widget-min (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (float-min-max-slots float-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (float-min-max-slots float-min-max-slots))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (float-step-slot float-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (float-step-slot float-step-slot))
    
  • widget-value — Float value

      (setf (widget-value (float-value-slot float-value-slot)) new-value)
    
  • widget-value — Float value

      (widget-value (float-value-slot float-value-slot))
    

float-progress

Class

Displays a progress bar.

Precedence List

float-progress, base-progress, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, orientation-slot, float-min-max-slots, float-value-slot, standard-object, slot-object, t

Slots
  • value — Float value
    • :initarg :value
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • orientation — Vertical or horizontal.
    • :initarg :orientation
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • bar-style — Use a predefined styling for the progess bar.
    • :initarg :bar-style
Methods
  • widget-bar-style — Use a predefined styling for the progess bar.

      (setf (widget-bar-style (base-progress base-progress)) new-value)
    
  • widget-bar-style — Use a predefined styling for the progess bar.

      (widget-bar-style (base-progress base-progress))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-orientation — Vertical or horizontal.

      (setf (widget-orientation (orientation-slot orientation-slot)) new-value)
    
  • widget-orientation — Vertical or horizontal.

      (widget-orientation (orientation-slot orientation-slot))
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float-list)) name value)
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float)) name value)
    
  • widget-min — Min value

      (setf (widget-min (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (float-min-max-slots float-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (float-min-max-slots float-min-max-slots))
    
  • widget-value — Float value

      (setf (widget-value (float-value-slot float-value-slot)) new-value)
    
  • widget-value — Float value

      (widget-value (float-value-slot float-value-slot))
    

float-range-slider

Class

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

Precedence List

float-range-slider, number-slider, base-slider, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, orientation-slot, continuous-update-slot, float-min-max-slots, float-step-slot, standard-object, slot-object, t

Slots
  • step — Minimum step to increment the value
    • :initarg :step
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • orientation — Vertical or horizontal.
    • :initarg :orientation
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • readout — Display the current value of the slider next to it.
    • :initarg :readout
  • readout-format — Format for the readout
    • :initarg :readout-format
  • value — Float range
    • :initarg :value
Methods
  • widget-value — Float range

      (setf (widget-value (float-range-slider float-range-slider)) new-value)
    
  • widget-value — Float range

      (widget-value (float-range-slider float-range-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (number-slider number-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (number-slider number-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (base-slider base-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (base-slider base-slider))
    
  • widget-readout — Display the current value of the slider next to it.

      (setf (widget-readout (base-slider base-slider)) new-value)
    
  • widget-readout — Display the current value of the slider next to it.

      (widget-readout (base-slider base-slider))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-orientation — Vertical or horizontal.

      (setf (widget-orientation (orientation-slot orientation-slot)) new-value)
    
  • widget-orientation — Vertical or horizontal.

      (widget-orientation (orientation-slot orientation-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float-list)) name value)
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float)) name value)
    
  • widget-min — Min value

      (setf (widget-min (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (float-min-max-slots float-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (float-min-max-slots float-min-max-slots))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (float-step-slot float-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (float-step-slot float-step-slot))
    

float-slider

Class

Slider/trackbar of floating values with the specified range.

Precedence List

float-slider, number-slider, base-slider, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, orientation-slot, continuous-update-slot, float-min-max-slots, float-step-slot, float-value-slot, standard-object, slot-object, t

Slots
  • value — Float value
    • :initarg :value
  • step — Minimum step to increment the value
    • :initarg :step
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • orientation — Vertical or horizontal.
    • :initarg :orientation
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • readout — Display the current value of the slider next to it.
    • :initarg :readout
  • readout-format — Format for the readout
    • :initarg :readout-format
Methods
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (number-slider number-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (number-slider number-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (base-slider base-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (base-slider base-slider))
    
  • widget-readout — Display the current value of the slider next to it.

      (setf (widget-readout (base-slider base-slider)) new-value)
    
  • widget-readout — Display the current value of the slider next to it.

      (widget-readout (base-slider base-slider))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-orientation — Vertical or horizontal.

      (setf (widget-orientation (orientation-slot orientation-slot)) new-value)
    
  • widget-orientation — Vertical or horizontal.

      (widget-orientation (orientation-slot orientation-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float-list)) name value)
    
  • validate-trait

      (validate-trait (w float-min-max-slots) (type (eql float)) name value)
    
  • widget-min — Min value

      (setf (widget-min (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (float-min-max-slots float-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (float-min-max-slots float-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (float-min-max-slots float-min-max-slots))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (float-step-slot float-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (float-step-slot float-step-slot))
    
  • widget-value — Float value

      (setf (widget-value (float-value-slot float-value-slot)) new-value)
    
  • widget-value — Float value

      (widget-value (float-value-slot float-value-slot))
    

float-text

Class

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

Precedence List

float-text, base-text, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, continuous-update-slot, float-step-slot, float-value-slot, standard-object, slot-object, t

Slots
  • value — Float value
    • :initarg :value
  • step — Minimum step to increment the value
    • :initarg :step
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (float-step-slot float-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (float-step-slot float-step-slot))
    
  • widget-value — Float value

      (setf (widget-value (float-value-slot float-value-slot)) new-value)
    
  • widget-value — Float value

      (widget-value (float-value-slot float-value-slot))
    

focus

Function

(focus widget)

grid-box

Class

Precedence List

grid-box, box, dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • box-style — Use a predefined styling for the box.
    • :initarg :box-style
  • children — List of widget children.
    • :initarg :children
Methods
  • widget-children — List of widget children.

      (setf (widget-children (box box)) new-value)
    
  • widget-children — List of widget children.

      (widget-children (box box))
    
  • widget-box-style — Use a predefined styling for the box.

      (setf (widget-box-style (box box)) new-value)
    
  • widget-box-style — Use a predefined styling for the box.

      (widget-box-style (box box))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

h-box

Class

Displays multiple widgets horizontally using the flexible box model.

Example

(use-package :jupyter-widgets)
(defvar title-widget (make-instance 'html :value "<em>Box Example</em>"))
(defvar slider (make-instance 'int-slider))
(make-instance 'h-box :children (list title-widget slider))
Precedence List

h-box, box, dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • box-style — Use a predefined styling for the box.
    • :initarg :box-style
  • children — List of widget children.
    • :initarg :children
Methods
  • widget-children — List of widget children.

      (setf (widget-children (box box)) new-value)
    
  • widget-children — List of widget children.

      (widget-children (box box))
    
  • widget-box-style — Use a predefined styling for the box.

      (setf (widget-box-style (box box)) new-value)
    
  • widget-box-style — Use a predefined styling for the box.

      (widget-box-style (box box))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

has-traits

Class

Precedence List

has-traits, standard-object, slot-object, t

Slots
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
Methods
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    

html

Class

Renders the string value as HTML.

Precedence List

html, label, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, placeholder-slot, string-value-slot, standard-object, slot-object, t

Slots
  • value — String value
    • :initarg :value
  • placeholder — Placeholder text to display when nothing has been typed.
    • :initarg :placeholder
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (setf (widget-placeholder (placeholder-slot placeholder-slot)) new-value)
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (widget-placeholder (placeholder-slot placeholder-slot))
    
  • widget-value — String value

      (setf (widget-value (string-value-slot string-value-slot)) new-value)
    
  • widget-value — String value

      (widget-value (string-value-slot string-value-slot))
    

html-math

Class

Renders the string value as HTML, and render mathematics.

Precedence List

html-math, label, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, placeholder-slot, string-value-slot, standard-object, slot-object, t

Slots
  • value — String value
    • :initarg :value
  • placeholder — Placeholder text to display when nothing has been typed.
    • :initarg :placeholder
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (setf (widget-placeholder (placeholder-slot placeholder-slot)) new-value)
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (widget-placeholder (placeholder-slot placeholder-slot))
    
  • widget-value — String value

      (setf (widget-value (string-value-slot string-value-slot)) new-value)
    
  • widget-value — String value

      (widget-value (string-value-slot string-value-slot))
    

image

Class

Displays an image as a widget.

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

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

Precedence List

image, dom-widget, widget, has-traits, comm, source, format-slot, height-slot, width-slot, byte-value-slot, standard-object, slot-object, t

Slots
  • value — The value as a byte string.
    • :initarg :value
  • width — Width of the media in pixels.
    • :initarg :width
  • height — Height of the media in pixels.
    • :initarg :height
  • format — The format of the media.
    • :initarg :format
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
Methods
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-format — The format of the media.

      (setf (widget-format (format-slot format-slot)) new-value)
    
  • widget-format — The format of the media.

      (widget-format (format-slot format-slot))
    
  • widget-height — Height of the media in pixels.

      (setf (widget-height (height-slot height-slot)) new-value)
    
  • widget-height — Height of the media in pixels.

      (widget-height (height-slot height-slot))
    
  • widget-width — Width of the media in pixels.

      (setf (widget-width (width-slot width-slot)) new-value)
    
  • widget-width — Width of the media in pixels.

      (widget-width (width-slot width-slot))
    
  • widget-value — The value as a byte string.

      (setf (widget-value (byte-value-slot byte-value-slot)) new-value)
    
  • widget-value — The value as a byte string.

      (widget-value (byte-value-slot byte-value-slot))
    

int-progress

Class

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

Precedence List

int-progress, base-progress, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, orientation-slot, int-min-max-slots, int-value-slot, standard-object, slot-object, t

Slots
  • value — Int value
    • :initarg :value
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • orientation — Vertical or horizontal.
    • :initarg :orientation
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • bar-style — Use a predefined styling for the progess bar.
    • :initarg :bar-style
Methods
  • widget-bar-style — Use a predefined styling for the progess bar.

      (setf (widget-bar-style (base-progress base-progress)) new-value)
    
  • widget-bar-style — Use a predefined styling for the progess bar.

      (widget-bar-style (base-progress base-progress))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-orientation — Vertical or horizontal.

      (setf (widget-orientation (orientation-slot orientation-slot)) new-value)
    
  • widget-orientation — Vertical or horizontal.

      (widget-orientation (orientation-slot orientation-slot))
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int)) name value)
    
  • widget-min — Min value

      (setf (widget-min (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (int-min-max-slots int-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (int-min-max-slots int-min-max-slots))
    
  • widget-value — Int value

      (setf (widget-value (int-value-slot int-value-slot)) new-value)
    
  • widget-value — Int value

      (widget-value (int-value-slot int-value-slot))
    

int-range-slider

Class

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

Precedence List

int-range-slider, number-slider, base-slider, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, orientation-slot, continuous-update-slot, int-min-max-slots, int-step-slot, standard-object, slot-object, t

Slots
  • step — Minimum step to increment the value
    • :initarg :step
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • orientation — Vertical or horizontal.
    • :initarg :orientation
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • readout — Display the current value of the slider next to it.
    • :initarg :readout
  • readout-format — Format for the readout
    • :initarg :readout-format
  • value — Int range value
    • :initarg :value
Methods
  • widget-value — Int range value

      (setf (widget-value (int-range-slider int-range-slider)) new-value)
    
  • widget-value — Int range value

      (widget-value (int-range-slider int-range-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (number-slider number-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (number-slider number-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (base-slider base-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (base-slider base-slider))
    
  • widget-readout — Display the current value of the slider next to it.

      (setf (widget-readout (base-slider base-slider)) new-value)
    
  • widget-readout — Display the current value of the slider next to it.

      (widget-readout (base-slider base-slider))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-orientation — Vertical or horizontal.

      (setf (widget-orientation (orientation-slot orientation-slot)) new-value)
    
  • widget-orientation — Vertical or horizontal.

      (widget-orientation (orientation-slot orientation-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int)) name value)
    
  • widget-min — Min value

      (setf (widget-min (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (int-min-max-slots int-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (int-min-max-slots int-min-max-slots))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (int-step-slot int-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (int-step-slot int-step-slot))
    

int-slider

Class

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

Precedence List

int-slider, number-slider, base-slider, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, orientation-slot, continuous-update-slot, int-min-max-slots, int-step-slot, int-value-slot, standard-object, slot-object, t

Slots
  • value — Int value
    • :initarg :value
  • step — Minimum step to increment the value
    • :initarg :step
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • orientation — Vertical or horizontal.
    • :initarg :orientation
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • readout — Display the current value of the slider next to it.
    • :initarg :readout
  • readout-format — Format for the readout
    • :initarg :readout-format
Methods
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (number-slider number-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (number-slider number-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (base-slider base-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (base-slider base-slider))
    
  • widget-readout — Display the current value of the slider next to it.

      (setf (widget-readout (base-slider base-slider)) new-value)
    
  • widget-readout — Display the current value of the slider next to it.

      (widget-readout (base-slider base-slider))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-orientation — Vertical or horizontal.

      (setf (widget-orientation (orientation-slot orientation-slot)) new-value)
    
  • widget-orientation — Vertical or horizontal.

      (widget-orientation (orientation-slot orientation-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int)) name value)
    
  • widget-min — Min value

      (setf (widget-min (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (int-min-max-slots int-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (int-min-max-slots int-min-max-slots))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (int-step-slot int-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (int-step-slot int-step-slot))
    
  • widget-value — Int value

      (setf (widget-value (int-value-slot int-value-slot)) new-value)
    
  • widget-value — Int value

      (widget-value (int-value-slot int-value-slot))
    

int-text

Class

Textbox widget that represents an integer.

Precedence List

int-text, base-text, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, continuous-update-slot, int-step-slot, int-value-slot, standard-object, slot-object, t

Slots
  • value — Int value
    • :initarg :value
  • step — Minimum step to increment the value
    • :initarg :step
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (int-step-slot int-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (int-step-slot int-step-slot))
    
  • widget-value — Int value

      (setf (widget-value (int-value-slot int-value-slot)) new-value)
    
  • widget-value — Int value

      (widget-value (int-value-slot int-value-slot))
    

label

Class

Label widget.

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

Precedence List

label, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, placeholder-slot, string-value-slot, standard-object, slot-object, t

Slots
  • value — String value
    • :initarg :value
  • placeholder — Placeholder text to display when nothing has been typed.
    • :initarg :placeholder
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (setf (widget-placeholder (placeholder-slot placeholder-slot)) new-value)
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (widget-placeholder (placeholder-slot placeholder-slot))
    
  • widget-value — String value

      (setf (widget-value (string-value-slot string-value-slot)) new-value)
    
  • widget-value — String value

      (widget-value (string-value-slot string-value-slot))
    

layout

Class

Layout specification

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

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

Precedence List

layout, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • align-content — The align-content CSS attribute.
    • :initarg :align-content
  • align-items — The align-items CSS attribute.
    • :initarg :align-items
  • align-self — The align-self CSS attribute.
    • :initarg :align-self
  • border — The border CSS attribute.
    • :initarg :border
  • bottom — The bottom CSS attribute.
    • :initarg :bottom
  • display — The display CSS attribute.
    • :initarg :display
  • flex — The flex CSS attribute.
    • :initarg :flex
  • flex-flow — The flex-flow CSS attribute.
    • :initarg :flex-flow
  • grid-area — The grid-area CSS attribute.
    • :initarg :grid-area
  • grid-auto-columns — The grid-auto-columns CSS attribute.
    • :initarg :grid-auto-columns
  • grid-auto-flow — The grid-auto-flow CSS attribute.
    • :initarg :grid-auto-flow
  • grid-auto-rows — The grid-auto-rows CSS attribute.
    • :initarg :grid-auto-rows
  • grid-column — The grid-column CSS attribute.
    • :initarg :grid-column
  • grid-gap — The grid-gap CSS attribute.
    • :initarg :grid-gap
  • grid-row — The grid-row CSS attribute.
    • :initarg :grid-row
  • grid-template-areas — The grid-template-areas CSS attribute.
    • :initarg :grid-template-areas
  • grid-template-columns — The grid-template-columns CSS attribute.
    • :initarg :grid-template-columns
  • grid-template-rows — The grid-template-rows CSS attribute.
    • :initarg :grid-template-rows
  • height — The height CSS attribute.
    • :initarg :height
  • justify-content — The justify-content CSS attribute.
    • :initarg :justify-content
  • justify-items — The justify-items CSS attribute.
    • :initarg :justify-items
  • left — The left CSS attribute.
    • :initarg :left
  • margin — The margin CSS attribute.
    • :initarg :margin
  • max-height — The max-height CSS attribute.
    • :initarg :max-height
  • max-width — The max-width CSS attribute.
    • :initarg :max-width
  • min-height — The min-height CSS attribute.
    • :initarg :min-height
  • min-width — The min-width CSS attribute.
    • :initarg :min-width
  • object-fit — The object-fit CSS attribute.
    • :initarg :object-fit
  • object-position — The object-position CSS attribute.
    • :initarg :object-position
  • order — The order CSS attribute.
    • :initarg :order
  • overflow — The overflow CSS attribute.
    • :initarg :overflow
  • overflow-x — The overflow-x CSS attribute.
    • :initarg :overflow-x
  • overflow-y — The overflow-y CSS attribute.
    • :initarg :overflow-y
  • padding — The padding CSS attribute.
    • :initarg :padding
  • right — The right CSS attribute.
    • :initarg :right
  • top — The top CSS attribute.
    • :initarg :top
  • visibility — The visibility CSS attribute.
    • :initarg :visibility
  • width — The width CSS attribute.
    • :initarg :width
Methods
  • widget-width — The width CSS attribute.

      (setf (widget-width (layout layout)) new-value)
    
  • widget-width — The width CSS attribute.

      (widget-width (layout layout))
    
  • widget-visibility — The visibility CSS attribute.

      (setf (widget-visibility (layout layout)) new-value)
    
  • widget-visibility — The visibility CSS attribute.

      (widget-visibility (layout layout))
    
  • widget-top — The top CSS attribute.

      (setf (widget-top (layout layout)) new-value)
    
  • widget-top — The top CSS attribute.

      (widget-top (layout layout))
    
  • widget-right — The right CSS attribute.

      (setf (widget-right (layout layout)) new-value)
    
  • widget-right — The right CSS attribute.

      (widget-right (layout layout))
    
  • widget-padding — The padding CSS attribute.

      (setf (widget-padding (layout layout)) new-value)
    
  • widget-padding — The padding CSS attribute.

      (widget-padding (layout layout))
    
  • widget-overflow-y — The overflow-y CSS attribute.

      (setf (widget-overflow-y (layout layout)) new-value)
    
  • widget-overflow-y — The overflow-y CSS attribute.

      (widget-overflow-y (layout layout))
    
  • widget-overflow-x — The overflow-x CSS attribute.

      (setf (widget-overflow-x (layout layout)) new-value)
    
  • widget-overflow-x — The overflow-x CSS attribute.

      (widget-overflow-x (layout layout))
    
  • widget-overflow — The overflow CSS attribute.

      (setf (widget-overflow (layout layout)) new-value)
    
  • widget-overflow — The overflow CSS attribute.

      (widget-overflow (layout layout))
    
  • widget-order — The order CSS attribute.

      (setf (widget-order (layout layout)) new-value)
    
  • widget-order — The order CSS attribute.

      (widget-order (layout layout))
    
  • widget-object-position — The object-position CSS attribute.

      (setf (widget-object-position (layout layout)) new-value)
    
  • widget-object-position — The object-position CSS attribute.

      (widget-object-position (layout layout))
    
  • widget-object-fit — The object-fit CSS attribute.

      (setf (widget-object-fit (layout layout)) new-value)
    
  • widget-object-fit — The object-fit CSS attribute.

      (widget-object-fit (layout layout))
    
  • widget-min-width — The min-width CSS attribute.

      (setf (widget-min-width (layout layout)) new-value)
    
  • widget-min-width — The min-width CSS attribute.

      (widget-min-width (layout layout))
    
  • widget-min-height — The min-height CSS attribute.

      (setf (widget-min-height (layout layout)) new-value)
    
  • widget-min-height — The min-height CSS attribute.

      (widget-min-height (layout layout))
    
  • widget-max-width — The max-width CSS attribute.

      (setf (widget-max-width (layout layout)) new-value)
    
  • widget-max-width — The max-width CSS attribute.

      (widget-max-width (layout layout))
    
  • widget-max-height — The max-height CSS attribute.

      (setf (widget-max-height (layout layout)) new-value)
    
  • widget-max-height — The max-height CSS attribute.

      (widget-max-height (layout layout))
    
  • widget-margin — The margin CSS attribute.

      (setf (widget-margin (layout layout)) new-value)
    
  • widget-margin — The margin CSS attribute.

      (widget-margin (layout layout))
    
  • widget-left — The left CSS attribute.

      (setf (widget-left (layout layout)) new-value)
    
  • widget-left — The left CSS attribute.

      (widget-left (layout layout))
    
  • widget-justify-items — The justify-items CSS attribute.

      (setf (widget-justify-items (layout layout)) new-value)
    
  • widget-justify-items — The justify-items CSS attribute.

      (widget-justify-items (layout layout))
    
  • widget-justify-content — The justify-content CSS attribute.

      (setf (widget-justify-content (layout layout)) new-value)
    
  • widget-justify-content — The justify-content CSS attribute.

      (widget-justify-content (layout layout))
    
  • widget-height — The height CSS attribute.

      (setf (widget-height (layout layout)) new-value)
    
  • widget-height — The height CSS attribute.

      (widget-height (layout layout))
    
  • widget-grid-template-rows — The grid-template-rows CSS attribute.

      (setf (widget-grid-template-rows (layout layout)) new-value)
    
  • widget-grid-template-rows — The grid-template-rows CSS attribute.

      (widget-grid-template-rows (layout layout))
    
  • widget-grid-template-columns — The grid-template-columns CSS attribute.

      (setf (widget-grid-template-columns (layout layout)) new-value)
    
  • widget-grid-template-columns — The grid-template-columns CSS attribute.

      (widget-grid-template-columns (layout layout))
    
  • widget-grid-template-areas — The grid-template-areas CSS attribute.

      (setf (widget-grid-template-areas (layout layout)) new-value)
    
  • widget-grid-template-areas — The grid-template-areas CSS attribute.

      (widget-grid-template-areas (layout layout))
    
  • widget-grid-row — The grid-row CSS attribute.

      (setf (widget-grid-row (layout layout)) new-value)
    
  • widget-grid-row — The grid-row CSS attribute.

      (widget-grid-row (layout layout))
    
  • widget-grid-gap — The grid-gap CSS attribute.

      (setf (widget-grid-gap (layout layout)) new-value)
    
  • widget-grid-gap — The grid-gap CSS attribute.

      (widget-grid-gap (layout layout))
    
  • widget-grid-column — The grid-column CSS attribute.

      (setf (widget-grid-column (layout layout)) new-value)
    
  • widget-grid-column — The grid-column CSS attribute.

      (widget-grid-column (layout layout))
    
  • widget-grid-auto-rows — The grid-auto-rows CSS attribute.

      (setf (widget-grid-auto-rows (layout layout)) new-value)
    
  • widget-grid-auto-rows — The grid-auto-rows CSS attribute.

      (widget-grid-auto-rows (layout layout))
    
  • widget-grid-auto-flow — The grid-auto-flow CSS attribute.

      (setf (widget-grid-auto-flow (layout layout)) new-value)
    
  • widget-grid-auto-flow — The grid-auto-flow CSS attribute.

      (widget-grid-auto-flow (layout layout))
    
  • widget-grid-auto-columns — The grid-auto-columns CSS attribute.

      (setf (widget-grid-auto-columns (layout layout)) new-value)
    
  • widget-grid-auto-columns — The grid-auto-columns CSS attribute.

      (widget-grid-auto-columns (layout layout))
    
  • widget-grid-area — The grid-area CSS attribute.

      (setf (widget-grid-area (layout layout)) new-value)
    
  • widget-grid-area — The grid-area CSS attribute.

      (widget-grid-area (layout layout))
    
  • widget-flex-flow — The flex-flow CSS attribute.

      (setf (widget-flex-flow (layout layout)) new-value)
    
  • widget-flex-flow — The flex-flow CSS attribute.

      (widget-flex-flow (layout layout))
    
  • widget-flex — The flex CSS attribute.

      (setf (widget-flex (layout layout)) new-value)
    
  • widget-flex — The flex CSS attribute.

      (widget-flex (layout layout))
    
  • widget-display — The display CSS attribute.

      (setf (widget-display (layout layout)) new-value)
    
  • widget-display — The display CSS attribute.

      (widget-display (layout layout))
    
  • widget-bottom — The bottom CSS attribute.

      (setf (widget-bottom (layout layout)) new-value)
    
  • widget-bottom — The bottom CSS attribute.

      (widget-bottom (layout layout))
    
  • widget-border — The border CSS attribute.

      (setf (widget-border (layout layout)) new-value)
    
  • widget-border — The border CSS attribute.

      (widget-border (layout layout))
    
  • widget-align-self — The align-self CSS attribute.

      (setf (widget-align-self (layout layout)) new-value)
    
  • widget-align-self — The align-self CSS attribute.

      (widget-align-self (layout layout))
    
  • widget-align-items — The align-items CSS attribute.

      (setf (widget-align-items (layout layout)) new-value)
    
  • widget-align-items — The align-items CSS attribute.

      (widget-align-items (layout layout))
    
  • widget-align-content — The align-content CSS attribute.

      (setf (widget-align-content (layout layout)) new-value)
    
  • widget-align-content — The align-content CSS attribute.

      (widget-align-content (layout layout))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

Generic Function

Create a link between traits in the client if possible

(link source source-trait target target-trait &optional sync)

Class

Link Widget

Precedence List

link, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • source
    • :initarg :source
  • target
    • :initarg :target
Methods
  • widget-target — automatically generated writer method

      (setf (widget-target (link link)) new-value)
    
  • widget-target — automatically generated reader method

      (widget-target (link link))
    
  • widget-source — automatically generated writer method

      (setf (widget-source (link link)) new-value)
    
  • widget-source — automatically generated reader method

      (widget-source (link link))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

make-accordion

Function

(make-accordion &rest initargs &key comm-id layout box-style children
                selected-index &allow-other-keys)

make-audio

Function

(make-audio &rest initargs &key value format comm-id layout autoplay controls
            loop &allow-other-keys)

make-bounded-float-text

Function

(make-bounded-float-text &rest initargs &key max min value step
                         continuous-update disabled comm-id layout style
                         description description-tooltip &allow-other-keys)

make-bounded-int-text

Function

(make-bounded-int-text &rest initargs &key max min value step continuous-update
                       disabled comm-id layout style description
                       description-tooltip &allow-other-keys)

make-box

Function

(make-box &rest initargs &key comm-id layout box-style children
          &allow-other-keys)

make-button

Function

(make-button &rest initargs &key tooltip icon disabled button-style comm-id
             layout style description &allow-other-keys)

make-button-style

Function

(make-button-style &rest initargs &key comm-id button-color font-weight
                   &allow-other-keys)

make-checkbox

Function

(make-checkbox &rest initargs &key value disabled comm-id layout style
               description description-tooltip indent &allow-other-keys)

make-color-picker

Function

(make-color-picker &rest initargs &key disabled comm-id layout style
                   description description-tooltip concise value
                   &allow-other-keys)

make-combobox

Function

(make-combobox &rest initargs &key value placeholder disabled continuous-update
               comm-id layout style description description-tooltip
               ensure-option options &allow-other-keys)

make-controller

Function

(make-controller &rest initargs &key comm-id layout axes buttons connected
                 index mapping name timestamp &allow-other-keys)

make-controller-axis

Function

(make-controller-axis &rest initargs &key value comm-id layout
                      &allow-other-keys)

make-controller-button

Function

(make-controller-button &rest initargs &key value comm-id layout pressed
                        &allow-other-keys)

make-date-picker

Function

(make-date-picker &rest initargs &key disabled comm-id layout style description
                  description-tooltip value &allow-other-keys)

make-description-style

Function

(make-description-style &rest initargs &key comm-id description-width
                        &allow-other-keys)

Function

(make-directional-link &rest initargs &key comm-id source target
                       &allow-other-keys)

make-dropdown

Function

(make-dropdown &rest initargs &key index disabled comm-id layout style
               description description-tooltip rows options &allow-other-keys)

make-file-upload

Function

(make-file-upload &rest initargs &key icon disabled button-style comm-id layout
                  style description description-tooltip accept data error
                  metadata multiple &allow-other-keys)

make-float-log-slider

Function

(make-float-log-slider &rest initargs &key value step max min continuous-update
                       orientation disabled comm-id layout style description
                       description-tooltip readout readout-format base
                       &allow-other-keys)

make-float-progress

Function

(make-float-progress &rest initargs &key value max min orientation comm-id
                     layout style description description-tooltip bar-style
                     &allow-other-keys)

make-float-range-slider

Function

(make-float-range-slider &rest initargs &key step max min continuous-update
                         orientation disabled comm-id layout style description
                         description-tooltip readout readout-format value
                         &allow-other-keys)

make-float-slider

Function

(make-float-slider &rest initargs &key value step max min continuous-update
                   orientation disabled comm-id layout style description
                   description-tooltip readout readout-format &allow-other-keys)

make-float-text

Function

(make-float-text &rest initargs &key value step continuous-update disabled
                 comm-id layout style description description-tooltip
                 &allow-other-keys)

make-grid-box

Function

(make-grid-box &rest initargs &key comm-id layout box-style children
               &allow-other-keys)

make-h-box

Function

(make-h-box &rest initargs &key comm-id layout box-style children
            &allow-other-keys)

make-html

Function

(make-html &rest initargs &key value placeholder comm-id layout style
           description description-tooltip &allow-other-keys)

make-html-math

Function

(make-html-math &rest initargs &key value placeholder comm-id layout style
                description description-tooltip &allow-other-keys)

make-image

Function

(make-image &rest initargs &key value width height format comm-id layout
            &allow-other-keys)

make-int-progress

Function

(make-int-progress &rest initargs &key value max min orientation comm-id layout
                   style description description-tooltip bar-style
                   &allow-other-keys)

make-int-range-slider

Function

(make-int-range-slider &rest initargs &key step max min continuous-update
                       orientation disabled comm-id layout style description
                       description-tooltip readout readout-format value
                       &allow-other-keys)

make-int-slider

Function

(make-int-slider &rest initargs &key value step max min continuous-update
                 orientation disabled comm-id layout style description
                 description-tooltip readout readout-format &allow-other-keys)

make-int-text

Function

(make-int-text &rest initargs &key value step continuous-update disabled
               comm-id layout style description description-tooltip
               &allow-other-keys)

make-interactive-alist

Macro

(make-interactive-alist schemas place &key key test owner name)

make-interactive-hash-table

Macro

(make-interactive-hash-table schemas place &key owner name)

make-interactive-plist

Macro

(make-interactive-plist schemas place &key owner name)

make-label

Function

(make-label &rest initargs &key value placeholder comm-id layout style
            description description-tooltip &allow-other-keys)

make-layout

Function

(make-layout &rest initargs &key comm-id 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)

Function

(make-link &rest initargs &key comm-id source target &allow-other-keys)

make-output

Function

(make-output &rest initargs &key comm-id layout msg-id outputs
             &allow-other-keys)

make-output-widget-stream

Function

(make-output-widget-stream output &optional error-output)

make-password

Function

(make-password &rest initargs &key value placeholder continuous-update disabled
               comm-id layout style description description-tooltip
               &allow-other-keys)

make-play

Function

(make-play &rest initargs &key value step max min disabled comm-id layout style
           description description-tooltip interval show-repeat
           &allow-other-keys)

make-progress-style

Function

(make-progress-style &rest initargs &key comm-id description-width bar-color
                     &allow-other-keys)

make-radio-buttons

Function

(make-radio-buttons &rest initargs &key index disabled comm-id layout style
                    description description-tooltip rows options
                    &allow-other-keys)

make-select

Function

(make-select &rest initargs &key index disabled comm-id layout style
             description description-tooltip rows options &allow-other-keys)

make-select-multiple

Function

(make-select-multiple &rest initargs &key disabled comm-id layout style
                      description description-tooltip rows index options
                      &allow-other-keys)

make-selection-range-slider

Function

(make-selection-range-slider &rest initargs &key continuous-update orientation
                             disabled comm-id layout style description
                             description-tooltip readout readout-format options
                             index &allow-other-keys)

make-selection-slider

Function

(make-selection-slider &rest initargs &key index continuous-update orientation
                       disabled comm-id layout style description
                       description-tooltip readout readout-format options
                       &allow-other-keys)

make-sidecar

Function

(make-sidecar &rest initargs &key comm-id layout msg-id outputs title
              &allow-other-keys)

make-slider-style

Function

(make-slider-style &rest initargs &key comm-id description-width handle-color
                   &allow-other-keys)

make-tab

Function

(make-tab &rest initargs &key comm-id layout box-style children selected-index
          &allow-other-keys)

make-text

Function

(make-text &rest initargs &key value placeholder continuous-update disabled
           comm-id layout style description description-tooltip
           &allow-other-keys)

make-text-area

Function

(make-text-area &rest initargs &key value placeholder continuous-update
                disabled comm-id layout style description description-tooltip
                rows &allow-other-keys)

make-toggle-button

Function

(make-toggle-button &rest initargs &key value tooltip icon disabled
                    button-style comm-id layout style description
                    description-tooltip &allow-other-keys)

make-toggle-buttons

Function

(make-toggle-buttons &rest initargs &key index disabled button-style comm-id
                     layout style description description-tooltip icons options
                     tooltips &allow-other-keys)

make-toggle-buttons-style

Function

(make-toggle-buttons-style &rest initargs &key comm-id button-width
                           description-width font-weight &allow-other-keys)

make-v-box

Function

(make-v-box &rest initargs &key comm-id layout box-style children
            &allow-other-keys)

make-valid

Function

(make-valid &rest initargs &key value disabled comm-id layout style description
            description-tooltip readout &allow-other-keys)

make-video

Function

(make-video &rest initargs &key width height value format comm-id layout
            autoplay controls loop &allow-other-keys)

notify-trait-change

Function

(notify-trait-change object type name old-value new-value &optional
                     (source *trait-source*))

observe

Function

(observe instance name/s handler)

on-button-click

Function

(on-button-click widget handler)

on-custom-message

Generic Function

(on-custom-message widget content buffers)

on-trait-change

Generic Function

(on-trait-change object type name old-value new-value source)

output

Class

Widget used as a context manager to display output.

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

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

Example

(use-package :jupyter-widgets)
(defvar out (make-instance 'output))
(with-output out
  (print "prints to output area")
Precedence List

output, dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • msg-id — Parent message id of messages to capture
    • :initarg :msg-id
  • outputs — The output messages synced from the frontend.
    • :initarg :outputs
Methods
  • widget-outputs — The output messages synced from the frontend.

      (setf (widget-outputs (output output)) new-value)
    
  • widget-outputs — The output messages synced from the frontend.

      (widget-outputs (output output))
    
  • widget-msg-id — Parent message id of messages to capture

      (setf (widget-msg-id (output output)) new-value)
    
  • widget-msg-id — Parent message id of messages to capture

      (widget-msg-id (output output))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

password

Class

Single line textbox widget.

Precedence List

password, text, base-text, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, continuous-update-slot, placeholder-slot, string-value-slot, standard-object, slot-object, t

Slots
  • value — String value
    • :initarg :value
  • placeholder — Placeholder text to display when nothing has been typed.
    • :initarg :placeholder
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (setf (widget-placeholder (placeholder-slot placeholder-slot)) new-value)
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (widget-placeholder (placeholder-slot placeholder-slot))
    
  • widget-value — String value

      (setf (widget-value (string-value-slot string-value-slot)) new-value)
    
  • widget-value — String value

      (widget-value (string-value-slot string-value-slot))
    

play

Class

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

Precedence List

play, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, int-min-max-slots, int-step-slot, int-value-slot, standard-object, slot-object, t

Slots
  • value — Int value
    • :initarg :value
  • step — Minimum step to increment the value
    • :initarg :step
  • max — Max value
    • :initarg :max
  • min — Min value
    • :initarg :min
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • %playing — Whether the control is currently playing.
    • :initarg :%playing
  • %repeat — Whether the control will repeat in a continous loop.
    • :initarg :%repeat
  • interval — The maximum value for the play control.
    • :initarg :interval
  • show-repeat — Show the repeat toggle button in the widget.
    • :initarg :show-repeat
Methods
  • widget-show-repeat — Show the repeat toggle button in the widget.

      (setf (widget-show-repeat (play play)) new-value)
    
  • widget-show-repeat — Show the repeat toggle button in the widget.

      (widget-show-repeat (play play))
    
  • widget-interval — The maximum value for the play control.

      (setf (widget-interval (play play)) new-value)
    
  • widget-interval — The maximum value for the play control.

      (widget-interval (play play))
    
  • widget-%repeat — Whether the control will repeat in a continous loop.

      (setf (widget-%repeat (play play)) new-value)
    
  • widget-%repeat — Whether the control will repeat in a continous loop.

      (widget-%repeat (play play))
    
  • widget-%playing — Whether the control is currently playing.

      (setf (widget-%playing (play play)) new-value)
    
  • widget-%playing — Whether the control is currently playing.

      (widget-%playing (play play))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w int-min-max-slots) (type (eql int)) name value)
    
  • widget-min — Min value

      (setf (widget-min (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-min — Min value

      (widget-min (int-min-max-slots int-min-max-slots))
    
  • widget-max — Max value

      (setf (widget-max (int-min-max-slots int-min-max-slots)) new-value)
    
  • widget-max — Max value

      (widget-max (int-min-max-slots int-min-max-slots))
    
  • widget-step — Minimum step to increment the value

      (setf (widget-step (int-step-slot int-step-slot)) new-value)
    
  • widget-step — Minimum step to increment the value

      (widget-step (int-step-slot int-step-slot))
    
  • widget-value — Int value

      (setf (widget-value (int-value-slot int-value-slot)) new-value)
    
  • widget-value — Int value

      (widget-value (int-value-slot int-value-slot))
    

progress-style

Class

Progress style widget.

Precedence List

progress-style, description-style, style, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • description-width — Width of the description to the side of the control.
    • :initarg :description-width
  • bar-color — Color of the slider handle.
    • :initarg :bar-color
Methods
  • widget-bar-color — Color of the slider handle.

      (setf (widget-bar-color (progress-style progress-style)) new-value)
    
  • widget-bar-color — Color of the slider handle.

      (widget-bar-color (progress-style progress-style))
    
  • widget-description-width — Width of the description to the side of the control.

      (setf (widget-description-width (description-style description-style))
              new-value)
    
  • widget-description-width — Width of the description to the side of the control.

      (widget-description-width (description-style description-style))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

radio-buttons

Class

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

Precedence List

radio-buttons, select, base-select, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, %options-labels-slot, disabled-slot, index-slot, standard-object, slot-object, t

Slots
  • index — Selected index
    • :initarg :index
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • %options-labels — The labels for the options.
    • :initarg :%options-labels
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • rows — The number of rows to display.
    • :initarg :rows
  • options — The option values that correspond to the labels
    • :initarg :options
Methods
  • on-trait-change

      (on-trait-change (instance select) type (name (eql index)) old-value
                       new-value source)
    
  • widget-value

      (setf (widget-value (instance select)) new-value)
    
  • widget-value

      (widget-value (instance select))
    
  • widget-options — The option values that correspond to the labels

      (setf (widget-options (select select)) new-value)
    
  • widget-options — The option values that correspond to the labels

      (widget-options (select select))
    
  • widget-rows — The number of rows to display.

      (setf (widget-rows (base-select base-select)) new-value)
    
  • widget-rows — The number of rows to display.

      (widget-rows (base-select base-select))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int)) name value)
    
  • widget-%options-labels — The labels for the options.

      (setf (widget-%options-labels (%options-labels-slot %options-labels-slot))
              new-value)
    
  • widget-%options-labels — The labels for the options.

      (widget-%options-labels (%options-labels-slot %options-labels-slot))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-index — Selected index

      (setf (widget-index (index-slot index-slot)) new-value)
    
  • widget-index — Selected index

      (widget-index (index-slot index-slot))
    

register-widgets

Macro

(register-widgets &rest names)

select

Class

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

Precedence List

select, base-select, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, %options-labels-slot, disabled-slot, index-slot, standard-object, slot-object, t

Slots
  • index — Selected index
    • :initarg :index
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • %options-labels — The labels for the options.
    • :initarg :%options-labels
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • rows — The number of rows to display.
    • :initarg :rows
  • options — The option values that correspond to the labels
    • :initarg :options
Methods
  • on-trait-change

      (on-trait-change (instance select) type (name (eql index)) old-value
                       new-value source)
    
  • widget-value

      (setf (widget-value (instance select)) new-value)
    
  • widget-value

      (widget-value (instance select))
    
  • widget-options — The option values that correspond to the labels

      (setf (widget-options (select select)) new-value)
    
  • widget-options — The option values that correspond to the labels

      (widget-options (select select))
    
  • widget-rows — The number of rows to display.

      (setf (widget-rows (base-select base-select)) new-value)
    
  • widget-rows — The number of rows to display.

      (widget-rows (base-select base-select))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int)) name value)
    
  • widget-%options-labels — The labels for the options.

      (setf (widget-%options-labels (%options-labels-slot %options-labels-slot))
              new-value)
    
  • widget-%options-labels — The labels for the options.

      (widget-%options-labels (%options-labels-slot %options-labels-slot))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-index — Selected index

      (setf (widget-index (index-slot index-slot)) new-value)
    
  • widget-index — Selected index

      (widget-index (index-slot index-slot))
    

select-multiple

Class

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

Precedence List

select-multiple, base-select, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, %options-labels-slot, disabled-slot, standard-object, slot-object, t

Slots
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • %options-labels — The labels for the options.
    • :initarg :%options-labels
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • rows — The number of rows to display.
    • :initarg :rows
  • index — Selected indicies
    • :initarg :index
  • options — The option values that correspond to the labels
    • :initarg :options
Methods
  • on-trait-change

      (on-trait-change (instance select-multiple) type (name (eql index))
                       old-value new-value source)
    
  • widget-value

      (setf (widget-value (instance select-multiple)) new-value)
    
  • widget-value

      (widget-value (instance select-multiple))
    
  • widget-options — The option values that correspond to the labels

      (setf (widget-options (select-multiple select-multiple)) new-value)
    
  • widget-options — The option values that correspond to the labels

      (widget-options (select-multiple select-multiple))
    
  • widget-index — Selected indicies

      (setf (widget-index (select-multiple select-multiple)) new-value)
    
  • widget-index — Selected indicies

      (widget-index (select-multiple select-multiple))
    
  • widget-rows — The number of rows to display.

      (setf (widget-rows (base-select base-select)) new-value)
    
  • widget-rows — The number of rows to display.

      (widget-rows (base-select base-select))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int)) name value)
    
  • widget-%options-labels — The labels for the options.

      (setf (widget-%options-labels (%options-labels-slot %options-labels-slot))
              new-value)
    
  • widget-%options-labels — The labels for the options.

      (widget-%options-labels (%options-labels-slot %options-labels-slot))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    

selection-range-slider

Class

Slider to select multiple contiguous items from a list.

Precedence List

selection-range-slider, label-slider, base-slider, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, orientation-slot, continuous-update-slot, %options-labels-slot, standard-object, slot-object, t

Slots
  • %options-labels — The labels for the options.
    • :initarg :%options-labels
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • orientation — Vertical or horizontal.
    • :initarg :orientation
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • readout — Display the current value of the slider next to it.
    • :initarg :readout
  • readout-format — Format for the readout
    • :initarg :readout-format
  • options — The option values that correspond to the labels
    • :initarg :options
  • index — Min and max selected indices
    • :initarg :index
Methods
  • on-trait-change

      (on-trait-change (instance selection-range-slider) type (name (eql index))
                       old-value new-value source)
    
  • widget-value

      (setf (widget-value (instance selection-range-slider)) new-value)
    
  • widget-value

      (widget-value (instance selection-range-slider))
    
  • widget-index — Min and max selected indices

      (setf (widget-index (selection-range-slider selection-range-slider))
              new-value)
    
  • widget-index — Min and max selected indices

      (widget-index (selection-range-slider selection-range-slider))
    
  • widget-options — The option values that correspond to the labels

      (setf (widget-options (label-slider label-slider)) new-value)
    
  • widget-options — The option values that correspond to the labels

      (widget-options (label-slider label-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (base-slider base-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (base-slider base-slider))
    
  • widget-readout — Display the current value of the slider next to it.

      (setf (widget-readout (base-slider base-slider)) new-value)
    
  • widget-readout — Display the current value of the slider next to it.

      (widget-readout (base-slider base-slider))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-orientation — Vertical or horizontal.

      (setf (widget-orientation (orientation-slot orientation-slot)) new-value)
    
  • widget-orientation — Vertical or horizontal.

      (widget-orientation (orientation-slot orientation-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int)) name value)
    
  • widget-%options-labels — The labels for the options.

      (setf (widget-%options-labels (%options-labels-slot %options-labels-slot))
              new-value)
    
  • widget-%options-labels — The labels for the options.

      (widget-%options-labels (%options-labels-slot %options-labels-slot))
    

selection-slider

Class

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

Precedence List

selection-slider, label-slider, base-slider, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, orientation-slot, continuous-update-slot, %options-labels-slot, index-slot, standard-object, slot-object, t

Slots
  • index — Selected index
    • :initarg :index
  • %options-labels — The labels for the options.
    • :initarg :%options-labels
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • orientation — Vertical or horizontal.
    • :initarg :orientation
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • readout — Display the current value of the slider next to it.
    • :initarg :readout
  • readout-format — Format for the readout
    • :initarg :readout-format
  • options — The option values that correspond to the labels
    • :initarg :options
Methods
  • on-trait-change

      (on-trait-change (instance selection-slider) type (name (eql index))
                       old-value new-value source)
    
  • widget-value

      (setf (widget-value (instance selection-slider)) new-value)
    
  • widget-value

      (widget-value (instance selection-slider))
    
  • widget-options — The option values that correspond to the labels

      (setf (widget-options (label-slider label-slider)) new-value)
    
  • widget-options — The option values that correspond to the labels

      (widget-options (label-slider label-slider))
    
  • widget-readout-format — Format for the readout

      (setf (widget-readout-format (base-slider base-slider)) new-value)
    
  • widget-readout-format — Format for the readout

      (widget-readout-format (base-slider base-slider))
    
  • widget-readout — Display the current value of the slider next to it.

      (setf (widget-readout (base-slider base-slider)) new-value)
    
  • widget-readout — Display the current value of the slider next to it.

      (widget-readout (base-slider base-slider))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-orientation — Vertical or horizontal.

      (setf (widget-orientation (orientation-slot orientation-slot)) new-value)
    
  • widget-orientation — Vertical or horizontal.

      (widget-orientation (orientation-slot orientation-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int-list)) name value)
    
  • validate-trait

      (validate-trait (w %options-labels-slot) (type (eql int)) name value)
    
  • widget-%options-labels — The labels for the options.

      (setf (widget-%options-labels (%options-labels-slot %options-labels-slot))
              new-value)
    
  • widget-%options-labels — The labels for the options.

      (widget-%options-labels (%options-labels-slot %options-labels-slot))
    
  • widget-index — Selected index

      (setf (widget-index (index-slot index-slot)) new-value)
    
  • widget-index — Selected index

      (widget-index (index-slot index-slot))
    

send-custom

Function

(send-custom widget content &optional buffers)

sidecar

Class

Widget used as a context manager to display output.

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

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

Example

(use-package :jupyter-widgets)
(defvar out (make-instance 'output))
(with-output out
  (print "prints to output area")
Precedence List

sidecar, output, dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • msg-id — Parent message id of messages to capture
    • :initarg :msg-id
  • outputs — The output messages synced from the frontend.
    • :initarg :outputs
  • title
    • :initarg :title
Methods
  • widget-title — automatically generated writer method

      (setf (widget-title (sidecar sidecar)) new-value)
    
  • widget-title — automatically generated reader method

      (widget-title (sidecar sidecar))
    
  • widget-outputs — The output messages synced from the frontend.

      (setf (widget-outputs (output output)) new-value)
    
  • widget-outputs — The output messages synced from the frontend.

      (widget-outputs (output output))
    
  • widget-msg-id — Parent message id of messages to capture

      (setf (widget-msg-id (output output)) new-value)
    
  • widget-msg-id — Parent message id of messages to capture

      (widget-msg-id (output output))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

slider-style

Class

Precedence List

slider-style, description-style, style, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • description-width — Width of the description to the side of the control.
    • :initarg :description-width
  • handle-color — Color of the slider handle.
    • :initarg :handle-color
Methods
  • widget-handle-color — Color of the slider handle.

      (setf (widget-handle-color (slider-style slider-style)) new-value)
    
  • widget-handle-color — Color of the slider handle.

      (widget-handle-color (slider-style slider-style))
    
  • widget-description-width — Width of the description to the side of the control.

      (setf (widget-description-width (description-style description-style))
              new-value)
    
  • widget-description-width — Width of the description to the side of the control.

      (widget-description-width (description-style description-style))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

style

Class

Precedence List

style, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
Methods
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

styled-widget

Class

Precedence List

styled-widget, dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
Methods
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

tab

Class

Displays children each on a separate accordion tab.

Precedence List

tab, accordion, box, dom-widget, widget, has-traits, comm, source, standard-object, slot-object, t

Slots
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • box-style — Use a predefined styling for the box.
    • :initarg :box-style
  • children — List of widget children.
    • :initarg :children
  • %titles — Titles of the pages.
    • :initarg :%titles
  • 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.
    • :initarg :selected-index
Methods
  • validate-trait

      (validate-trait (w accordion) (type (eql int)) name value)
    
  • widget-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.

      (setf (widget-selected-index (accordion accordion)) new-value)
    
  • widget-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.

      (widget-selected-index (accordion accordion))
    
  • widget-%titles — Titles of the pages.

      (setf (widget-%titles (accordion accordion)) new-value)
    
  • widget-%titles — Titles of the pages.

      (widget-%titles (accordion accordion))
    
  • widget-children — List of widget children.

      (setf (widget-children (box box)) new-value)
    
  • widget-children — List of widget children.

      (widget-children (box box))
    
  • widget-box-style — Use a predefined styling for the box.

      (setf (widget-box-style (box box)) new-value)
    
  • widget-box-style — Use a predefined styling for the box.

      (widget-box-style (box box))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    

text

Class

Single line textbox widget.

Precedence List

text, base-text, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, continuous-update-slot, placeholder-slot, string-value-slot, standard-object, slot-object, t

Slots
  • value — String value
    • :initarg :value
  • placeholder — Placeholder text to display when nothing has been typed.
    • :initarg :placeholder
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (setf (widget-placeholder (placeholder-slot placeholder-slot)) new-value)
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (widget-placeholder (placeholder-slot placeholder-slot))
    
  • widget-value — String value

      (setf (widget-value (string-value-slot string-value-slot)) new-value)
    
  • widget-value — String value

      (widget-value (string-value-slot string-value-slot))
    

text-area

Class

Multiline text area widget.

Precedence List

text-area, text, base-text, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, disabled-slot, continuous-update-slot, placeholder-slot, string-value-slot, standard-object, slot-object, t

Slots
  • value — String value
    • :initarg :value
  • placeholder — Placeholder text to display when nothing has been typed.
    • :initarg :placeholder
  • continuous-update — Update the value of the widget as the user is holding the slider.
    • :initarg :continuous-update
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
  • rows — The number of rows to display.
    • :initarg :rows
Methods
  • widget-rows — The number of rows to display.

      (setf (widget-rows (text-area text-area)) new-value)
    
  • widget-rows — The number of rows to display.

      (widget-rows (text-area text-area))
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget))
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (setf (widget-%dom-classes (dom-widget dom-widget)) new-value)
    
  • widget-%dom-classes — CSS classes applied to widget DOM element

      (widget-%dom-classes (dom-widget dom-widget))
    
  • directional-link

      (directional-link (source widget) source-trait (target widget) target-trait
                        &optional sync)
    
  • link

      (link (source widget) source-trait (target widget) target-trait &optional
            sync)
    
  • serialize-trait

      (serialize-trait object type name (value widget))
    
  • on-trait-change

      (on-trait-change (w widget) type name old-value new-value source)
    
  • jupyter:on-comm-message

      (on-comm-message (w widget) data metadata buffers)
    
  • jupyter:mime-bundle-data

      (mime-bundle-data (w widget))
    
  • widget-%view-module-version — A semver requirement for namespace version containing the view.

      (widget-%view-module-version (widget widget))
    
  • widget-%view-module — The namespace for the view.

      (widget-%view-module (widget widget))
    
  • widget-%view-name — Name of the view.

      (widget-%view-name (widget widget))
    
  • widget-%module-module-version — A semver requirement for namespace version containing the model.

      (widget-%module-module-version (widget widget))
    
  • widget-%module-module — The namespace for the model.

      (widget-%module-module (widget widget))
    
  • widget-%module-name — Name of the model.

      (widget-%module-name (widget widget))
    
  • on-trait-change

      (on-trait-change (w has-traits) type name old-value new-value source)
    
  • widget-on-trait-change — Instance specific trait notification

      (setf (widget-on-trait-change (has-traits has-traits)) new-value)
    
  • widget-on-trait-change — Instance specific trait notification

      (widget-on-trait-change (has-traits has-traits))
    
  • jupyter:comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • widget-disabled — Enable or disable user changes.

      (setf (widget-disabled (disabled-slot disabled-slot)) new-value)
    
  • widget-disabled — Enable or disable user changes.

      (widget-disabled (disabled-slot disabled-slot))
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (setf (widget-continuous-update
             (continuous-update-slot continuous-update-slot))
              new-value)
    
  • widget-continuous-update — Update the value of the widget as the user is holding the slider.

      (widget-continuous-update (continuous-update-slot continuous-update-slot))
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (setf (widget-placeholder (placeholder-slot placeholder-slot)) new-value)
    
  • widget-placeholder — Placeholder text to display when nothing has been typed.

      (widget-placeholder (placeholder-slot placeholder-slot))
    
  • widget-value — String value

      (setf (widget-value (string-value-slot string-value-slot)) new-value)
    
  • widget-value — String value

      (widget-value (string-value-slot string-value-slot))
    

toggle-button

Class

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

Precedence List

toggle-button, description-widget, styled-widget, dom-widget, widget, has-traits, comm, source, button-style-slot, disabled-slot, icon-slot, tooltip-slot, bool-value-slot, standard-object, slot-object, t

Slots
  • value — Bool value
    • :initarg :value
  • tooltip — Tooltip caption.
    • :initarg :tooltip
  • icon — Font-awesome icon name, without the ‘fa-‘ prefix.
    • :initarg :icon
  • disabled — Enable or disable user changes.
    • :initarg :disabled
  • button-style — Use a predefined styling for the button.
    • :initarg :button-style
  • jupyter::sink
    • :initarg :sink
  • jupyter:comm-id
    • :initarg :comm-id
  • jupyter::target-name
    • :initarg :target-name
  • jupyter:kernel
    • :initarg :kernel
  • on-trait-change — Instance specific trait notification
    • :initarg :on-trait-change
  • %model-name — Name of the model.
    • :initarg :%model-name
  • %model-module — The namespace for the model.
    • :initarg :%model-module
  • %model-module-version — A semver requirement for namespace version containing the model.
    • :initarg :%model-module-version
  • %view-name — Name of the view.
    • :initarg :%view-name
  • %view-module — The namespace for the view.
    • :initarg :%view-module
  • %view-module-version — A semver requirement for namespace version containing the view.
    • :initarg :%view-module-version
  • %dom-classes — CSS classes applied to widget DOM element
    • :initarg :%dom-classes
  • layout — Reference to layout widget.
    • :initarg :layout
  • style — Reference to style widget.
    • :initarg :style
  • description — Description of the control.
    • :initarg :description
  • description-tooltip — Tooltip for the description (defaults to description).
    • :initarg :description-tooltip
Methods
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (setf (widget-description-tooltip (description-widget description-widget))
              new-value)
    
  • widget-description-tooltip — Tooltip for the description (defaults to description).

      (widget-description-tooltip (description-widget description-widget))
    
  • widget-description — Description of the control.

      (setf (widget-description (description-widget description-widget))
              new-value)
    
  • widget-description — Description of the control.

      (widget-description (description-widget description-widget))
    
  • widget-style — Reference to style widget.

      (setf (widget-style (styled-widget styled-widget)) new-value)
    
  • widget-style — Reference to style widget.

      (widget-style (styled-widget styled-widget))
    
  • widget-layout — Reference to layout widget.

      (setf (widget-layout (dom-widget dom-widget)) new-value)
    
  • widget-layout — Reference to layout widget.

      (widget-layout (dom-widget dom-widget