sliders

各种类型的滑块组件。

class AbstractSlider(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Widget

Note

这是一个抽象基类，用于帮助组织 Bokeh 模型类型的层次结构。它本身实例化是没有用的。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "bar_color": "#e6e6e6", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "direction": "ltr", 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67603", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "resizable": false, 
  "show_value": true, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "tooltips": true, 
  "visible": true, 
  "width": 300, 
  "width_policy": "auto"
}

align = 'auto'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件的宽度和高度之间的比例关系。

这在组件的任何尺寸可以灵活调整大小时起作用。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

bar_color = '#e6e6e6'

Type:

Color

可接受的值包括

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如，'#FF0000', '#44444444'

• CSS4 颜色字符串，例如，'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 3 元组的整数 (r, g, b)，取值范围为 0 到 255

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间

• 一个 32 位无符号整数，使用 0xRRGGBBAA 字节顺序模式

context_menu = None

Type:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 “auto”，组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

Note

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []

Type:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}

Type:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

Note

此属性是实验性的，可能会随时更改。

direction = 'ltr'

Type:

Enum(Enumeration(ltr, rtl))

disabled = False

Type:

布尔值

小部件在渲染时是否将被禁用。

如果为 True，小部件将灰显且不对 UI 事件做出响应。

elements = []

Type:

List

附加到此窗格的基于 DOM 的 UI 元素的集合。

这可以包括浮动元素（如工具提示），从而允许在此 UI 元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局是否在块或内联维度中流动。

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度尺寸调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法适应可用的垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界内（如果已设置）适应可用的垂直空间。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

Type:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

Type:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常见 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - Margin-Top、Margin-Right、Margin-Bottom 和 Margin-Left，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

对提供的任何名称不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

Type:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向定位滑块。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度中。

show_value = True

Type:

布尔值

是否显示滑块的值。

sizing_mode = None

Type:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于保持组件宽度和高度的高级设置。要获得更精细的尺寸调整控制，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果不存在父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口调整大小事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的纵横比。

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

Type:

List

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

Type:

布尔值

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。在处理我们不需要其更新值的频繁更新的对象时，设置为 False 可能有助于减少网络流量。

Note

将此属性设置为 False 将阻止触发此对象上的任何 on_change() 回调。但是，任何 JS 端回调仍然有效。

tags = []

Type:

List

要附加到此模型的任意、用户提供的值的可选列表。

在查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是一种方便的方式，可以将任何必要的元数据附加到模型，CustomJS 回调等可以访问这些元数据。

Note

不对提供的任何标签强制唯一性保证或其他条件，Bokeh 出于任何原因也不会直接使用这些标签。

title = ''

Type:

Nullable(String)

滑块的标签（支持 数学文本）。

tooltips = True

Type:

布尔值

显示工具提示中滑块的当前值。

visible = True

Type:

布尔值

组件是否应在屏幕上显示。

width = 300

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用水平空间，但不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 要用来代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除所有当前已定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值发生更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标 attr 中项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件可能也很有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

给定属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于派生自字形的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使当前对该方法的使用在未来保持有效，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集将属性名称映射到其值的字典。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象；如果未找到任何对象，则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None，可选) –

  这用于防止对 Bokeh 应用程序的“回旋镖”式更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果作为从属性名称到值的字典返回；如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document (可以为 None)

class CategoricalSlider(*args: Any, id: ID | None = None, **kwargs: Any)

基类：AbstractSlider

离散滑块，允许从值集合中进行选择。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "bar_color": "#e6e6e6", 
  "categories": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "direction": "ltr", 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67637", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "resizable": false, 
  "show_value": true, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "tooltips": true, 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "width": 300, 
  "width_policy": "auto"
}

align = 'auto'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件的宽度和高度之间的比例关系。

这在组件的任何尺寸可以灵活调整大小时起作用。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

bar_color = '#e6e6e6'

Type:

Color

可接受的值包括

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如，'#FF0000', '#44444444'

• CSS4 颜色字符串，例如，'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 3 元组的整数 (r, g, b)，取值范围为 0 到 255

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间

