输入

各种输入小部件和表单控件。

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

基类: TextInput

带自动完成功能的单行输入小部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "case_sensitive": true, 
  "completions": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p64703", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_completions": null, 
  "max_height": null, 
  "max_length": null, 
  "max_width": null, 
  "min_characters": 2, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "placeholder": "", 
  "prefix": null, 
  "resizable": false, 
  "restrict": true, 
  "search_strategy": "starts_with", 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "suffix": null, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "value_input": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

case_sensitive = True

类型:

布尔值

启用或禁用区分大小写。

completions = []

类型:

列表

一个完成字符串列表。 这将用于在用户键入所需值的开头时引导用户。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_completions = None

类型:

Nullable(Positive)

显示的建议完成项的最大可选数量。

max_height = None

类型:

Nullable(NonNegative)

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

max_length = None

类型:

Nullable(Int)

字段中字符的最大数量

max_width = None

类型:

Nullable(NonNegative)

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

min_characters = 2

类型:

NonNegative

用户在显示建议完成项之前必须输入的字符数。

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

placeholder = ''

类型:

字符串

空输入字段的占位符。

prefix = None

类型:

Nullable(String)

一个可选的字符串前缀，显示在输入之前。这对于指示例如输入的值将分配到的变量很有用。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

restrict = True

类型:

布尔值

设置为 False 以允许用户输入不在完成字符串列表中的文本。

search_strategy = 'starts_with'

类型:

Enum(Enumeration(starts_with, includes))

定义如何搜索完成字符串列表。默认选项"starts_with"表示用户文本必须与完成字符串的开头匹配。使用"includes"表示用户文本可以匹配完成字符串的任何子字符串。

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

suffix = None

类型:

Nullable(String)

一个可选的字符串后缀，显示在输入之后。这对于指示例如输入值的度量单位很有用。

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = ''

类型:

字符串

初始或输入的文本值。

每当按下<enter>键时，都会触发更改事件。

value_input = ''

类型:

字符串

初始或当前值。

每当发生任何更新时，都会触发更改事件，即在每次按键时。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 Checkbox(*args: Any, id: ID | None = None, **kwargs: Any)

基类：ToggleInput

复选框小部件。

JSON 原型

