bokeh.layouts#

用于排列 bokeh 布局对象的功能。

column#

column(children: list[UIElement], *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, **kwargs: Any) → Column[源代码]#
column(*children: UIElement, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, **kwargs: Any) → Column

创建一个 Bokeh 布局对象的列。强制所有对象具有相同的 sizing_mode，这是复杂布局工作的必要条件。

参数:

  • children (LayoutDOM 列表) – 列的实例列表。可以是以下任何一项 - Plot, Widget, Row, Column, Spacer。

  • sizing_mode ("fixed", "stretch_both", "scale_width", "scale_height", "scale_both") – 布局中的项目将如何调整大小以填充可用空间。默认为 "fixed"。有关不同模式的更多信息，请参阅 sizing_mode 在 LayoutDOM 上的描述。

返回:

一个 LayoutDOM 对象的列，所有对象都具有相同的 sizing_mode。

返回类型:

Column

示例

>>> column(plot1, plot2)
>>> column(children=[widgets, plot], sizing_mode='stretch_both')

grid#

grid(children: list[UIElement | list[UIElement | list[Any]]], *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None) → GridBox[源代码]#
grid(children: Row | Column, *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None) → GridBox
grid(children: list[UIElement | None], *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, nrows: int) → GridBox
grid(children: list[UIElement | None], *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, ncols: int) → GridBox
grid(children: list[UIElement | None], *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, nrows: int, ncols: int) → GridBox
grid(children: str, *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None) → GridBox

方便地创建可布局对象的网格。

网格是通过使用 GridBox 模型创建的。这提供了对网格布局的最大控制，但也可能很繁琐，并可能导致实际应用中代码难以阅读。grid() 函数通过降低控制级别来弥补这一点，但反过来提供了更方便的 API。

支持的模式

  1. 可布局对象的嵌套列表。假定顶层列表表示一列，并在后续嵌套级别中在行和列之间交替。可以使用 None 进行填充。

    >>> grid([p1, [[p2, p3], p4]])
GridBox(children=[
    (p1, 0, 0, 1, 2),
    (p2, 1, 0, 1, 1),
    (p3, 2, 0, 1, 1),
    (p4, 1, 1, 2, 1),
])

  2. 嵌套的 Row 和 Column 实例。与第一种模式类似，只是它使用嵌套的 Row 和 Column 模型，而不是使用嵌套列表。这可能比前者更具可读性。但是请注意，仅使用未设置 sizing_mode 的模型。

    >>> grid(column(p1, row(column(p2, p3), p4)))
GridBox(children=[
    (p1, 0, 0, 1, 2),
    (p2, 1, 0, 1, 1),
    (p3, 2, 0, 1, 1),
    (p4, 1, 1, 2, 1),
])

  3. 可布局对象的扁平列表。这需要设置 nrows 和/或 ncols。输入列表将相应地重新排列为 2D 数组。可以使用 None 进行填充。

    >>> grid([p1, p2, p3, p4], ncols=2)
GridBox(children=[
    (p1, 0, 0, 1, 1),
    (p2, 0, 1, 1, 1),
    (p3, 1, 0, 1, 1),
    (p4, 1, 1, 1, 1),
])

gridplot#

gridplot(children: list[UIElement | None], *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, toolbar_location: Literal['above', 'below', 'left', 'right'] | None = 'above', ncols: int, width: int | None = None, height: int | None = None, toolbar_options: dict[ToolbarOptions, Any] | None = None, merge_tools: bool = True) → GridPlot[源代码]#
gridplot(children: list[list[UIElement | None]], *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, toolbar_location: Literal['above', 'below', 'left', 'right'] | None = 'above', ncols: None = None, width: int | None = None, height: int | None = None, toolbar_options: dict[ToolbarOptions, Any] | None = None, merge_tools: bool = True) → GridPlot

在单独的画布上创建绘图网格。

gridplot 函数为网格中的所有绘图构建单个工具栏。gridplot 旨在布局一组绘图。 对于常规网格布局，请使用 layout() 函数。