• 一个 32 位无符号整数，使用 0xRRGGBBAA 字节顺序模式

categories = Undefined

Type:

Required(Seq(String))

要从中选择的类别集合。

context_menu = None

Type:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 “auto”，组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

Note

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []

Type:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}

Type:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

Note

此属性是实验性的，可能会随时更改。

direction = 'ltr'

Type:

Enum(Enumeration(ltr, rtl))

disabled = False

Type:

布尔值

小部件在渲染时是否将被禁用。

如果为 True，小部件将灰显且不对 UI 事件做出响应。

elements = []

Type:

List

附加到此窗格的基于 DOM 的 UI 元素的集合。

这可以包括浮动元素（如工具提示），从而允许在此 UI 元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局是否在块或内联维度中流动。

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度尺寸调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法适应可用的垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界内（如果已设置）适应可用的垂直空间。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

Type:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

Type:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常见 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - Margin-Top、Margin-Right、Margin-Bottom 和 Margin-Left，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

对提供的任何名称不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

Type:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向定位滑块。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度中。

show_value = True

Type:

布尔值

是否显示滑块的值。

sizing_mode = None

Type:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于保持组件宽度和高度的高级设置。要获得更精细的尺寸调整控制，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果不存在父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口调整大小事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的纵横比。

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

Type:

List

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

Type:

布尔值

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。在处理我们不需要其更新值的频繁更新的对象时，设置为 False 可能有助于减少网络流量。

Note

将此属性设置为 False 将阻止触发此对象上的任何 on_change() 回调。但是，任何 JS 端回调仍然有效。

tags = []

Type:

List

要附加到此模型的任意、用户提供的值的可选列表。

在查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是一种方便的方式，可以将任何必要的元数据附加到模型，CustomJS 回调等可以访问这些元数据。

Note

不对提供的任何标签强制唯一性保证或其他条件，Bokeh 出于任何原因也不会直接使用这些标签。

title = ''

Type:

Nullable(String)

滑块的标签（支持 数学文本）。

tooltips = True

Type:

布尔值

显示工具提示中滑块的当前值。

value = Undefined

Type:

Required(String)

初始值或选定值。

value_throttled = Undefined

Type:

只读

初始值或节流后的选定值。

visible = True

Type:

布尔值

组件是否应在屏幕上显示。

width = 300

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用水平空间，但不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 要用来代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除所有当前已定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值发生更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标 attr 中项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件可能也很有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

类方法 lookup(name: str

给定属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

类方法 parameters() → list[Parameter]

生成适用于派生自字形的函数的 Python Parameter 值。

返回值:

list(Parameter)

类方法 properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使当前对该方法的使用在未来保持有效，请将返回值包装在 list 中。

返回值:

属性名称

类方法 properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集将属性名称映射到其值的字典。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象；如果未找到任何对象，则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None，可选) –

  这用于防止对 Bokeh 应用程序的“回旋镖”式更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果作为从属性名称到值的字典返回；如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

属性 document: Document | None

此模型附加到的 Document (可以为 None)

类 DateRangeSlider(*args: Any, id: ID | None = None, **kwargs: Any)

基类： NumericalSlider

基于滑块的日期范围选择组件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "bar_color": "#e6e6e6", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "direction": "ltr", 
  "disabled": false, 
  "elements": [], 
  "end": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "flow_mode": "block", 
  "format": "%d %b %Y", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67674", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "resizable": false, 
  "show_value": true, 
  "sizing_mode": null, 
  "start": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "step": 1, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "tooltips": true, 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "width": 300, 
  "width_policy": "auto"
}

align = 'auto'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件的宽度和高度之间的比例关系。

这在组件的任何尺寸可以灵活调整大小时起作用。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

bar_color = '#e6e6e6'

Type:

Color

可接受的值包括

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如，'#FF0000', '#44444444'

• CSS4 颜色字符串，例如，'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 3 元组的整数 (r, g, b)，取值范围为 0 到 255

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间

• 一个 32 位无符号整数，使用 0xRRGGBBAA 字节顺序模式

