expressions#
表示由 BokehJS 在客户端(浏览器)端计算的数组表达式。
当期望数组值在浏览器中计算时,表达式模型可用作 DataSpec
值
p.scatter(x={'expr': some_expression}, ...)
或使用 expr
便利函数
from bokeh.core.properties import expr
p.scatter(x=expr(some_expression), ...)
在这种情况下,x
坐标的值将由 some_expression
的 JavaScript 实现使用 ColumnDataSource
作为输入在浏览器中计算。
- class CumSum(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Expression
通过累积求和
ColumnDataSource
中的单列来生成数组的表达式。JSON Prototype
{ "field": { "name": "unset", "type": "symbol" }, "id": "p59082", "include_zero": false, "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [] }
- include_zero = False#
- 类型:
是否在结果的开头包含零。请注意,结果的长度始终与输入列相同。因此,如果此属性为 True,则最后一列的值将不包含在总和中。
source = ColumnDataSource(data=dict(foo=[1, 2, 3, 4])) CumSum(field='foo') # -> [1, 3, 6, 10] CumSum(field='foo', include_zero=True) # -> [0, 1, 3, 6]
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用该名称。
- syncable = True#
- 类型:
指示当在 Web 浏览器中更新此模型时,是否应将其同步回 Bokeh 服务器。当处理频繁更新的对象,而我们不需要其更新值时,设置为
False
可能有助于减少网络流量。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调被触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
要附加到此模型的可选的任意用户提供的值列表。
当查询文档以检索特定的 Bokeh 模型时,此数据可能很有用
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到可由
CustomJS
回调等访问的模型的一种便捷方式。注意
对于提供的任何标签,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用这些标签。
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些值将代替默认值使用,但不会覆盖应用程序设置的值。
传入的字典可以保持原样并与其他实例共享,以节省内存(因此调用者和
HasProps
实例都不应修改它)。- 参数:
property_values (dict) – 用于代替默认值的主题值
- 返回:
None
- classmethod clear_extensions() None #
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展都包含在生成的文档中,无论是否使用它们。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序列出的属性描述符列表。
- 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 模型属性的值发生更改时更新另一个属性。- 参数:
在版本 1.1 中添加
- Raises:
示例
此代码与
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
的属性的描述符- 返回类型:
- 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 properties(*, _with_props: bool = False) set| dict[str, Property[Any]] #
收集此类上属性的名称。
警告
在 Bokeh 的未来版本中,此方法将返回一个字典,该字典将属性名称映射到属性对象。为了使此方法当前的用法适应未来,请将返回值包装在
list
中。- 返回:
属性名称
- classmethod properties_with_refs() dict[str, Property[Any]] #
收集此类上所有也具有引用的属性的名称。
此方法总是遍历类层次结构,并包括在任何父类上定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集一个字典,将属性名称映射到它们的值。
此方法总是遍历类层次结构,并包括在任何父类上定义的属性。
不可序列化的属性将被跳过,属性值将采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损地重构对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[Model] #
查询此对象及其所有引用,以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用,以查找与给定选择器匹配的对象。如果找到多个对象,则引发错误。返回单个匹配对象,如果未找到任何对象,则返回 None :param selector: :type selector: JSON-like
- 返回:
模型
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 在此对象上设置属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置给属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在进行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件设置者与自身进行比较,并阻止任何源自自身的更新。
- 返回:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的覆盖。
结果作为从属性名称到值的字典返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回:
字典或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化的表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class CustomJSExpr(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Expression
评估 JavaScript 函数/生成器。
警告
此 Bokeh 模型的明确目的是嵌入原始 JavaScript 代码以供浏览器执行。 如果代码的任何部分来自不受信任的用户输入,则您必须采取适当的预防措施,在传递给 Bokeh 之前对用户输入进行清理。
JSON Prototype
{ "args": { "type": "map" }, "code": "", "id": "p59088", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [] }
- args = {}#
-
名称到 Python 对象的映射。 特别是,这些可以是 bokeh 的模型。 这些对象作为回调的命名参数的值提供给回调的代码片段。 无需手动包含关联的字形渲染器的数据源,因为它可以通过 this 关键字在代码范围内使用(例如,this.data 将提供对原始数据的访问)。
- code = ''#
- 类型:
要在浏览器中执行的 JavaScript 代码片段。 该代码被制作为生成器函数的主体,并且
args
中的所有命名对象都可用作代码可以使用的参数。 可以返回类似数组的对象(数组、类型化数组、nd 数组)、可迭代对象(将转换为数组)或标量值(将转换为适当长度的数组),或者可以产生将收集到数组中的值。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用该名称。
- syncable = True#
- 类型:
指示当在 Web 浏览器中更新此模型时,是否应将其同步回 Bokeh 服务器。当处理频繁更新的对象,而我们不需要其更新值时,设置为
False
可能有助于减少网络流量。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调被触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
要附加到此模型的可选的任意用户提供的值列表。
当查询文档以检索特定的 Bokeh 模型时,此数据可能很有用
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到可由
CustomJS
回调等访问的模型的一种便捷方式。注意
对于提供的任何标签,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用这些标签。
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些值将代替默认值使用,但不会覆盖应用程序设置的值。
传入的字典可以保持原样并与其他实例共享,以节省内存(因此调用者和
HasProps
实例都不应修改它)。- 参数:
property_values (dict) – 用于代替默认值的主题值
- 返回:
None
- classmethod clear_extensions() None #
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展都包含在生成的文档中,无论是否使用它们。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序列出的属性描述符列表。
- 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 模型属性的值发生更改时更新另一个属性。- 参数:
在版本 1.1 中添加
- Raises:
示例
此代码与
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
的属性的描述符- 返回类型:
- 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 properties(*, _with_props: bool = False) set[str] | dict[[str, Property[[Any]]#
收集此类上属性的名称。
警告
在 Bokeh 的未来版本中,此方法将返回一个字典,该字典将属性名称映射到属性对象。为了使此方法当前的用法适应未来,请将返回值包装在
list
中。- 返回:
属性名称
- classmethod properties_with_refs() dict[[str, Property[[Any]]#
收集此类上所有也具有引用的属性的名称。
此方法总是遍历类层次结构,并包括在任何父类上定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[[str, Any]#
收集一个字典,将属性名称映射到它们的值。
此方法总是遍历类层次结构,并包括在任何父类上定义的属性。
不可序列化的属性将被跳过,属性值将采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损地重构对象实例所需的信息。
- query_properties_with_values(query: Callable[[[PropertyDescriptor[[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[[str, Any]#
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[[Model]#
查询此对象及其所有引用,以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用,以查找与给定选择器匹配的对象。如果找到多个对象,则引发错误。返回单个匹配对象,如果未找到任何对象,则返回 None :param selector: :type selector: JSON-like
- 返回:
模型
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 在此对象上设置属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置给属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在进行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件设置者与自身进行比较,并阻止任何源自自身的更新。
- 返回:
None
- set_select(selector: type[[Model] | SelectorType, updates: dict[[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回:
None
- themed_values() dict[[str, Any] | None#
获取任何主题提供的覆盖。
结果作为从属性名称到值的字典返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回:
字典或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化的表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class Expression(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Model
用于
Expression
模型的基类,这些模型表示要在客户端执行的计算。JavaScripts 实现应实现以下方法
注意
如果您希望每个源的结果都被缓存,并且仅在源更改时更新,请实现
_v_compute: (source)
代替。注意
这是一个抽象基类,用于帮助组织 Bokeh 模型类型的层次结构。 它本身实例化是没有用的。
JSON Prototype
{ "id": "p59094", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [] }
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用该名称。
- syncable = True#
- 类型:
指示当在 Web 浏览器中更新此模型时,是否应将其同步回 Bokeh 服务器。当处理频繁更新的对象,而我们不需要其更新值时,设置为
False
可能有助于减少网络流量。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调被触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
要附加到此模型的可选的任意用户提供的值列表。
当查询文档以检索特定的 Bokeh 模型时,此数据可能很有用
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到可由
CustomJS
回调等访问的模型的一种便捷方式。注意
对于提供的任何标签,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用这些标签。
- apply_theme(property_values: dict[[str, Any]) None #
应用一组主题值,这些值将代替默认值使用,但不会覆盖应用程序设置的值。
传入的字典可以保持原样并与其他实例共享,以节省内存(因此调用者和
HasProps
实例都不应修改它)。- 参数:
property_values (dict) – 用于代替默认值的主题值
- 返回:
None
- classmethod clear_extensions() None #
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展都包含在生成的文档中,无论是否使用它们。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[[PropertyDescriptor[[Any]]#
按定义顺序列出的属性描述符列表。
清理对文档和属性的引用
模型的结构相等性。
- 参数:
other (HasProps) – 要比较的另一个实例
- 返回:
如果属性在结构上相等,则为 True,否则为 False
使用 JavaScript 链接两个 Bokeh 模型属性。
这是一种便利方法,可以简化添加
CustomJS
回调,以便在一个 Bokeh 模型属性的值发生更改时更新另一个属性。- 参数:
在版本 1.1 中添加
- Raises:
示例
此代码与
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]" ) )
将
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)
查找类上 Bokeh 属性的
PropertyDescriptor
,给定属性名称。- 参数:
- 返回:
名为
name
的属性的描述符- 返回类型:
在此对象上添加回调,以便在
attr
更改时触发。- 参数:
attr (str) – 此对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
当在此模型上发生指定事件时运行回调
并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息,请参阅 bokeh.events 中的特定事件。
生成适用于从字形派生的函数的 Python
Parameter
值。- 返回:
list(Parameter)
收集此类上属性的名称。
警告
在 Bokeh 的未来版本中,此方法将返回一个字典,该字典将属性名称映射到属性对象。为了使此方法当前的用法适应未来,请将返回值包装在
list
中。- 返回:
属性名称
收集一个字典,将属性名称映射到它们的值。
此方法总是遍历类层次结构,并包括在任何父类上定义的属性。
不可序列化的属性将被跳过,属性值将采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损地重构对象实例所需的信息。
使用谓词查询
HasProps
实例的属性值。
返回此对象引用的所有
Models
。
从此对象中移除回调
查询此对象及其所有引用,以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
查询此对象及其所有引用,以查找与给定选择器匹配的对象。如果找到多个对象,则引发错误。返回单个匹配对象,如果未找到任何对象,则返回 None :param selector: :type selector: JSON-like
- 返回:
模型
从 JSON 在此对象上设置属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置给属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在进行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件设置者与自身进行比较,并阻止任何源自自身的更新。
- 返回:
None
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回:
None
获取任何主题提供的覆盖。
结果作为从属性名称到值的字典返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回:
字典或 None
将此对象转换为可序列化的表示形式。
移除任何主题值并恢复默认值。
- 返回:
None
从给定的关键字参数更新对象的属性。
- 返回:
None
示例
以下是等效的
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
此模型所附加的
Document
(可以为None
)
基类:
坐标变换
从极坐标变换到笛卡尔坐标。
JSON Prototype
{ "angle": { "field": "angle", "type": "field" }, "direction": "anticlock", "id": "p59098", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "radius": { "field": "radius", "type": "field" }, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [] }
- 角度单位 = 'rad'#
- 类型:
用于关联属性的单位:度、弧度、梯度或圈
- 名称 = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用该名称。
- 半径 = Field(field='radius', transform=Unspecified, units=Unspecified)#
- 类型:
半径坐标(即从原点的距离)。
允许负半径,这等效于使用正半径并将
direction
更改为相反的值。
- 可同步的 = True#
- 类型:
指示当在 Web 浏览器中更新此模型时,是否应将其同步回 Bokeh 服务器。当处理频繁更新的对象,而我们不需要其更新值时,设置为
False
可能有助于减少网络流量。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调被触发。但是,任何 JS 端回调仍然有效。
- 标签 = []#
- 类型:
要附加到此模型的可选的任意用户提供的值列表。
当查询文档以检索特定的 Bokeh 模型时,此数据可能很有用
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到可由
CustomJS
回调等访问的模型的一种便捷方式。注意
对于提供的任何标签,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用这些标签。
- 应用主题(property_values: dict[str, Any]) None #
应用一组主题值,这些值将代替默认值使用,但不会覆盖应用程序设置的值。
传入的字典可以保持原样并与其他实例共享,以节省内存(因此调用者和
HasProps
实例都不应修改它)。- 参数:
property_values (dict) – 用于代替默认值的主题值
- 返回:
None
- classmethod 清除扩展() None #
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展都包含在生成的文档中,无论是否使用它们。此方法可用于清除所有现有的自定义扩展定义。
- classmethod 描述符() list[PropertyDescriptor[Any]] #
按定义顺序列出的属性描述符列表。
- 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 模型属性的值发生更改时更新另一个属性。- 参数:
在版本 1.1 中添加
- Raises:
示例
此代码与
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
的属性的描述符- 返回类型:
- 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 properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
收集此类上属性的名称。
警告
在 Bokeh 的未来版本中,此方法将返回一个字典,该字典将属性名称映射到属性对象。为了使此方法当前的用法适应未来,请将返回值包装在
list
中。- 返回:
属性名称
- classmethod properties_with_refs() dict[str, Property[Any]] #
收集此类上所有也具有引用的属性的名称。
此方法总是遍历类层次结构,并包括在任何父类上定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集一个字典,将属性名称映射到它们的值。
此方法总是遍历类层次结构,并包括在任何父类上定义的属性。
不可序列化的属性将被跳过,属性值将采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损地重构对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[Model] #
查询此对象及其所有引用,以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用,以查找与给定选择器匹配的对象。如果找到多个对象,则引发错误。返回单个匹配对象,如果未找到任何对象,则返回 None :param selector: :type selector: JSON-like
- 返回:
模型
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 在此对象上设置属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置给属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在进行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件设置者与自身进行比较,并阻止任何源自自身的更新。
- 返回:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的覆盖。
结果作为从属性名称到值的字典返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回:
字典或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化的表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class Stack(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Expression
用于通过对
ColumnDataSource
中不同列求和来生成数组的表达式。此表达式在底层实现堆叠条形图时非常有用。
JSON Prototype
{ "fields": [], "id": "p59106", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [] }
- fields = []#
-
要进行求和(逐元素)的
ColumnDataSource
中的字段序列。 例如Stack(fields=['sales', 'marketing'])
将通过添加数据源的
'sales'
和'marketing'
列的元素(在浏览器中)来计算一个数值数组。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。
>>> plot.scatter([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用该名称。
- syncable = True#
- 类型:
指示当在 Web 浏览器中更新此模型时,是否应将其同步回 Bokeh 服务器。当处理频繁更新的对象,而我们不需要其更新值时,设置为
False
可能有助于减少网络流量。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调被触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
要附加到此模型的可选的任意用户提供的值列表。
当查询文档以检索特定的 Bokeh 模型时,此数据可能很有用
>>> r = plot.scatter([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到可由
CustomJS
回调等访问的模型的一种便捷方式。注意
对于提供的任何标签,不强制执行唯一性保证或其他条件,Bokeh 出于任何原因也不直接使用这些标签。
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些值将代替默认值使用,但不会覆盖应用程序设置的值。
传入的字典可以保持原样并与其他实例共享,以节省内存(因此调用者和
HasProps
实例都不应修改它)。- 参数:
property_values (dict) – 用于代替默认值的主题值
- 返回:
None
- classmethod clear_extensions() None #
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展都包含在生成的文档中,无论是否使用它们。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序列出的属性描述符列表。
- 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 模型属性的值发生更改时更新另一个属性。- 参数:
在版本 1.1 中添加
- Raises:
示例
此代码与
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
的属性的描述符- 返回类型:
- 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 properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
收集此类上属性的名称。
警告
在 Bokeh 的未来版本中,此方法将返回一个字典,该字典将属性名称映射到属性对象。为了使此方法当前的用法适应未来,请将返回值包装在
list
中。- 返回:
属性名称
- classmethod properties_with_refs() dict[str, Property[Any]] #
收集此类上所有也具有引用的属性的名称。
此方法总是遍历类层次结构,并包括在任何父类上定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集一个字典,将属性名称映射到它们的值。
此方法总是遍历类层次结构,并包括在任何父类上定义的属性。
不可序列化的属性将被跳过,属性值将采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损地重构对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[Model] #
查询此对象及其所有引用,以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用,以查找与给定选择器匹配的对象。如果找到多个对象,则引发错误。返回单个匹配对象,如果未找到任何对象,则返回 None :param selector: :type selector: JSON-like
- 返回:
模型
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 在此对象上设置属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置给属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在进行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件设置者与自身进行比较,并阻止任何源自自身的更新。
- 返回:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的覆盖。
结果作为从属性名称到值的字典返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回:
字典或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化的表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #