变换

表示在客户端（浏览器）端对数据进行的转换。

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

基类: Transform

将自定义定义的转换应用于数据。

警告

此 Bokeh 模型的明确目的是嵌入原始 JavaScript 代码以供浏览器执行。如果代码的任何部分源自不受信任的用户输入，则必须采取适当的措施在传递给 Bokeh 之前对用户输入进行清理。

JSON 原型

{
  "args": {
    "type": "map"
  }, 
  "func": "", 
  "id": "p63754", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "v_func": ""
}

args = {}

类型:

Dict(String, AnyRef)

名称到 Python 对象的映射。特别是，这些可以是 bokeh 的模型。这些对象作为命名参数的值提供给转换代码片段，作为回调的函数参数。

func = ''

类型:

字符串

转换单个值的 JavaScript 代码片段。变量x将包含未转换的值，并且可以预期在渲染时存在于函数命名空间中。代码片段将插入函数体中，因此需要 return 语句。

示例

func = '''
return Math.floor(x) + 0.5
'''

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 也不会出于任何原因直接使用该名称。

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 也不会出于任何原因直接使用这些标签。

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) – 用作默认值的主题值

返回值:

无

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 模型属性的值发生更改时更新一个 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) – 要注册的回调函数

返回值:

无

示例

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, optional) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

属性名称与其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回值:

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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  这在需要更新的属性也具有引用值的情况下是必要的。

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

  这用于防止对 Bokeh 应用程序进行“回弹”更新。

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

返回值:

无

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

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

参数:

• selector (类 JSON)

• updates (dict)

返回值:

无

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

unapply_theme() → None

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

返回值:

无

update(**kwargs: Any) → None

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

返回值:

无

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

属性 document: Document | None

此模型所附加的 Document（可以是 None）

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

基类: Transform

对数据应用固定偏移量。

JSON 原型

{
  "id": "p63761", 
  "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

类型:

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 也不会出于任何原因直接使用该名称。

range = None

类型:

Nullable(Instance(Range))

当将 Dodge 应用于分类数据值时，必须将相应的 FactorRange 作为 range 属性提供。

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 也不会出于任何原因直接使用这些标签。

value = 0

类型:

浮点数

偏移输入数据的量。

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

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

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

参数:

property_values (dict) – 用作默认值的主题值

返回值:

无

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 模型属性的值发生更改时更新一个 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) – 要注册的回调函数

返回值:

无

示例

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, optional) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

属性名称与其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回值:

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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  这在需要更新的属性也具有引用值的情况下是必要的。

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

  这用于防止对 Bokeh 应用程序进行“回弹”更新。

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

返回值:

无

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

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

参数:

• selector (类 JSON)

• updates (dict)

返回值:

无

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

unapply_theme() → None

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

返回值:

无

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

基类: 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": "p63767", 
  "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"
  }
}

clip = True

类型:

布尔值

确定插值是否应裁剪结果以仅包含其预定义范围内的值。如果将其设置为 False，它将返回最接近点的最大值。

data = None

类型:

Nullable(Instance(ColumnarDataSource))

如果将字符串传递给 x 或 y 参数，则定义命名列源的数据。

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 也不会出于任何原因直接使用该名称。

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 也不会出于任何原因直接使用这些标签。

x = Undefined

类型:

Required(Either(String, Seq(Float)))

表示点位置的独立坐标。

y = Undefined

类型:

Required(Either(String, Seq(Float)))

表示特定位置点值的从属坐标。

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

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

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

参数:

property_values (dict) – 用作默认值的主题值

返回值:

无

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 模型属性的值发生更改时更新一个 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) – 要注册的回调函数

返回值:

无

示例

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, optional) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

属性名称与其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回值:

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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  这在需要更新的属性也具有引用值的情况下是必要的。

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

  这用于防止对 Bokeh 应用程序进行“回弹”更新。

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

返回值:

无

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

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

参数:

• selector (类 JSON)

• updates (dict)

返回值:

无

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

unapply_theme() → None

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

返回值:

无

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

基类: Transform

对数据应用均匀或正态采样的随机抖动。

JSON 原型

{
  "distribution": "uniform", 
  "id": "p63775", 
  "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'

类型:

Enum(JitterRandomDistribution)

从中提取随机散布的随机分布

mean = 0

类型:

浮点数

随机样本的中心值

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 也不会出于任何原因直接使用该名称。

range = None

类型:

Nullable(Instance(Range))

当将 Jitter 应用于分类数据值时，必须将相应的 FactorRange 作为 range 属性提供。

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 也不会出于任何原因直接使用这些标签。

width = 1

类型:

浮点数

随机样本的宽度（对于均匀分布为绝对值，对于正态分布为 sigma）。

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

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

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

参数:

property_values (dict) – 用作默认值的主题值

返回值:

无

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 模型属性的值发生更改时更新一个 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) – 要注册的回调函数