context_menu = None

Type:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 “auto”，组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

Note

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []

Type:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}

Type:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

Note

此属性是实验性的，可能会随时更改。

direction = 'ltr'

Type:

Enum(Enumeration(ltr, rtl))

disabled = False

Type:

布尔值

小部件在渲染时是否将被禁用。

如果为 True，小部件将灰显且不对 UI 事件做出响应。

elements = []

Type:

List

附加到此窗格的基于 DOM 的 UI 元素的集合。

这可以包括浮动元素（如工具提示），从而允许在此 UI 元素和其他 UI 元素之间建立父子关系。

end = Undefined

Type:

Required(Datetime)

允许的最大值。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局是否在块或内联维度中流动。

format = '%d %b %Y'

Type:

Either(String, Instance(TickFormatter))

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度尺寸调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法适应可用的垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界内（如果已设置）适应可用的垂直空间。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

Type:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

Type:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常见 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - Margin-Top、Margin-Right、Margin-Bottom 和 Margin-Left，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

对提供的任何名称不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

Type:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向定位滑块。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度中。

show_value = True

Type:

布尔值

是否显示滑块的值。

sizing_mode = None

Type:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于保持组件宽度和高度的高级设置。要获得更精细的尺寸调整控制，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果不存在父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口调整大小事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的纵横比。

start = Undefined

Type:

Required(Datetime)

允许的最小值。

step = 1

Type:

整数

连续值之间的步长，单位为天。

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

Type:

List

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

Type:

布尔值

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。在处理我们不需要其更新值的频繁更新的对象时，设置为 False 可能有助于减少网络流量。

Note

将此属性设置为 False 将阻止触发此对象上的任何 on_change() 回调。但是，任何 JS 端回调仍然有效。

tags = []

Type:

List

要附加到此模型的任意、用户提供的值的可选列表。

在查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是一种方便的方式，可以将任何必要的元数据附加到模型，CustomJS 回调等可以访问这些元数据。

Note

不对提供的任何标签强制唯一性保证或其他条件，Bokeh 出于任何原因也不会直接使用这些标签。

title = ''

Type:

Nullable(String)

滑块的标签（支持 数学文本）。

tooltips = True

Type:

布尔值

显示工具提示中滑块的当前值。

value = Undefined

Type:

Required(Tuple(Datetime, Datetime))

初始或选定的范围。

value_throttled = Undefined

Type:

只读

初始或选定的值，限制为仅在鼠标弹起时报告。

visible = True

Type:

布尔值

组件是否应在屏幕上显示。

width = 300

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用水平空间，但不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 要用来代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除所有当前已定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值发生更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标 attr 中项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件可能也很有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

给定属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于派生自字形的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使当前对该方法的使用在未来保持有效，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集将属性名称映射到其值的字典。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象；如果未找到任何对象，则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None，可选) –

  这用于防止对 Bokeh 应用程序的“回旋镖”式更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果作为从属性名称到值的字典返回；如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document (可以为 None)

property value_as_date: tuple[date, date] | None

方便的属性，用于检索作为日期对象元组的值元组。

在版本 1.1 中添加

属性 value_as_datetime: tuple[datetime, datetime] | None

便捷属性，用于检索作为 datetime 对象元组的值元组。

在版本 1.1 中添加

class DateSlider(*args: Any, id: ID | None = None, **kwargs: Any)

基类： NumericalSlider

基于滑块的日期选择小部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "bar_color": "#e6e6e6", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "direction": "ltr", 
  "disabled": false, 
  "elements": [], 
  "end": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "flow_mode": "block", 
  "format": "%d %b %Y", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67714", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "resizable": false, 
  "show_value": true, 
  "sizing_mode": null, 
  "start": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "step": 1, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "tooltips": true, 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "width": 300, 
  "width_policy": "auto"
}

align = 'auto'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件的宽度和高度之间的比例关系。

这在组件的任何尺寸可以灵活调整大小时起作用。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

bar_color = '#e6e6e6'

Type:

Color