{
  "active": false, 
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p64743", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": "", 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

active = False

类型:

布尔值

小部件的状态。

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

label = ''

类型:

字符串

复选框旁边的标签。

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 ColorPicker(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

颜色拾取器小部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "color": "#000000", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p64771", 
  "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, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

color = '#000000'

类型:

ColorHex

拾取颜色的初始颜色（命名或十六进制）

可接受的值为

• 任何命名 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)'

• 一个包含 0 到 255 之间的整数的 3 元组 (r, g, b)

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

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

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 FileInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

向用户呈现文件选择对话框，并返回所选文件的内容。

JSON 原型

{
  "accept": "", 
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "directory": false, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p64800", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "multiple": false, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

accept = ''

类型:

Either(String, List)

用户可以选择的文件的标准 HTML 文件输入过滤器的逗号分隔列表。值可以是

<文件扩展名>:

可以选择特定的文件扩展名（例如：.gif、.jpg、.png、.doc）

audio/*:

可以选择所有声音文件

video/*:

可以选择所有视频文件

image/*:

可以选择所有图像文件

<媒体类型>:

一个有效的IANA 媒体类型，不带参数。

注意

macOS Big Sur 上某些版本的 Chrome 中的一个错误可能会限制您如何为这些用户设置文件输入过滤器。在这些情况下，无法将用户的选择限制为特定的文件扩展名 - 相反，浏览器会将用户限制为预定义的文件类型集，例如Text/*或Image/*。有关更多信息，请参阅#10888。

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

directory = False

类型:

布尔值

是否允许选择目录而不是文件。

文件名将是上传目录的相对路径。

注意

上传目录时，会显示一个确认弹出窗口。由于这是浏览器中的安全功能，因此无法禁用确认弹出窗口。

注意

accept 参数仅适用于文件扩展名。当将 accept 与 directory 一起使用时，报告的文件数量将是所有文件的总数，而不是已过滤的文件。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

filename = Undefined

类型:

只读

已加载的文件的名称。

如果 multiple 设置为 False（默认值），则此值为单个字符串，其中包含所选单个文件的名称。

如果 multiple 为 True，则此值为字符串列表，每个字符串都包含所选多个文件之一的名称。

此列表为 value 和 mime-type 中各个列表提供文件序列。

注意

由于安全原因，浏览器不会提供对该信息的访问权限，因此不包含完整的文件路径。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

mime_type = Undefined

类型:

只读

已加载的文件的 mime 类型。

如果 multiple 设置为 False（默认值），则此值为单个字符串，其中包含所选单个文件的 mime 类型。

如果 multiple 为 True，则此值为字符串列表，每个字符串都包含所选多个文件之一的 mime 类型。

文件的顺序由文件名列表给出（见下文）。

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

multiple = False

类型:

布尔值

将 multiple 设置为 False（默认值）以进行单个文件选择，如果应允许一次选择多个文件，则将其设置为 True。

name = None

类型:

Nullable(String)

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

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

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

注意

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

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = Undefined

类型:

只读

已加载的文件的 base64 编码内容。

如果 multiple 设置为 False（默认值），则此值为单个字符串，其中包含所选单个文件的内容。

如果 multiple 为 True，则此值为字符串列表，每个字符串都包含所选多个文件之一的内容。

文件的顺序由文件名列表给出（见下文）。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

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

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

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

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

参数：

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

返回值：

None

clear() → 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 InputWidget(*args: Any, id: ID | None = None, **kwargs: Any)

基类：Widget

输入部件的抽象基类。

注意

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

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p64834", 
  "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, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 MultiChoice(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

多选小部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "delete_button": true, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p64862", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_items": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "option_limit": null, 
  "options": [], 
  "placeholder": null, 
  "resizable": false, 
  "search_option_limit": null, 
  "sizing_mode": null, 
  "solid": true, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

delete_button = True

类型:

布尔值

是否添加一个按钮来删除选定的选项。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_items = None

类型:

Nullable(Int)

可以选择项目的最大数量。

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

option_limit = None

类型:

Nullable(Int)

将在下拉列表中呈现的选择数量。

options = []

类型:

列表

可用的选择选项。选项可以作为可能字符串值的列表提供，也可以作为元组列表提供，每个元组都采用 (value, label) 的形式。在后一种情况下，每个值的可见小部件文本将是相应的给定标签。

placeholder = None

类型:

Nullable(String)

如果没有添加项目，则显示的字符串。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

search_option_limit = None

类型:

Nullable(Int)

输入搜索字符串时将在下拉列表中呈现的选择数量。

sizing_mode = None

类型:

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"

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

solid = True

类型:

布尔值

指定是否应填充选择。

styles = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = []

类型:

列表

初始或选定的值。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 MultiSelect(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

多选小部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p64898", 
  "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, 
  "options": [], 
  "resizable": false, 
  "size": 4, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

options = []

类型:

列表

可用的选择选项。选项可以作为可能字符串值的列表提供，也可以作为元组列表提供，每个元组都采用 (value, label) 的形式。在后一种情况下，每个值的可见小部件文本将是相应的给定标签。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

size = 4

类型:

整数

下拉列表中可见选项的数量。（这使用 select HTML 元素的 size 属性。某些浏览器可能不会显示少于 3 个选项。）

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = []

类型:

列表

初始或选定的值。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 NumericInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

数字输入部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "format": null, 
  "height": null, 
  "height_policy": "auto", 
  "high": null, 
  "id": "p64929", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "low": null, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "mode": "int", 
  "name": null, 
  "placeholder": "", 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": null, 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

format = None

类型:

Either(Null, String, Instance(TickFormatter))

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

high = None

类型:

Either(Null, Float, Int)

可选的最大允许值。

low = None

类型:

Either(Null, Float, Int)

可选的最小允许值。

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

mode = 'int'

类型:

Enum(Enumeration(int, float))

定义可以在输入中输入的数字类型

例如 mode int: 1, -1, 156 mode float: 1, -1.2, 1.1e-25

name = None

类型:

Nullable(String)

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

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

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

注意

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

placeholder = ''

类型:

字符串

空输入字段的占位符。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = None

类型:

Either(Null, Float, Int)

初始值或输入的值。

每当按下<enter>键时，都会触发更改事件。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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]

类方法 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 PaletteSelect(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

颜色调色板选择小部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p64963", 
  "items": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "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, 
  "ncols": 1, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "swatch_height": "auto", 
  "swatch_width": 100, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

items = Undefined

类型:

Required(Seq(Tuple(String, Seq(Color))))

可以选择的一组命名颜色调色板。

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

ncols = 1

类型:

正数

将调色板显示分成列的列数。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

swatch_height = 'auto'

类型:

Either(Auto, NonNegative)

显示调色板预览的 UI 元素的高度，以像素或自动调整。

swatch_width = 100

类型:

NonNegative

显示调色板预览的 UI 元素的宽度，以像素为单位。

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = Undefined

类型:

Required(String)

初始或选定颜色调色板的名称。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 PasswordInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类: TextInput

单行密码输入部件。

此部件隐藏输入值，使其在浏览器中不可见。

警告

要安全地将密码传输到 Bokeh 服务器应用程序代码，需要将服务器配置为 SSL（即 HTTPS）终止。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p64996", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_length": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "placeholder": "", 
  "prefix": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "suffix": null, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "value_input": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_length = None

类型:

Nullable(Int)

字段中字符的最大数量

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

placeholder = ''

类型:

字符串

空输入字段的占位符。

prefix = None

类型:

Nullable(String)

一个可选的字符串前缀，显示在输入之前。这对于指示例如输入的值将分配到的变量很有用。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

suffix = None

类型:

Nullable(String)

一个可选的字符串后缀，显示在输入之后。这对于指示例如输入值的度量单位很有用。

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = ''

类型:

字符串

初始或输入的文本值。

每当按下<enter>键时，都会触发更改事件。

value_input = ''

类型:

字符串

初始或当前值。

每当发生任何更新时，都会触发更改事件，即在每次按键时。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 Python Parameter 值。

返回值：

list(Parameter)

classmethod 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 Select(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

单选小部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p65030", 
  "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, 
  "options": [], 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

options = []

类型:

Either(List, Dict(String, List))

可用的选择选项。

选项可以提供为可能的字符串值的列表，这些值也充当选项的标签，或者提供为元组列表，每个元组的形式为(value, label)，其中value可以是任何类型，不一定是字符串。在后一种情况下，每个值的可见小部件文本将是对应的给定标签。

可以通过提供一个字典对象来提供选项分组，该字典对象的 value 采用上述列表格式。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = ''

类型:

Any

初始或选定的值。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 Spinner(*args: Any, id: ID | None = None, **kwargs: Any)

基类: NumericInput

数值微调器输入部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "format": null, 
  "height": null, 
  "height_policy": "auto", 
  "high": null, 
  "id": "p65060", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "low": null, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "mode": "float", 
  "name": null, 
  "page_step_multiplier": 10, 
  "placeholder": "", 
  "resizable": false, 
  "sizing_mode": null, 
  "step": 1, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": null, 
  "visible": true, 
  "wheel_wait": 100, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

format = None

类型:

Either(Null, String, Instance(TickFormatter))

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

high = None

类型:

Either(Null, Float, Int)

可选的最大允许值。

low = None

类型:

Either(Null, Float, Int)

可选的最小允许值。

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

mode = 'float'

类型:

Enum(Enumeration(int, float))

定义可以在输入中输入的数字类型

例如 mode int: 1, -1, 156 mode float: 1, -1.2, 1.1e-25

name = None

类型:

Nullable(String)

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

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

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

注意

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

page_step_multiplier = 10

类型:

间隔

定义按下 Page Up 和 Page Down 键时应用于步长的乘法因子。

placeholder = ''

类型:

字符串

空输入字段的占位符。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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"

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

step = 1

类型:

间隔

每次增加或减少的值。

styles = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = None

类型:

Either(Null, Float, Int)

初始值或输入的值。

每当按下<enter>键时，都会触发更改事件。

value_throttled = Undefined

类型:

只读

交互结束时报告的值。

visible = True

类型:

布尔值

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

wheel_wait = 100

类型:

Either(Int, Float)

使用鼠标滚轮更改输入时，定义更新value_throttled之前的去抖时间（毫秒）。

width = None

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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 中的特定事件。

类方法 parameters() → list[Parameter]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 Switch(*args: Any, id: ID | None = None, **kwargs: Any)

基类：ToggleInput

一种类似复选框的小部件。

JSON 原型

{
  "active": false, 
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p65098", 
  "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, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "width": 32, 
  "width_policy": "auto"
}

active = False

类型:

布尔值

小部件的状态。

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

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

visible = True

类型:

布尔值

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

width = 32

类型:

Nullable(NonNegative)

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

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

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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 中的特定事件。

类方法 parameters() → list[Parameter]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值：

模型

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

根据 JSON 设置此对象上的属性值。

参数：

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

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

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• 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 TextAreaInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类: TextLikeInput

多行输入小部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "cols": 20, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p65125", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_length": 500, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "placeholder": "", 
  "resizable": false, 
  "rows": 2, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "value_input": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

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

父容器中的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

cols = 20

类型:

整数

指定文本区域的宽度（以平均字符宽度计）。默认值：20

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

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

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

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

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选大小策略。

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_length = 500

类型:

Nullable(Int)

字段中字符的最大数量

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

placeholder = ''

类型:

字符串

空输入字段的占位符。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

rows = 2

类型:

整数

指定文本区域的高度（以行计）。默认值：2

sizing_mode = None

类型:

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 = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

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

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

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

注意

不保证提供的任何标签的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = ''

类型:

字符串

初始或输入的文本值。

每当按下<enter>键时，都会触发更改事件。

value_input = ''

类型:

字符串

初始或当前值。

每当发生任何更新时，都会触发更改事件，即在每次按键时。

visible = True

类型:

布尔值

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度大小策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

使用组件的首选宽度（如果设置）并允许它在最小和最大宽度边界（如果设置）内适应可用的水平空间。组件的宽度既不会被积极地最小化也不会被最大化。

"min"

使用尽可能少的水平空间，不小于最小宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

使用尽可能多的水平空间，不超过最大宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含用户未显式设置的属性（默认值：True）

返回值：

匹配属性的属性名称和值的映射

返回类型：

字典

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类 JSON

返回值：

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

根据 JSON 设置此对象上的属性值。

参数：

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None，可选) –

  这用于防止 Bokeh 应用的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件设置器与自身进行比较，并抑制任何源自自身的更新。

返回值：

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数：

• selector (类 JSON)

• 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 TextInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类: TextLikeInput

单行输入部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p65159", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_length": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "placeholder": "", 
  "prefix": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "suffix": null, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "value_input": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器中的对齐点。

此属性仅在该组件是布局（例如网格）的子元素时才有用。 自对齐可以被父容器（例如网格轨道对齐）覆盖。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸在大小上都是灵活的，则此功能有效。 如果设置为数字，则将保持width / height = aspect_ratio关系。 否则，如果设置为"auto"，则组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

用户右键单击组件时显示的菜单。

注意

右键点击时按住 Shift 键可显示原生上下文菜单。

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列额外的 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

允许定义动态计算的 CSS 变量。

例如，这可以用于在画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。

此处定义的变量等效于在 CSS 样式表中 :host { ... } 下设置相同的变量。

注意

此属性为实验性属性，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或包含此小部件功能的丰富 HTML 描述的工具提示。

disabled = False

类型:

布尔值

渲染时小部件是否被禁用。

如果为 True，则小部件将呈灰色显示，并且对 UI 事件无响应。

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

这可能包括工具提示之类的浮动元素，允许在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度大小策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选大小策略。

"fixed"

使用恰好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置）并允许其适应最小和最大高度边界（如果已设置）内的可用垂直空间。组件的高度既不会被积极最小化也不会被积极最大化。

"min"

使用尽可能少的垂直空间，不少于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

使用尽可能多的垂直空间，不多于最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则组件的最大高度（以像素为单位）。

max_length = None

类型:

Nullable(Int)

字段中字符的最大数量

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的用户提供的任意名称。

在查询文档以检索特定的 Bokeh 模型时，此名称很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

不保证提供的任何名称的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

placeholder = ''

类型:

字符串

空输入字段的占位符。

prefix = None

类型:

Nullable(String)

一个可选的字符串前缀，显示在输入之前。这对于指示例如输入的值将分配到的变量很有用。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上调整大小。

sizing_mode = None

类型:

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 = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 的组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用:host CSS 伪选择器来访问根 DOM 元素。

suffix = None

类型:

Nullable(String)

一个可选的字符串后缀，显示在输入之后。这对于指示例如输入值的度量单位很有用。

syncable = True

类型:

布尔值

指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。在处理经常更新的对象（我们不需要其更新值）时，将其设置为False可能有助于减少网络流量。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。但是，任何 JS 端回调仍然有效。

tags = []

类型:

列表

一个可选的任意用户提供值的列表，附加到此模型。

在查询文档以检索特定的 Bokeh 模型时，此数据很有用。

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者，这是一种方便的方式，可以将任何必要的元数据附加到模型，这些元数据可以通过CustomJS回调等访问。

注意

不保证提供的任何标签的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

小部件的标签。

value = ''

类型:

字符串

初始或输入的文本值。

每当按下<enter>键时，都会触发更改事件。

value_input = ''

类型:

字符串

初始或当前值。

每当发生任何更新时，都会触发更改事件，即在每次按键时。

visible = True

类型:

布尔值

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度大小策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其宽度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好width像素。如果组件无法容纳在可用的水平空间中，则会溢出。

"fit"

使用组件的首选宽度（如果设置）并允许它在最小和最大宽度边界（如果设置）内适应可用的水平空间。组件的宽度既不会被积极地最小化也不会被最大化。

"min"

使用尽可能少的水平空间，不小于最小宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

使用尽可能多的水平空间，不超过最大宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一项实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 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 中添加

引发：

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]

生成适合从 Glyph 派生的函数的 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）

返回值：

属性名称到其值的映射

返回类型：

字典

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含用户未显式设置的属性（默认值：True）

返回值：

匹配属性的属性名称和值的映射

返回类型：

字典

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数：

selector (类 JSON)

返回值：

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类 JSON

返回值：

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

根据 JSON 设置此对象上的属性值。

参数：

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None，可选) –

  这用于防止 Bokeh 应用的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件设置器与自身进行比较，并抑制任何源自自身的更新。

返回值：

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数：

• selector (类 JSON)

• 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）

ColorMap(*args: Any, **kwargs: Any) → PaletteSelect

颜色调色板选择小部件。

已弃用自版本 3.4.0: 请改用 PaletteSelect 组件。