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.
-
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.
-
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.
-
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 aPlot
, the aspect ratioplot_width/plot_height
is maintained."scale_height"
elements will responsively resize to fit to the height available, while maintaining the original aspect ratio. For aPlot
, the aspect ratioplot_width/plot_height
is maintained. A plot with"scale_height"
mode needs to be wrapped in aRow
orColumn
to be responsive."scale_both"
elements will responsively resize to for both the width and height available, while maintaining the original aspect ratio.
-
-
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.
-
class
Spacer
(**kwargs)[source]¶ Bases:
bokeh.models.layouts.LayoutDOM
A container for space used to fill an empty spot in a row or column.