bokeh.models.layouts¶

Various kinds of layout components.

class Box(*args, **kwargs)[source]¶

Bases: bokeh.models.layouts.LayoutDOM

Abstract base class for Row and Column. Do not use directly.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

children¶

property type: List ( Instance ( LayoutDOM ) )

The list of children, which can be other components including plots, rows, columns, and widgets.

{
  "children": [],
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "3cf0389d-363e-4bdf-b581-9e583191a9cb",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "width": null
}

class Column(*args, **kwargs)[source]¶

Bases: bokeh.models.layouts.Box

Lay out child components in a single vertical row.

Children can be specified as positional arguments, as a single argument that is a sequence, or using the children keyword argument.

{
  "children": [],
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "58ec11e2-c93b-421c-9e35-019d34461eec",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "width": null
}

class LayoutDOM(**kwargs)[source]¶

Bases: bokeh.model.Model

An abstract base class for layout components.

Note

This is an abstract base class used to help organize the hierarchy of Bokeh model types. It is not useful to instantiate on its own.

css_classes¶

property type: List ( String )

A list of css class names to add to this DOM element. Note: the class names are simply added as-is, no other guarantees are provided.

It is also permissible to assign from tuples, however these are adapted – the property will always contain a list.

disabled¶

property type: Bool

Whether the widget will be disabled when rendered. If True, the widget will be greyed-out, and not respond to UI events.

height¶

property type: Int

An optional height for the component (in pixels).

sizing_mode¶

property type: Enum ( SizingMode )

How the item being displayed should size itself. Possible values are "fixed", "scale_width", "scale_height", "scale_both", and "stretch_both".

"stretch_both" elements are completely responsive (independently in width and height) and will resize to occupy all available space, even if this changes the aspect ratio of the element. This is sometimes called outside-in, and is a typical behavior for desktop applications.

"fixed" elements are not responsive. They will retain their original width and height regardless of any subsequent browser window resize events.

"scale_width" elements will responsively resize to fit to the width available, while maintaining the original aspect ratio. This is a typical behavior for modern websites. For a Plot, the aspect ratio plot_width/plot_height is maintained.

"scale_height" elements will responsively resize to fit to the height available, while maintaining the original aspect ratio. For a Plot, the aspect ratio plot_width/plot_height is maintained. A plot with "scale_height" mode needs to be wrapped in a Row or Column to be responsive.

"scale_both" elements will responsively resize to for both the width and height available, while maintaining the original aspect ratio.

width¶

property type: Int

An optional width for the component (in pixels).

{
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "213a2976-7b4e-4afb-8deb-7b7e164d4cd3",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "width": null
}

class Row(*args, **kwargs)[source]¶

Bases: bokeh.models.layouts.Box

Lay out child components in a single horizontal row.

Children can be specified as positional arguments, as a single argument that is a sequence, or using the children keyword argument.

{
  "children": [],
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "9a81577f-cdba-454b-849c-b958a91643d8",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "width": null
}

class Spacer(**kwargs)[source]¶

Bases: bokeh.models.layouts.LayoutDOM

A container for space used to fill an empty spot in a row or column.

{
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "7e084692-ab35-4d29-a888-1ef9f456c2ef",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "width": null
}

class WidgetBox(*args, **kwargs)[source]¶

Bases: bokeh.models.layouts.LayoutDOM

A container for widgets that are part of a layout.

children¶

property type: List ( Instance ( Widget ) )

The list of widgets to put in the layout box.

{
  "children": [],
  "css_classes": [],
  "disabled": false,
  "height": null,
  "id": "c0fe5fcb-9951-412a-bf98-919da4b81170",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sizing_mode": "fixed",
  "subscribed_events": [],
  "tags": [],
  "width": null
}