@jupyter-widgets/schema
Version:
Schemas for the Jupyter interactive Widgets
413 lines (365 loc) • 111 kB
Markdown
# Model State
This is a description of the model state for each widget in the core Jupyter widgets library. The model ID of a widget is the id of the comm object the widget is using. A reference to a widget is serialized to JSON as a string of the form `"IPY_MODEL_<MODEL_ID>"`, where `<MODEL_ID>` is the model ID of a previously created widget of the specified type.
This model specification is for ipywidgets 6.0 and jupyter-js-widgets 2.1.0.
## Model attributes
Each widget in the Jupyter core widgets is represented below. The heading represents the string the widget is registered with in the kernel.
### Jupyter.Accordion
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------------------------------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'AccordionModel'` |
| `_titles` | object | `{}` | Titles of the pages |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'AccordionView'` |
| `box_style` | string (one of `'success'`, `'info'`, `'warning'`, `'danger'`, `''`) | `''` | Use a predefined styling for the box. |
| `children` | array | `[]` |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `selected_index` | number (integer) | `0` |
### Jupyter.BoundedFloatText
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'FloatTextModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'FloatTextView'` |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `max` | number (float) | `100.0` | Max value |
| `min` | number (float) | `0.0` | Min value |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `step` | number (float) | `0.1` | Minimum step to increment the value (ignored by some views) |
| `value` | number (float) | `0.0` | Float value |
### Jupyter.BoundedIntText
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'IntTextModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'IntTextView'` |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `max` | number (integer) | `100` | Max value |
| `min` | number (integer) | `0` | Min value |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `step` | number (integer) | `1` | Minimum step to increment the value (ignored by some views) |
| `value` | number (integer) | `0` | Int value |
### Jupyter.Box
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------------------------------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'BoxModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'BoxView'` |
| `box_style` | string (one of `'success'`, `'info'`, `'warning'`, `'danger'`, `''`) | `''` | Use a predefined styling for the box. |
| `children` | array | `[]` |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
### Jupyter.Button
| Attribute | Type | Default | Help |
| ----------------------- | --------------------------------------------------------------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'ButtonModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'ButtonView'` |
| `button_style` | string (one of `'primary'`, `'success'`, `'info'`, `'warning'`, `'danger'`, `''`) | `''` | Use a predefined styling for the button. |
| `description` | string | `''` | Button label. |
| `disabled` | boolean | `false` | Enable or disable user changes. |
| `icon` | string | `''` | Font-awesome icon name, without the 'fa-' prefix. |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `style` | reference to ButtonStyle widget | reference to new instance |
| `tooltip` | string | `''` | Tooltip caption of the button. |
### Jupyter.ButtonStyle
| Attribute | Type | Default | Help |
| ----------------------- | ---------------- | ---------------------- | --------------------------------------------------------------------------------------------- |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'ButtonStyleModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'StyleView'` |
| `button_color` | `null` or string | `null` | Color of the button |
| `font_weight` | string | `''` |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
### Jupyter.Checkbox
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'CheckboxModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'CheckboxView'` |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes. |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `value` | boolean | `false` | Bool value |
### Jupyter.ColorPicker
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'ColorPickerModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'ColorPickerView'` |
| `concise` | boolean | `false` |
| `description` | string | `''` | Description of the control. |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `value` | string | `'black'` |
### Jupyter.Controller
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'ControllerModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'ControllerView'` |
| `axes` | array | `[]` |
| `buttons` | array | `[]` |
| `connected` | boolean | `false` |
| `index` | number (integer) | `0` |
| `layout` | reference to Layout widget | reference to new instance |
| `mapping` | string | `''` |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `name` | string | `''` |
| `timestamp` | number (float) | `0.0` |
### Jupyter.ControllerAxis
| Attribute | Type | Default | Help |
| ----------------------- | ---------------- | ----------------------- | --------------------------------------------------------------------------------------------- |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'ControllerAxisModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'ControllerAxisView'` |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `value` | number (float) | `0.0` |
### Jupyter.ControllerButton
| Attribute | Type | Default | Help |
| ----------------------- | ---------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'ControllerButtonModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'ControllerButtonView'` |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `pressed` | boolean | `false` |
| `value` | number (float) | `0.0` |
### Jupyter.DatePicker
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'DatePickerModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'DatePickerView'` |
| `description` | string | `''` | Description of the control. |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `value` | `null` or Datetime | `null` |
### Jupyter.Dropdown
| Attribute | Type | Default | Help |
| ----------------------- | --------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'DropdownModel'` |
| `_options_labels` | array | `[]` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'DropdownView'` |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `value` | string (valid option label) | `null` | Selected value |
### Jupyter.FloatProgress
| Attribute | Type | Default | Help |
| ----------------------- | ------------------------------------------------------------------------------ | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'ProgressModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'ProgressView'` |
| `bar_style` | `null` or string (one of `'success'`, `'info'`, `'warning'`, `'danger'`, `''`) | `''` | Use a predefined styling for the progress bar. |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `max` | number (float) | `100.0` | Max value |
| `min` | number (float) | `0.0` | Min value |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `orientation` | string (one of `'horizontal'`, `'vertical'`) | `'horizontal'` | Vertical or horizontal. |
| `step` | number (float) | `0.1` | Minimum step to increment the value (ignored by some views) |
| `style` | reference to ProgressStyle widget | reference to new instance |
| `value` | number (float) | `0.0` | Float value |
### Jupyter.FloatRangeSlider
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'FloatSliderModel'` |
| `_range` | boolean | `true` | Display a range selector |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'FloatSliderView'` |
| `continuous_update` | boolean | `true` | Update the value of the widget as the user is sliding the slider. |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `max` | number (float) | `100.0` | Max value |
| `min` | number (float) | `0.0` | Min value |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `orientation` | string (one of `'horizontal'`, `'vertical'`) | `'horizontal'` | Vertical or horizontal. |
| `readout` | boolean | `true` | Display the current value of the slider next to it. |
| `slider_color` | `null` or string | `null` |
| `step` | number (float) | `1.0` | Minimum step that the value can take (ignored by some views) |
| `value` | array | `[0.0, 1.0]` | Tuple of (lower, upper) bounds |
### Jupyter.FloatSlider
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'FloatSliderModel'` |
| `_range` | boolean | `false` | Display a range selector |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'FloatSliderView'` |
| `continuous_update` | boolean | `true` | Update the value of the widget as the user is holding the slider. |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `max` | number (float) | `100.0` | Max value |
| `min` | number (float) | `0.0` | Min value |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `orientation` | string (one of `'horizontal'`, `'vertical'`) | `'horizontal'` | Vertical or horizontal. |
| `readout` | boolean | `true` | Display the current value of the slider next to it. |
| `readout_format` | string | `'.2f'` | Format for the readout |
| `slider_color` | `null` or string | `null` |
| `step` | number (float) | `0.1` | Minimum step to increment the value (ignored by some views) |
| `value` | number (float) | `0.0` | Float value |
### Jupyter.FloatText
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'FloatTextModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'FloatTextView'` |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `value` | number (float) | `0.0` | Float value |
### Jupyter.HBox
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------------------------------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'HBoxModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'HBoxView'` |
| `box_style` | string (one of `'success'`, `'info'`, `'warning'`, `'danger'`, `''`) | `''` | Use a predefined styling for the box. |
| `children` | array | `[]` |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
### Jupyter.HTML
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'HTMLModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'HTMLView'` |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `placeholder` | string | `'\u200b'` | Placeholder text to display when nothing has been typed |
| `value` | string | `''` | String value |
### Jupyter.HTMLMath
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'HTMLMathModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'HTMLMathView'` |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `placeholder` | string | `'\u200b'` | Placeholder text to display when nothing has been typed |
| `value` | string | `''` | String value |
### Jupyter.Image
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_b64value` | string | `''` |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'ImageModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'ImageView'` |
| `format` | string | `'png'` |
| `height` | string | `''` |
| `layout` | reference to Layout widget | reference to new instance |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the front-end can send before receiving an idle msg from the back-end. |
| `width` | string | `''` |
### Jupyter.IntProgress
| Attribute | Type | Default | Help |
| ----------------------- | -------------------------------------------------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
| `_dom_classes` | array | `[]` | CSS classes applied to widget DOM element |
| `_model_module` | string | `'jupyter-js-widgets'` |
| `_model_module_version` | string | `'~2.1.0'` |
| `_model_name` | string | `'ProgressModel'` |
| `_view_module` | string | `'jupyter-js-widgets'` |
| `_view_module_version` | string | `'~2.1.0'` |
| `_view_name` | string | `'ProgressView'` |
| `bar_style` | string (one of `'success'`, `'info'`, `'warning'`, `'danger'`, `''`) | `''` | Use a predefined styling for the progress bar. |
| `description` | string | `''` | Description of the control. |
| `disabled` | boolean | `false` | Enable or disable user changes |
| `layout` | reference to Layout widget | reference to new instance |
| `max` | number (integer) | `100` | Max value |
| `min` | number (integer) | `0` | Min value |
| `msg_throttle` | number (integer) | `1` | Maximum number of msgs the f