可接受的值包括

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如，'#FF0000', '#44444444'

• CSS4 颜色字符串，例如，'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 3 元组的整数 (r, g, b)，取值范围为 0 到 255

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间

• 一个 32 位无符号整数，使用 0xRRGGBBAA 字节顺序模式

context_menu = None

Type:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 “auto”，组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

Note

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []

Type:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}

Type:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

Note

此属性是实验性的，可能会随时更改。

direction = 'ltr'

Type:

Enum(Enumeration(ltr, rtl))

disabled = False

Type:

布尔值

小部件在渲染时是否将被禁用。

如果为 True，小部件将灰显且不对 UI 事件做出响应。

elements = []

Type:

List

附加到此窗格的基于 DOM 的 UI 元素的集合。

这可以包括浮动元素（如工具提示），从而允许在此 UI 元素和其他 UI 元素之间建立父子关系。

end = Undefined

Type:

Required(Datetime)

允许的最大值。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局是否在块或内联维度中流动。

format = '%d %b %Y'

Type:

Either(String, Instance(TickFormatter))

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度尺寸调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法适应可用的垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界内（如果已设置）适应可用的垂直空间。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

Type:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

Type:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常见 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - Margin-Top、Margin-Right、Margin-Bottom 和 Margin-Left，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

对提供的任何名称不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

Type:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向定位滑块。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度中。

show_value = True

Type:

布尔值

是否显示滑块的值。

sizing_mode = None

Type:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于保持组件宽度和高度的高级设置。要获得更精细的尺寸调整控制，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果不存在父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口调整大小事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的纵横比。

start = Undefined

Type:

Required(Datetime)

允许的最小值。

step = 1

Type:

整数

连续值之间的步长，单位为天。

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

Type:

List

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

Type:

布尔值

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。在处理我们不需要其更新值的频繁更新的对象时，设置为 False 可能有助于减少网络流量。

Note

将此属性设置为 False 将阻止触发此对象上的任何 on_change() 回调。但是，任何 JS 端回调仍然有效。

tags = []

Type:

List

要附加到此模型的任意、用户提供的值的可选列表。

在查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是一种方便的方式，可以将任何必要的元数据附加到模型，CustomJS 回调等可以访问这些元数据。

Note

不对提供的任何标签强制唯一性保证或其他条件，Bokeh 出于任何原因也不会直接使用这些标签。

title = ''

Type:

Nullable(String)

滑块的标签（支持 数学文本）。

tooltips = True

Type:

布尔值

显示工具提示中滑块的当前值。

value = Undefined

Type:

Required(Datetime)

初始值或选定值。

value_throttled = Undefined

Type:

只读

初始或选定的值，限制为仅在鼠标弹起时报告。

visible = True

Type:

布尔值

组件是否应在屏幕上显示。

width = 300

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用水平空间，但不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 要用来代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除所有当前已定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict)[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list)[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值发生更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标 attr 中项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件可能也很有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor)[Any] | None

给定属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type)[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list)[Parameter]

生成适用于派生自字形的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set)[str] | dict)[str, Property)[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使当前对该方法的使用在未来保持有效，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict)[str, Property)[Any]]

收集此类上所有也具有引用的属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict)[str, Any]

收集将属性名称映射到其值的字典。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor)[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict)[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set)[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象；如果未找到任何对象，则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None，可选) –

  这用于防止对 Bokeh 应用程序的“回旋镖”式更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果作为从属性名称到值的字典返回；如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document (可以为 None)

property value_as_date: date | None

用于检索日期对象形式值的便捷属性。

在版本 2.0 中添加

property value_as_datetime: datetime | None

用于检索日期时间对象形式值的便捷属性。

在版本 2.0 中添加

class DatetimeRangeSlider(*args: Any, id: ID | None = None, **kwargs: Any)

基类： NumericalSlider

基于滑块的日期时间范围选择部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "bar_color": "#e6e6e6", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "direction": "ltr", 
  "disabled": false, 
  "elements": [], 
  "end": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "flow_mode": "block", 
  "format": "%d %b %Y %H:%M:%S", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67754", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "resizable": false, 
  "show_value": true, 
  "sizing_mode": null, 
  "start": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "step": 3600000, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "tooltips": true, 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "width": 300, 
  "width_policy": "auto"
}

