变换#
表示在客户端(浏览器)端发生的数据转换。
- class CustomJSTransform(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
基类:
Transform
应用自定义的变换到数据。
警告
此 Bokeh 模型的明确目的是嵌入原始 JavaScript 代码以供浏览器执行。如果代码的任何部分源自不受信任的用户输入,那么您必须采取适当的措施,在传递给 Bokeh 之前对用户输入进行清理。
JSON 原型
{ "args": { "type": "map" }, "func": "", "id": "p66235", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "v_func": "" }
- args = {}#
-
名称到 Python 对象的映射。 特别是,这些可以是 bokeh 的模型。 这些对象作为命名参数的值提供给变换的代码片段,以供回调使用。
- func = ''#
- 类型:
用于转换单个值的 JavaScript 代码片段。 变量
x
将包含未转换的值,并且预计在渲染时存在于函数命名空间中。 该代码片段将插入到函数体中,因此需要 return 语句。示例
func = ''' return Math.floor(x) + 0.5 '''
- 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 也不会出于任何原因直接使用这些标签。
- v_func = ''#
- 类型:
用于转换值数组的 JavaScript 代码片段。 变量
xs
将包含未转换的数组,并且预计在渲染时存在于函数命名空间中。 该代码片段将插入到函数体中,因此需要 return 语句。示例
v_func = ''' const new_xs = new Array(xs.length) for(let i = 0; i < xs.length; i++) { new_xs[i] = xs[i] + 0.5 } return new_xs '''
警告
向量化函数
v_func
必须返回与输入xs
数组长度相同的数组。
- 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
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象上的属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置为属性的值
setter (ClientSession or ServerSession or None, optional) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较,并抑制任何源自自身的更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的值覆盖。
结果作为从属性名称到值的 dict 返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回值:
dict 或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化表示。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class Dodge(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
基类:
Transform
对数据应用固定的躲避量。
JSON 原型
{ "id": "p66242", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "range": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "value": 0 }
- 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
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象上的属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置为属性的值
setter (ClientSession or ServerSession or None, optional) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较,并抑制任何源自自身的更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的值覆盖。
结果作为从属性名称到值的 dict 返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回值:
dict 或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化表示。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class Interpolator(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
基类:
Transform
内插器变换的基类。
内插器返回一个函数的值,该函数已在指定的 (x, y) 数据对之间求值。例如,如果为内插器提供了两个控制点对,则在 ‘x’ 的特定值处的线性内插将产生 ‘y’ 的值,该值存在于连接两个控制点的线上。
内插器的控制点对可以通过以下方式指定:
值的字面序列
interp = Interpolator(x=[1, 2, 3, 4, 5], y=[2, 5, 10, 12, 16])
或在
ColumnDataSource
对象中定义的一对列
interp = Interpolator(x="year", y="earnings", data=jewlery_prices))
这是基类,不适用于最终用途。有关其特定插值方法的更多信息,请参阅最终派生类(
Jitter
、LineraInterpolator
、StepInterpolator
)的文档。注意
这是一个抽象基类,用于帮助组织 Bokeh 模型类型的层次结构。 它本身实例化是没有用的。
JSON 原型
{ "clip": true, "data": null, "id": "p66248", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "x": { "name": "unset", "type": "symbol" }, "y": { "name": "unset", "type": "symbol" } }
- data = None#
-
如果将字符串传递给
x
或y
参数,则定义命名列的来源的数据。
- 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
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象上的属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置为属性的值
setter (ClientSession or ServerSession or None, optional) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较,并抑制任何源自自身的更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的值覆盖。
结果作为从属性名称到值的 dict 返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回值:
dict 或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化表示。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class Jitter(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
基类:
Transform
对数据应用均匀或正态分布的随机抖动。
JSON 原型
{ "distribution": "uniform", "id": "p66256", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "mean": 0, "name": null, "range": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "width": 1 }
- distribution = 'uniform'#
-
用于生成随机散点的随机分布
- 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
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象上的属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置为属性的值
setter (ClientSession or ServerSession or None, optional) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较,并抑制任何源自自身的更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的值覆盖。
结果作为从属性名称到值的 dict 返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回值:
dict 或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化表示。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class LinearInterpolator(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Interpolator
计算通过
x
,y
, 和data
参数提供的控制点之间的线性插值。JSON 原型
{ "clip": true, "data": null, "id": "p66264", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "x": { "name": "unset", "type": "symbol" }, "y": { "name": "unset", "type": "symbol" } }
- data = None#
-
如果将字符串传递给
x
或y
参数,则定义命名列的来源的数据。
- 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
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象上的属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置为属性的值
setter (ClientSession or ServerSession or None, optional) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较,并抑制任何源自自身的更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的值覆盖。
结果作为从属性名称到值的 dict 返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回值:
dict 或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化表示。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class StepInterpolator(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Interpolator
计算通过
x
、y
和data
参数提供的点之间的阶梯式插值。JSON 原型
{ "clip": true, "data": null, "id": "p66272", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "mode": "after", "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "x": { "name": "unset", "type": "symbol" }, "y": { "name": "unset", "type": "symbol" } }
- data = None#
-
如果将字符串传递给
x
或y
参数,则定义命名列的来源的数据。
- mode = 'after'#
-
调整返回值相对于控制点的行为。此参数可以采用以下三个值之一
after
(默认):假定与最接近的 x 值关联的 y 值,该 x 值小于或等于要转换的点。before
:假定与最接近的 x 值关联的 y 值,该 x 值大于要转换的点。center
:假定与最接近要转换的点的 x 值关联的 y 值。
- 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
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象上的属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置为属性的值
setter (ClientSession or ServerSession or None, optional) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较,并抑制任何源自自身的更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的值覆盖。
结果作为从属性名称到值的 dict 返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回值:
dict 或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化表示。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class Transform(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Model
用于表示将在客户端执行的计算的
Transform
模型基类。JavaScript 实现应实现以下方法
注意
这是一个抽象基类,用于帮助组织 Bokeh 模型类型的层次结构。 它本身实例化是没有用的。
JSON 原型
{ "id": "p66281", "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]] #
按定义顺序排列的属性描述符列表。
- 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
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象上的属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON-value) – 要设置为属性的值
setter (ClientSession or ServerSession or None, optional) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较,并抑制任何源自自身的更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None #
获取任何主题提供的值覆盖。
结果作为从属性名称到值的 dict 返回,如果没有主题覆盖此实例的任何值,则返回
None
。- 返回值:
dict 或 None
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化表示。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #