范围

描述不同类型空间中不同类型值范围的模型（例如，连续或分类），并具有“自动调整大小”选项。

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

基类: NumericalRange

所有数据范围类型的基类。

注意

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

JSON 原型

{
  "end": {
    "type": "number", 
    "value": "nan"
  }, 
  "id": "p62025", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "renderers": [], 
  "start": {
    "type": "number", 
    "value": "nan"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

end = nan

类型:

Required(Either(Float, Datetime, TimeDelta))

范围的结束。

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

renderers = []

类型:

Either(List, Auto)

要根据其自动调整范围的渲染器的显式列表。如果未设置，默认情况下为绘图上的所有渲染器。

start = nan

类型:

Required(Either(Float, Datetime, TimeDelta))

范围的开始。

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

的名称DataSpec属性

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回值:

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

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

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

这是一个简化方法，它简化了添加 CustomJS 回调，以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

例子

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

• name (str) – 要查找的属性的名称

• raises (bool) – 如果丢失，是否要引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

例子

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

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

当此 Model 上发生指定的事件时运行回调函数

并非所有 Model 都支持所有事件。有关哪些 Model 可以触发事件的更多信息，请参见 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) – 是否包括自对象创建以来未明确设置的属性。 (default: 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-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 服务器应用程序的上下文中，传入的属性更新将用正在执行更新的会话进行注释。此值将传播到更新触发的任何后续更改通知。会话可以将事件设置程序与其自身进行比较，并抑制来自自身的所有更新。

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

例子

以下等价：

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: DataRange

连续标量维度中的自动拟合范围。

默认情况下，范围的 start 和 end 会自动假设关联渲染器的数据的最小值和最大值。

JSON 原型

{
  "bounds": null, 
  "default_span": 2.0, 
  "end": {
    "type": "number", 
    "value": "nan"
  }, 
  "flipped": false, 
  "follow": null, 
  "follow_interval": null, 
  "id": "p62032", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "max_interval": null, 
  "min_interval": null, 
  "name": null, 
  "only_visible": false, 
  "range_padding": 0.1, 
  "range_padding_units": "percent", 
  "renderers": [], 
  "start": {
    "type": "number", 
    "value": "nan"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

bounds = None

类型:

Nullable(MinMaxBounds)

范围允许到达的边界。通常用于防止用户从数据中平移/缩放/等。

默认情况下，边界将为 None，允许您的绘图尽可能地平移/缩放。如果边界为“auto”，它们将被计算为与 DataRange1d 的开始和结束相同。

边界作为 (min, max) 的元组提供，因此无论您的范围是递增还是递减，第一个项目都应该是范围的最小值，第二个项目应该是最大值。设置 min > max 将导致 ValueError。

如果您只想约束绘图的一端，可以将 min 或 max 设置为 None，例如 DataRange1d(bounds=(None, 12))

default_span = 2.0

类型:

Either(Float, TimeDelta)

区间的默认宽度，如果 start 等于 end（如果与对数轴一起使用，则 default_span 以 10 的幂表示）。

end = nan

类型:

Required(Either(Float, Datetime, TimeDelta))

范围的结束。

flipped = False

类型:

布尔值

是否应在自动设置范围时将范围“翻转”与其正常方向。

follow = None

类型:

Nullable(Enum(StartEnd))

配置数据以跟随一个或另一个数据极值，最大范围大小为 follow_interval。

如果设置为 "start"，则范围将调整，以便 start 始终对应于最小数据值（或最大值，如果 flipped 为 True）。

如果设置为 "end"，则范围将调整，以便 end 始终对应于最大数据值（或最小值，如果 flipped 为 True）。

如果设置为 None（默认值），则自动设置范围不会跟随，范围将包含最小值和最大值数据值。

follow 不能与边界一起使用，如果设置，边界将设置为 None。

follow_interval = None

类型:

Nullable(Either(Float, TimeDelta))

如果 follow 设置为 "start" 或 "end"，则范围将始终受限于该范围

abs(r.start - r.end) <= follow_interval

被维持。

max_interval = None

类型:

Either(Null, Float, TimeDelta)

允许范围缩小的级别，以最大可见间隔表示。 请注意，bounds 也会对最大间隔施加隐式约束。

min_interval = None

类型:

Either(Null, Float, TimeDelta)

允许范围放大的级别，以最小可见间隔表示。 如果设置为 None（默认），则最小间隔不受约束。

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

only_visible = False

类型:

布尔值

如果为 True，则将排除不可见的渲染器，以进行自动边界计算。

range_padding = 0.1

类型:

Either(Float, TimeDelta)

在计算出的数据边界周围添加多少填充。

当 range_padding_units 设置为 "percent" 时，范围跨度的范围将扩展，使范围比原来大 range_padding 个百分点。

当 range_padding_units 设置为 "absolute" 时，范围跨度的起点和终点将按 range_padding 的值进行扩展。

range_padding_units = 'percent'

类型:

Enum(PaddingUnits)

是否将 range_padding 解释为百分比，还是绝对值。 （默认值："percent"）

renderers = []

类型:

Either(List, Auto)

要根据其自动调整范围的渲染器的显式列表。如果未设置，默认情况下为绘图上的所有渲染器。

start = nan

类型:

Required(Either(Float, Datetime, TimeDelta))

范围的开始。

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

的名称DataSpec属性

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回值:

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

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

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

这是一个简化方法，它简化了添加 CustomJS 回调，以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

例子

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

• name (str) – 要查找的属性的名称

• raises (bool) – 如果丢失，是否要引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

例子

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

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

当此 Model 上发生指定的事件时运行回调函数

并非所有 Model 都支持所有事件。有关哪些 Model 可以触发事件的更多信息，请参见 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) – 是否包括自对象创建以来未明确设置的属性。 (default: 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-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 服务器应用程序的上下文中，传入的属性更新将用正在执行更新的会话进行注释。此值将传播到更新触发的任何后续更改通知。会话可以将事件设置程序与其自身进行比较，并抑制来自自身的所有更新。

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

例子

以下等价：

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: Range

用于分类维度的值范围。

除了向 FactorRange 初始化程序提供 factors 作为关键字参数外，您还可以使用位置参数序列进行实例化

FactorRange("foo", "bar") # equivalent to FactorRange(factors=["foo", "bar"])

用户通常会直接提供分类值

p.circle(x=["foo", "bar"], ...)

BokehJS 将创建从 "foo" 和 "bar" 到称为“合成坐标”的数字坐标系的映射。在最简单的情况下，因子在合成坐标中相隔 1.0 的距离，但是从因子到合成坐标的精确映射会受到填充属性以及因子拥有的级别数的影响。

用户通常不需要担心此映射的细节，但是通过添加偏移量可以微调位置。在将因子作为坐标或值提供时，可以通过将最终数字值添加到因子元组中，来在合成坐标空间中添加偏移量。例如

p.circle(x=[("foo", 0.3), ...], ...)

将第一个圆圈放在一个 x 位置，该位置通过将 0.3 添加到 "foo" 的合成坐标来偏移。

JSON 原型

{
  "bounds": null, 
  "end": 0, 
  "factor_padding": 0.0, 
  "factors": [], 
  "group_padding": 1.4, 
  "id": "p62049", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "max_interval": null, 
  "min_interval": null, 
  "name": null, 
  "range_padding": 0, 
  "range_padding_units": "percent", 
  "start": 0, 
  "subgroup_padding": 0.8, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

bounds = None

类型:

Nullable(MinMaxBounds)

允许范围到达的边界（以合成坐标表示）。通常用于防止用户从数据中平移/缩放/等。

注意

合成坐标仅在浏览器中计算，基于因子和各种填充属性。可能需要一些实验才能找到适合特定情况的边界。

默认情况下，边界将为 None，允许您的图按您想要的方式平移/缩放。如果边界为“auto”，它们将被计算为与 FactorRange 的开始和结束相同。

end = 0

类型:

只读

范围的结束，以合成坐标表示。

注意

合成坐标仅在浏览器中计算，基于因子和各种填充属性。在双向通信可用（例如，服务器，笔记本）的情况下，end 的值才能获得。

factor_padding = 0.0

类型:

Float

在所有最低级因子之间添加多少填充。当 factor_padding 非零时，每个组中的每个因子都将应用填充值。

factors = []

类型:

FactorSeq

定义此分类范围的一系列因子。

因子可以具有 1、2 或 3 个级别。对于 1 级因子，每个因子只是一个字符串。例如

FactorRange(factors=["sales", "marketing", "engineering"])

定义一个范围，其中包含三个简单的因子，这些因子可能代表一个企业的不同部门。

对于 2 级和 3 级因子，每个因子都是一个字符串元组

FactorRange(factors=[
    ["2016", "sales"], ["2016", "marketing"], ["2016", "engineering"],
    ["2017", "sales"], ["2017", "marketing"], ["2017", "engineering"],
])

定义一个范围，其中包含六个 2 级因子，这些因子可能代表三个业务部门，按年份分组。

请注意，因子和子因子 *只能是字符串*。

group_padding = 1.4

类型:

Float

在因子的顶层组之间添加多少填充。此属性仅在总范围因子具有两个或三个级别时才适用。例如，对于

FactorRange(factors=[["foo", "1"], ["foo", "2"], ["bar", "1"]])

顶层组对应于 "foo" 和 "bar"，并且组填充将在因子 ["foo", "2"] 和 ["bar", "1"] 之间应用

max_interval = None

类型:

Nullable(Float)

允许范围缩小的级别，以合成坐标中的最大可见间隔表示。请注意，bounds 也可以对最大间隔施加隐式约束。

类别的默认“宽度”在合成坐标中为 1.0。但是，因子之间的距离会受到各种填充属性以及因子是否分组的影响。

min_interval = None

类型:

Nullable(Float)

允许缩放范围的级别，表示为合成坐标中的最小可见间隔。如果设置为 None（默认），则最小间隔不受限制。

类别的默认“宽度”在合成坐标中为 1.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_padding = 0

类型:

Float

在计算范围边界外部添加多少填充。

当 range_padding_units 设置为 "percent" 时，范围跨度的范围将扩展，使范围比原来大 range_padding 个百分点。

当 range_padding_units 设置为 "absolute" 时，范围跨度的起点和终点将按 range_padding 的值进行扩展。

range_padding_units = 'percent'

类型:

Enum(PaddingUnits)

是否将 range_padding 解释为百分比，还是绝对值。 （默认值："percent"）

start = 0

类型:

只读

范围的起点，以合成坐标表示。

注意

合成坐标仅在浏览器中计算，基于因素和各种填充属性。 start 的值仅在双向通信可用（例如服务器、笔记本）的情况下才能获得。

subgroup_padding = 0.8

类型:

Float

在因素的中级组之间添加多少填充。此属性仅在总体因素具有三级时适用。例如，对于

FactorRange(factors=[
    ['foo', 'A', '1'],  ['foo', 'A', '2'], ['foo', 'A', '3'],
    ['foo', 'B', '2'],
    ['bar', 'A', '1'],  ['bar', 'A', '2']
])

此属性决定在 [‘foo’, ‘A’] 组中的三个因素之间，以及在 [bar]

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

的名称DataSpec属性

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回值:

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

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

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

这是一个简化方法，它简化了添加 CustomJS 回调，以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

例子

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

• name (str) – 要查找的属性的名称

• raises (bool) – 如果丢失，是否要引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

例子

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

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

当此 Model 上发生指定的事件时运行回调函数

并非所有 Model 都支持所有事件。有关哪些 Model 可以触发事件的更多信息，请参见 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) – 是否包括自对象创建以来未明确设置的属性。 (default: 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-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 服务器应用程序的上下文中，传入的属性更新将用正在执行更新的会话进行注释。此值将传播到更新触发的任何后续更改通知。会话可以将事件设置程序与其自身进行比较，并抑制来自自身的所有更新。

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

例子

以下等价：

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: Model

所有范围类型的基类。

注意

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

JSON 原型

{
  "id": "p62064", 
  "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) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

的名称DataSpec属性

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回值:

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

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

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

这是一个简化方法，它简化了添加 CustomJS 回调，以在另一个 Bokeh 模型属性更改值时更新一个 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:

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

参数:

• name (str) – 要查找的属性的名称

• raises (bool) – 如果丢失，是否要引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

例子

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

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

当此 Model 上发生指定的事件时运行回调函数

并非所有 Model 都支持所有事件。有关哪些 Model 可以触发事件的更多信息，请参见 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) – 是否包括自对象创建以来未明确设置的属性。 (default: True)

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[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-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 服务器应用程序的上下文中，传入的属性更新将用正在执行更新的会话进行注释。此值将传播到更新触发的任何后续更改通知。会话可以将事件设置程序与其自身进行比较，并抑制来自自身的所有更新。

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

例子

以下等价：

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

基类: NumericalRange

在连续的标量维度中，一个固定的闭区间 [start, end]。

除了在Range1d 初始化程序中提供start 和 end 关键字参数外，您还可以使用以下便捷语法实例化：

Range(0, 10) # equivalent to Range(start=0, end=10)

JSON 原型

{
  "bounds": null, 
  "end": 1, 
  "id": "p62068", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "max_interval": null, 
  "min_interval": null, 
  "name": null, 
  "reset_end": null, 
  "reset_start": null, 
  "start": 0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

bounds = None

类型:

Nullable(MinMaxBounds)

范围允许到达的边界。通常用于防止用户从数据中平移/缩放/等。

如果设置为 'auto'，则边界将计算为 Range 的起始点和结束点。

边界以 (min, max) 的元组形式提供，因此无论您的范围是递增还是递减，第一个项目都应该是范围的最小值，第二个项目应该是最大值。设置 min > max 将导致 ValueError。

默认情况下，边界为 None，您的图表可以任意地平移/缩放。如果您只想约束图表的某一端，可以将 min 或 max 设置为 None。

例子

Range1d(0, 1, bounds='auto')  # Auto-bounded to 0 and 1 (Default behavior)
Range1d(start=0, end=1, bounds=(0, None))  # Maximum is unbounded, minimum bounded to 0

end = 1

类型:

Required(Either(Float, Datetime, TimeDelta))

范围的结束。

max_interval = None

类型:

Either(Null, Float, TimeDelta)

允许范围缩小的级别，以最大可见间隔表示。可以是 TimeDelta。请注意，bounds 也可以对最大间隔施加隐式约束。

min_interval = None

类型:

Either(Null, Float, TimeDelta)

允许范围放大的级别，以最小可见间隔表示。如果设置为 None（默认值），则最小间隔不会绑定。可以是 TimeDelta。

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

reset_end = None

类型:

Either(Null, Float, Datetime, TimeDelta)

重置时要应用的范围的结束点。如果设置为 None，则默认为初始化期间的 end 值。

reset_start = None

类型:

Either(Null, Float, Datetime, TimeDelta)

重置后应用的范围起点。如果设置为 None，则默认为初始化期间的 start 值。

start = 0

类型:

Required(Either(Float, Datetime, TimeDelta))

范围的开始。

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

的名称DataSpec属性

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回值:

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

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

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

这是一个简化方法，它简化了添加 CustomJS 回调，以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

例子

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

• name (str) – 要查找的属性的名称

• raises (bool) – 如果丢失，是否要引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

例子

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

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

当此 Model 上发生指定的事件时运行回调函数

并非所有 Model 都支持所有事件。有关哪些 Model 可以触发事件的更多信息，请参见 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:

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

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

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

参数:

include_defaults (bool, optional) – 是否包括自对象创建以来未明确设置的属性。 (default: 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-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 服务器应用程序的上下文中，传入的属性更新将用正在执行更新的会话进行注释。此值将传播到更新触发的任何后续更改通知。会话可以将事件设置程序与其自身进行比较，并抑制来自自身的所有更新。

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

例子

以下等价：

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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