align = 'auto'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件的宽度和高度之间的比例关系。

这在组件的任何尺寸可以灵活调整大小时起作用。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

bar_color = '#e6e6e6'

Type:

Color

可接受的值包括

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如，'#FF0000', '#44444444'

• CSS4 颜色字符串，例如，'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 3 元组的整数 (r, g, b)，取值范围为 0 到 255

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间

• 一个 32 位无符号整数，使用 0xRRGGBBAA 字节顺序模式

context_menu = None

Type:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 “auto”，组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

Note

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []

Type:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}

Type:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

Note

此属性是实验性的，可能会随时更改。

direction = 'ltr'

Type:

Enum(Enumeration(ltr, rtl))

disabled = False

Type:

布尔值

小部件在渲染时是否将被禁用。

如果为 True，小部件将灰显且不对 UI 事件做出响应。

elements = []

Type:

List

附加到此窗格的基于 DOM 的 UI 元素的集合。

这可以包括浮动元素（如工具提示），从而允许在此 UI 元素和其他 UI 元素之间建立父子关系。

end = Undefined

Type:

Required(Datetime)

允许的最大值。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局是否在块或内联维度中流动。

format = '%d %b %Y %H:%M:%S'

Type:

Either(String, Instance(TickFormatter))

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度尺寸调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法适应可用的垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界内（如果已设置）适应可用的垂直空间。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

Type:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

Type:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常见 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - Margin-Top、Margin-Right、Margin-Bottom 和 Margin-Left，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

对提供的任何名称不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

Type:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向定位滑块。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度中。

show_value = True

Type:

布尔值

是否显示滑块的值。

sizing_mode = None

Type:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于保持组件宽度和高度的高级设置。要获得更精细的尺寸调整控制，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果不存在父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口调整大小事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的纵横比。

start = Undefined

Type:

Required(Datetime)

允许的最小值。

step = 3600000

Type:

整数

连续值之间的步长，单位为毫秒。默认值为一小时。

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

Type:

List

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

Type:

布尔值

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。在处理我们不需要其更新值的频繁更新的对象时，设置为 False 可能有助于减少网络流量。

Note

将此属性设置为 False 将阻止触发此对象上的任何 on_change() 回调。但是，任何 JS 端回调仍然有效。

tags = []

Type:

List

要附加到此模型的任意、用户提供的值的可选列表。

在查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是一种方便的方式，可以将任何必要的元数据附加到模型，CustomJS 回调等可以访问这些元数据。

Note

不对提供的任何标签强制唯一性保证或其他条件，Bokeh 出于任何原因也不会直接使用这些标签。

title = ''

Type:

Nullable(String)

滑块的标签（支持 数学文本）。

tooltips = True

Type:

布尔值

显示工具提示中滑块的当前值。

value = Undefined

Type:

Required(Tuple(Datetime, Datetime))

初始或选定的范围。

value_throttled = Undefined

Type:

只读

初始或选定的值，限制为仅在鼠标弹起时报告。

visible = True

Type:

布尔值

组件是否应在屏幕上显示。

width = 300

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用水平空间，但不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 要用来代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除所有当前已定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值发生更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标 attr 中项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件可能也很有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor]

给定属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于派生自字形的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使当前对该方法的使用在未来保持有效，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集将属性名称映射到其值的字典。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象；如果未找到任何对象，则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None，可选) –

  这用于防止对 Bokeh 应用程序的“回旋镖”式更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果作为从属性名称到值的字典返回；如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document (可以为 None)

property value_as_datetime: tuple[datetime, datetime] | None

便捷属性，用于检索作为 datetime 对象元组的值元组。

class RangeSlider(*args: Any, id: ID | None = None, **kwargs: Any)

基类： NumericalSlider

