ranges

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

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

基类： NumericalRange

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

注意

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

JSON 原型

{
  "end": {
    "type": "number", 
    "value": "nan"
  }, 
  "id": "p64079", 
  "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.scatter([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

类型:

布尔值 (Bool)

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

注意

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

tags = []

类型:

列表 (List)

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

当查询文档以检索特定的 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

清除当前定义的任何自定义扩展。

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

• name (str) – 要搜索的属性的名称

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

在此对象上添加回调，以便在 attr 更改时触发。

参数:

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

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

返回:

None

示例

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

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

当在此模型上发生指定的事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使此方法当前的用法在未来兼容，请将返回值包装在 list 中。

返回:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

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

返回:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

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

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

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

参数:

include_defaults (bool, 可选) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

字典

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

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

参数:

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

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

返回:

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

返回类型:

字典

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

从此对象的 JSON 中设置属性值。

参数:

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

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

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

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

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

返回:

None

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

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

参数:

• selector (类 JSON)

• updates (字典)

返回:

None

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

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

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

返回:

字典 or 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)

基类：DataRange

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

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

JSON 原型

{
  "bounds": null, 
  "default_span": 2.0, 
  "end": {
    "type": "number", 
    "value": "nan"
  }, 
  "flipped": false, 
  "follow": null, 
  "follow_interval": null, 
  "id": "p64086", 
  "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

类型:

布尔值 (Bool)

范围在自动调整范围时是否应从其正常方向“翻转”。

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

注意

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

only_visible = False

类型:

布尔值 (Bool)

如果为 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

类型:

布尔值 (Bool)

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

注意

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

tags = []

类型:

列表 (List)

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

当查询文档以检索特定的 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

清除当前定义的任何自定义扩展。

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

• name (str) – 要搜索的属性的名称

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

在此对象上添加回调，以便在 attr 更改时触发。

参数:

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

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

返回:

None

示例

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

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

当在此模型上发生指定的事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使此方法当前的用法在未来兼容，请将返回值包装在 list 中。

返回:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

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

返回:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

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

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

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

参数:

include_defaults (bool, 可选) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

字典

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

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

参数:

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

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

返回:

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

返回类型:

字典

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

从此对象的 JSON 中设置属性值。

参数:

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

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

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

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

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

返回:

None

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

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

参数:

• selector (类 JSON)

• updates (字典)

返回:

None

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

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

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

返回:

字典 or 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

分类维度值的范围。

除了将 factors 作为关键字参数提供给 FactorRange 初始化器之外，您还可以使用位置参数序列实例化

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

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

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

BokehJS 将创建从 "foo" 和 "bar" 到名为合成坐标的数值坐标系的映射。在最简单的情况下，因子在合成坐标中以 1.0 的距离分隔，但是因子到合成坐标的确切映射受到填充属性以及因子具有的级别数量的影响。

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

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

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

JSON 原型

{
  "bounds": null, 
  "end": 0, 
  "factor_padding": 0.0, 
  "factors": [], 
  "group_padding": 1.4, 
  "id": "p64103", 
  "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

类型:

浮点型

在所有最低级别因子之间添加多少填充。当 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

类型:

浮点型

在顶级因子组之间添加多少填充。此属性仅在整体范围因子具有两个或三个级别时适用。例如，使用

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

注意

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

range_padding = 0

类型:

浮点型

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

当 range_padding_units 设置为 "percent" 时，范围跨度将展开，使范围扩大 range_padding 百分比。

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

range_padding_units = 'percent'

类型:

Enum(PaddingUnits)

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

start = 0

类型:

只读

范围的起始位置，以合成坐标表示。

注意

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

subgroup_padding = 0.8

类型:

浮点型

在中间层级的因子组之间添加多少填充。此属性仅在整体因子具有三个层级时适用。例如：

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

类型:

布尔值 (Bool)

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

注意

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

tags = []

类型:

列表 (List)

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

当查询文档以检索特定的 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

清除当前定义的任何自定义扩展。

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

• name (str) – 要搜索的属性的名称

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

在此对象上添加回调，以便在 attr 更改时触发。

参数:

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

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

返回:

None

示例

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

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

当在此模型上发生指定的事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使此方法当前的用法在未来兼容，请将返回值包装在 list 中。

返回:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

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

返回:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

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

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

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

参数:

include_defaults (bool, 可选) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

字典

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

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

参数:

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

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

返回:

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

返回类型:

字典

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

从此对象的 JSON 中设置属性值。

参数:

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

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

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

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

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

返回:

None

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

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

参数:

• selector (类 JSON)

• updates (字典)

返回:

None

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

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

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

返回:

字典 or 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": "p64118", 
  "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.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

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

syncable = True

类型:

布尔值 (Bool)

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

注意

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

tags = []

类型:

列表 (List)

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

当查询文档以检索特定的 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

清除当前定义的任何自定义扩展。

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

• name (str) – 要搜索的属性的名称

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

在此对象上添加回调，以便在 attr 更改时触发。

参数:

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

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

返回:

None

示例

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

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

当在此模型上发生指定的事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使此方法当前的用法在未来兼容，请将返回值包装在 list 中。

返回:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

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

返回:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

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

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

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

参数:

include_defaults (bool, 可选) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

字典

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

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

参数:

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

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

返回:

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

返回类型:

字典

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

从此对象的 JSON 中设置属性值。

参数:

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

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

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

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

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

返回:

None

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

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

参数:

• selector (类 JSON)

• updates (字典)

返回:

None

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

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

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

返回:

字典 or 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": "p64122", 
  "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'，则边界将计算为范围的起始值和结束值。

边界以 (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.scatter([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

类型:

布尔值 (Bool)

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

注意

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

tags = []

类型:

列表 (List)

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

当查询文档以检索特定的 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

清除当前定义的任何自定义扩展。

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

• name (str) – 要搜索的属性的名称

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

在此对象上添加回调，以便在 attr 更改时触发。

参数:

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

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

返回:

None

示例

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

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

当在此模型上发生指定的事件时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发特定事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使此方法当前的用法在未来兼容，请将返回值包装在 list 中。

返回:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

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

返回:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

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

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

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

参数:

include_defaults (bool, 可选) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

字典

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

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

参数:

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

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

返回:

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

返回类型:

字典

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

从此对象的 JSON 中设置属性值。

参数:

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

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

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

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

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

返回:

None

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

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

参数:

• selector (类 JSON)

• updates (字典)

返回:

None

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

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

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

返回:

字典 or 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)