返回值:

无

示例

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, optional) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

属性名称与其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回值:

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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  这在需要更新的属性也具有引用值的情况下是必要的。

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

  这用于防止对 Bokeh 应用程序进行“回弹”更新。

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

返回值:

无

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

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

参数:

• selector (类 JSON)

• updates (dict)

返回值:

无

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

unapply_theme() → None

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

返回值:

无

update(**kwargs: Any) → None

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

返回值:

无

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

属性 document: Document | None

此模型所附加的 Document（可以是 None）

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

基类: Interpolator

通过 x、y 和 data 参数提供的控制点计算线性插值。

JSON 原型

{
  "clip": true, 
  "data": null, 
  "id": "p63783", 
  "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"
  }
}

clip = True

类型:

布尔值

确定插值是否应裁剪结果以仅包含其预定义范围内的值。如果将其设置为 False，它将返回最接近点的最大值。

data = None

类型:

Nullable(Instance(ColumnarDataSource))

如果将字符串传递给 x 或 y 参数，则定义命名列源的数据。

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 也不会出于任何原因直接使用该名称。

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 也不会出于任何原因直接使用这些标签。

x = Undefined

类型:

Required(Either(String, Seq(Float)))

表示点位置的独立坐标。

y = Undefined

类型:

Required(Either(String, Seq(Float)))

表示特定位置点值的从属坐标。

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

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

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

参数:

property_values (dict) – 用作默认值的主题值

返回值:

无

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 模型属性的值发生更改时更新一个 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) – 要注册的回调函数

返回值:

无

示例

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, optional) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

属性名称与其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回值:

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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  这在需要更新的属性也具有引用值的情况下是必要的。

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

  这用于防止对 Bokeh 应用程序进行“回弹”更新。

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

返回值:

无

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

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

参数:

• selector (类 JSON)

• updates (dict)

返回值:

无

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

unapply_theme() → None

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

返回值:

无

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

基类: Interpolator

通过 x、y 和 data 参数提供的点，计算分段线性插值。

JSON 原型

{
  "clip": true, 
  "data": null, 
  "id": "p63791", 
  "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"
  }
}

clip = True

类型:

布尔值

确定插值是否应裁剪结果以仅包含其预定义范围内的值。如果将其设置为 False，它将返回最接近点的最大值。

data = None

类型:

Nullable(Instance(ColumnarDataSource))

如果将字符串传递给 x 或 y 参数，则定义命名列源的数据。

mode = 'after'

类型:

Enum(StepMode)

调整返回的值相对于控制点的行为。该参数可以取三个值之一

• after (默认值)：假设与小于或等于要转换的点的最近的 x 值关联的 y 值。

• before：假设与大于要转换的点的最近的 x 值关联的 y 值。

• center：假设与最接近要转换的点的 x 值关联的 y 值。

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 也不会出于任何原因直接使用该名称。

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 也不会出于任何原因直接使用这些标签。

x = Undefined

类型:

Required(Either(String, Seq(Float)))

表示点位置的独立坐标。

y = Undefined

类型:

Required(Either(String, Seq(Float)))

表示特定位置点值的从属坐标。

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

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

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

参数:

property_values (dict) – 用作默认值的主题值

返回值:

无

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 模型属性的值发生更改时更新一个 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) – 要注册的回调函数

返回值:

无

示例

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, optional) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

属性名称与其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回值:

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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  这在需要更新的属性也具有引用值的情况下是必要的。

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

  这用于防止对 Bokeh 应用程序进行“回弹”更新。

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

返回值:

无

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

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

参数:

• selector (类 JSON)

• updates (dict)

返回值:

无

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

unapply_theme() → None

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

返回值:

无

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

基类：Model

表示在客户端执行计算的Transform模型的基类。

JavaScript 实现应该实现以下方法

注意

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

JSON 原型

{
  "id": "p63800", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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 也不会出于任何原因直接使用该名称。

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 也不会出于任何原因直接使用这些标签。

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

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

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

参数:

property_values (dict) – 用作默认值的主题值

返回值:

无

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 模型属性的值发生更改时更新一个 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) – 要注册的回调函数

返回值:

无

示例

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, optional) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

属性名称与其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回值:

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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  这在需要更新的属性也具有引用值的情况下是必要的。

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

  这用于防止对 Bokeh 应用程序进行“回弹”更新。

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

返回值:

无

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

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

参数:

• selector (类 JSON)

• updates (dict)

返回值:

无

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

unapply_theme() → None

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

返回值:

无

update(**kwargs: Any) → 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）