基于范围滑块的数字范围选择部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "bar_color": "#e6e6e6", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "direction": "ltr", 
  "disabled": false, 
  "elements": [], 
  "end": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "flow_mode": "block", 
  "format": "0[.]00", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67794", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "resizable": false, 
  "show_value": true, 
  "sizing_mode": null, 
  "start": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "step": 1, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "tooltips": true, 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "width": 300, 
  "width_policy": "auto"
}

align = 'auto'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件的宽度和高度之间的比例关系。

这在组件的任何尺寸可以灵活调整大小时起作用。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

bar_color = '#e6e6e6'

Type:

Color

可接受的值包括

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如，'#FF0000', '#44444444'

• CSS4 颜色字符串，例如，'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 3 元组的整数 (r, g, b)，取值范围为 0 到 255

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间

• 一个 32 位无符号整数，使用 0xRRGGBBAA 字节顺序模式

context_menu = None

Type:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 “auto”，组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

Note

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []

Type:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}

Type:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

Note

此属性是实验性的，可能会随时更改。

direction = 'ltr'

Type:

Enum(Enumeration(ltr, rtl))

disabled = False

Type:

布尔值

小部件在渲染时是否将被禁用。

如果为 True，小部件将灰显且不对 UI 事件做出响应。

elements = []

Type:

List

附加到此窗格的基于 DOM 的 UI 元素的集合。

这可以包括浮动元素（如工具提示），从而允许在此 UI 元素和其他 UI 元素之间建立父子关系。

end = Undefined

Type:

Required(Float)

允许的最大值。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局是否在块或内联维度中流动。

format = '0[.]00'

Type:

Either(String, Instance(TickFormatter))

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度尺寸调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法适应可用的垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界内（如果已设置）适应可用的垂直空间。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

Type:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

Type:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常见 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - Margin-Top、Margin-Right、Margin-Bottom 和 Margin-Left，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

对提供的任何名称不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

Type:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向定位滑块。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度中。

show_value = True

Type:

布尔值

是否显示滑块的值。

sizing_mode = None

Type:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于保持组件宽度和高度的高级设置。要获得更精细的尺寸调整控制，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果不存在父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口调整大小事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的纵横比。

start = Undefined

Type:

Required(Float)

允许的最小值。

step = 1

Type:

Float

连续值之间的步长。

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

Type:

List

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

Type:

布尔值

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。在处理我们不需要其更新值的频繁更新的对象时，设置为 False 可能有助于减少网络流量。

Note

将此属性设置为 False 将阻止触发此对象上的任何 on_change() 回调。但是，任何 JS 端回调仍然有效。

tags = []

Type:

List

要附加到此模型的任意、用户提供的值的可选列表。

在查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是一种方便的方式，可以将任何必要的元数据附加到模型，CustomJS 回调等可以访问这些元数据。

Note

不对提供的任何标签强制唯一性保证或其他条件，Bokeh 出于任何原因也不会直接使用这些标签。

title = ''

Type:

Nullable(String)

滑块的标签（支持 数学文本）。

tooltips = True

Type:

布尔值

显示工具提示中滑块的当前值。

value = Undefined

Type:

Required(Tuple(Float, Float))

初始或选定的范围。

value_throttled = Undefined

Type:

只读

初始值或选定值，根据mouseup上的报告进行节流。

visible = True

Type:

布尔值

组件是否应在屏幕上显示。

width = 300

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用水平空间，但不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 要用来代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除所有当前已定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值发生更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标 attr 中项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件可能也很有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

给定属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于派生自字形的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使当前对该方法的使用在未来保持有效，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集将属性名称映射到其值的字典。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象；如果未找到任何对象，则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None，可选) –

  这用于防止对 Bokeh 应用程序的“回旋镖”式更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果作为从属性名称到值的字典返回；如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document (可以为 None)

类 Slider(*args: Any, id: ID | None = None, **kwargs: Any)

基类： NumericalSlider

基于滑块的数字选择部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "bar_color": "#e6e6e6", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "direction": "ltr", 
  "disabled": false, 
  "elements": [], 
  "end": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "flow_mode": "block", 
  "format": "0[.]00", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67834", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "resizable": false, 
  "show_value": true, 
  "sizing_mode": null, 
  "start": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "step": 1, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "tooltips": true, 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "width": 300, 
  "width_policy": "auto"
}