参数:

  • children (Plot 对象列表或列表的列表) – 要在网格中显示的绘图数组，以 Plot 对象列表的列表形式给出。 要在网格中留空位置，请在 children 列表中为该位置传递 None。 或者，如果使用 ncols 调用，则为 Plot 的列表。

  • sizing_mode ("fixed", "stretch_both", "scale_width", "scale_height", "scale_both") – 布局中的项目将如何调整大小以填充可用空间。默认为 "fixed"。有关不同模式的更多信息，请参阅 sizing_mode 在 LayoutDOM 上的描述。

  • toolbar_location (above, below, left, right) – 工具栏相对于网格的位置。 默认为 above。 如果设置为 None，则不会将工具栏附加到网格。

  • ncols (int, 可选) – 指定您希望网格中包含的列数。 使用 ncols 时，您必须仅传递未嵌套的绘图列表（而不是绘图列表的列表）。

  • width (int, 可选) – 您希望所有绘图都具有的宽度

  • height (int, 可选) – 您希望所有绘图都具有的高度。

  • toolbar_options (dict, 可选) – 将用于构建网格工具栏（Toolbar 的实例）的选项字典。 如果未提供，则将使用 Toolbar 的默认值。

  • merge_tools (True, False) – 将所有子绘图的工具合并到单个工具栏中。

返回类型:

GridPlot

示例

>>> gridplot([[plot_1, plot_2], [plot_3, plot_4]])
>>> gridplot([plot_1, plot_2, plot_3, plot_4], ncols=2, width=200, height=100)
>>> gridplot(
        children=[[plot_1, plot_2], [None, plot_3]],
        toolbar_location='right'
        sizing_mode='fixed',
        toolbar_options=dict(logo='gray')
    )

layout#

layout(*args: UIElement, children: list[UIElement] | None = None, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, **kwargs: Any) → Column[source]#

创建基于网格的 Bokeh 布局对象排列。

参数:

  • children (LayoutDOM 对象列表的列表) – 网格布局的实例列表的列表。 可以是以下任何一种 - Plot, Widget, Row, Column, Spacer。

  • sizing_mode ("fixed", "stretch_both", "scale_width", "scale_height", "scale_both") – 布局中的项目将如何调整大小以填充可用空间。默认为 "fixed"。有关不同模式的更多信息，请参阅 sizing_mode 在 LayoutDOM 上的描述。

返回:

子项的 Row 布局列，所有列都具有相同的 sizing_mode。

返回类型:

Column

示例

>>> layout([[plot_1, plot_2], [plot_3, plot_4]])
>>> layout(
        children=[
            [widget_1, plot_1],
            [slider],
            [widget_2, plot_2, plot_3]
        ],
        sizing_mode='fixed',
    )

row#

row(children: list[UIElement], *, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, **kwargs: Any) → Row[source]#
row(*children: UIElement, sizing_mode: Literal['stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both', 'fixed', 'inherit'] | None = None, **kwargs: Any) → Row

创建一行 Bokeh 布局对象。 强制所有对象具有相同的 sizing_mode，这是复杂布局工作所必需的。

参数:

  • children (LayoutDOM 对象列表) – 行的实例列表。 可以是以下任何一种 - Plot, Widget, Row, Column, Spacer。

  • sizing_mode ("fixed", "stretch_both", "scale_width", "scale_height", "scale_both") – 布局中的项目将如何调整大小以填充可用空间。默认为 "fixed"。有关不同模式的更多信息，请参阅 sizing_mode 在 LayoutDOM 上的描述。

返回:

所有具有相同 sizing_mode 的 LayoutDOM 对象的行。

返回类型:

Row

示例

>>> row(plot1, plot2)
>>> row(children=[widgets, plot], sizing_mode='stretch_both')

Spacer#

class Spacer(*args: Any, id: ID | None = None, **kwargs: Any)[source]

用于填充行或列中空白区域的空间容器。