align = 'auto'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件的宽度和高度之间的比例关系。

这在组件的任何尺寸可以灵活调整大小时起作用。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

bar_color = '#e6e6e6'

Type:

Color

可接受的值包括

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如，'#FF0000', '#44444444'

• CSS4 颜色字符串，例如，'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 3 元组的整数 (r, g, b)，取值范围为 0 到 255

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间

• 一个 32 位无符号整数，使用 0xRRGGBBAA 字节顺序模式

context_menu = None

Type:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 “auto”，组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

Note

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []

Type:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}

Type:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

Note

此属性是实验性的，可能会随时更改。

direction = 'ltr'

Type:

Enum(Enumeration(ltr, rtl))

disabled = False

Type:

布尔值

小部件在渲染时是否将被禁用。

如果为 True，小部件将灰显且不对 UI 事件做出响应。

elements = []

Type:

List

附加到此窗格的基于 DOM 的 UI 元素的集合。

这可以包括浮动元素（如工具提示），从而允许在此 UI 元素和其他 UI 元素之间建立父子关系。

end = Undefined

Type:

Required(Float)

允许的最大值。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局是否在块或内联维度中流动。

format = '0[.]00'

Type:

Either(String, Instance(TickFormatter))

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度尺寸调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法适应可用的垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界内（如果已设置）适应可用的垂直空间。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

Type:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

Type:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常见 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - Margin-Top、Margin-Right、Margin-Bottom 和 Margin-Left，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调整，则组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调整，则组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

Note

对提供的任何名称不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

Type:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向定位滑块。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度中。

show_value = True

Type:

布尔值

是否显示滑块的值。

sizing_mode = None

Type:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于保持组件宽度和高度的高级设置。要获得更精细的尺寸调整控制，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果不存在父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口调整大小事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的纵横比。

start = Undefined

Type:

Required(Float)

允许的最小值。

step = 1

Type:

Float

连续值之间的步长。

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

Type:

List

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

Type:

布尔值

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。在处理我们不需要其更新值的频繁更新的对象时，设置为 False 可能有助于减少网络流量。

Note

将此属性设置为 False 将阻止触发此对象上的任何 on_change() 回调。但是，任何 JS 端回调仍然有效。

tags = []

Type:

List

要附加到此模型的任意、用户提供的值的可选列表。

在查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是一种方便的方式，可以将任何必要的元数据附加到模型，CustomJS 回调等可以访问这些元数据。

Note

不对提供的任何标签强制唯一性保证或其他条件，Bokeh 出于任何原因也不会直接使用这些标签。

title = ''

Type:

Nullable(String)

滑块的标签（支持 数学文本）。

tooltips = True

Type:

布尔值

显示工具提示中滑块的当前值。

value = Undefined

Type:

Required(Float)

初始值或选定值。

value_throttled = Undefined

Type:

只读

初始值或选定值，根据mouseup上的报告进行节流。

visible = True

Type:

布尔值

组件是否应在屏幕上显示。

width = 300

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用水平空间，但不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

Note

这是一个实验性功能，未来可能会更改。请自行决定使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 要用来代替默认值的主题值

返回值:

None

类方法 clear_extensions() → None

清除所有当前已定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

类方法 dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

类方法 descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值发生更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标 attr 中项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件可能也很有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

类方法 lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

给定属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

类方法 parameters() → list[Parameter]

生成适用于派生自字形的函数的 Python Parameter 值。

返回值:

list(Parameter)

类方法 properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使当前对该方法的使用在未来保持有效，请将返回值包装在 list 中。

返回值:

属性名称

类方法 properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集将属性名称映射到其值的字典。

此方法总是遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象；如果未找到任何对象，则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None，可选) –

  这用于防止对 Bokeh 应用程序的“回旋镖”式更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果作为从属性名称到值的字典返回；如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document (可以为 None)