tiles

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

Bases: MercatorTileSource

与 WMTSTileSource 具有相同的默认瓦片原点，但请求的瓦片使用 {XMIN}、{YMIN}、{XMAX}、{YMAX}，例如 http://your.custom.tile.service?bbox={XMIN},{YMIN},{XMAX},{YMAX}。

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p63175", 
  "initial_resolution": 156543.03392804097, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "max_zoom": 30, 
  "min_zoom": 0, 
  "name": null, 
  "snap_to_zoom": false, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tile_size": 256, 
  "url": "", 
  "use_latlon": false, 
  "wrap_around": true, 
  "x_origin_offset": 20037508.34, 
  "y_origin_offset": 20037508.34
}

attribution = ''

类型:

字符串

数据提供者归属内容。这可以包含 HTML 内容。

extra_url_vars = {}

类型:

Dict(String, Any)

一个将 url 变量模板键映射到值的字典。

这些变量对于瓦片 url 中不会从一个瓦片更改到另一个瓦片的部分很有用（例如服务器主机名或图层名）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

瓦片集投影的最小缩放级别的分辨率（绘图单位/像素）。None 表示自动计算。

max_zoom = 30

类型:

整数

瓦片图层的最大缩放级别。这是最放大级别的缩放级别。

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

snap_to_zoom = False

类型:

布尔值

强制初始范围捕捉到最接近的较大缩放级别。

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

tile_size = 256

类型:

整数

瓦片大小（以像素为单位）（例如 256）

url = ''

类型:

字符串

瓦片服务 url，例如 http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png

use_latlon = False

类型:

布尔值

指示选项是将 {XMIN}、{YMIN}、{XMAX}、{YMAX} 输出为米还是纬度和经度的标志。

wrap_around = True

类型:

布尔值

通过根据地图边界包裹 x 轴，实现水平方向的连续平移。

注意

轴坐标不进行包裹。要切换轴标签的可见性，请使用 plot.axis.visible = False。

x_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 x 偏移量

y_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 y 偏移量

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）

返回值：

从属性名称到其值的映射

返回类型：

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

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

结果以一个从属性名称到值的 dict 的形式返回，如果主题没有覆盖该实例的任何值，则返回 None。

返回值：

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

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

Bases: TileSource

墨卡托瓦片服务的基类（例如 WMTSTileSource）。

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p63191", 
  "initial_resolution": 156543.03392804097, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "max_zoom": 30, 
  "min_zoom": 0, 
  "name": null, 
  "snap_to_zoom": false, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tile_size": 256, 
  "url": "", 
  "wrap_around": true, 
  "x_origin_offset": 20037508.34, 
  "y_origin_offset": 20037508.34
}

attribution = ''

类型:

字符串

数据提供者归属内容。这可以包含 HTML 内容。

extra_url_vars = {}

类型:

Dict(String, Any)

一个将 url 变量模板键映射到值的字典。

这些变量对于瓦片 url 中不会从一个瓦片更改到另一个瓦片的部分很有用（例如服务器主机名或图层名）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

瓦片集投影的最小缩放级别的分辨率（绘图单位/像素）。None 表示自动计算。

max_zoom = 30

类型:

整数

瓦片图层的最大缩放级别。这是最放大级别的缩放级别。

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

snap_to_zoom = False

类型:

布尔值

强制初始范围捕捉到最接近的较大缩放级别。

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

tile_size = 256

类型:

整数

瓦片大小（以像素为单位）（例如 256）

url = ''

类型:

字符串

瓦片服务 url，例如 http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png

wrap_around = True

类型:

布尔值

通过根据地图边界包裹 x 轴，实现水平方向的连续平移。

注意

轴坐标不进行包裹。要切换轴标签的可见性，请使用 plot.axis.visible = False。

x_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 x 偏移量

y_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 y 偏移量

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: 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）

返回值：

从属性名称到其值的映射

返回类型：

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]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果未找到任何对象，则返回 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

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

结果以一个从属性名称到值的 dict 的形式返回，如果主题没有覆盖该实例的任何值，则返回 None。

返回值：

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

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

Bases: MercatorTileSource

它与 WMTSTileSource 具有相同的图块原点，但使用 quadkey 参数而不是 X、Y、Z 请求图块，例如：http://your.quadkey.tile.host/{Q}.png

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p63206", 
  "initial_resolution": 156543.03392804097, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "max_zoom": 30, 
  "min_zoom": 0, 
  "name": null, 
  "snap_to_zoom": false, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tile_size": 256, 
  "url": "", 
  "wrap_around": true, 
  "x_origin_offset": 20037508.34, 
  "y_origin_offset": 20037508.34
}

attribution = ''

类型:

字符串

数据提供者归属内容。这可以包含 HTML 内容。

extra_url_vars = {}

类型:

Dict(String, Any)

一个将 url 变量模板键映射到值的字典。

这些变量对于瓦片 url 中不会从一个瓦片更改到另一个瓦片的部分很有用（例如服务器主机名或图层名）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

瓦片集投影的最小缩放级别的分辨率（绘图单位/像素）。None 表示自动计算。

max_zoom = 30

整数

瓦片图层的最大缩放级别。这是最放大级别的缩放级别。

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

snap_to_zoom = False

类型:

布尔值

强制初始范围捕捉到最接近的较大缩放级别。

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

tile_size = 256

类型:

整数

瓦片大小（以像素为单位）（例如 256）

url = ''

类型:

字符串

瓦片服务 url，例如 http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png

wrap_around = True

类型:

布尔值

通过根据地图边界包裹 x 轴，实现水平方向的连续平移。

注意

轴坐标不进行包裹。要切换轴标签的可见性，请使用 plot.axis.visible = False。

x_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 x 偏移量

y_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 y 偏移量

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: 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）

返回值：

从属性名称到其值的映射

返回类型：

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]

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

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

结果以一个从属性名称到值的 dict 的形式返回，如果主题没有覆盖该实例的任何值，则返回 None。

返回值：

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

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

Bases: MercatorTileSource

包含瓦片配置信息，并根据模板化的 URL 提供瓦片 URL，例如 http://your.tms.server.host/{Z}/{X}/{Y}.png。 TMS 的特点是瓦片原点位于左下角。

TMSTileSource 还可以帮助实现自定义瓦片集（包括非空间数据集）的瓦片渲染器。

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p63221", 
  "initial_resolution": 156543.03392804097, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "max_zoom": 30, 
  "min_zoom": 0, 
  "name": null, 
  "snap_to_zoom": false, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tile_size": 256, 
  "url": "", 
  "wrap_around": true, 
  "x_origin_offset": 20037508.34, 
  "y_origin_offset": 20037508.34
}

attribution = ''

类型:

字符串

数据提供者归属内容。这可以包含 HTML 内容。

extra_url_vars = {}

类型:

Dict(String, Any)

一个将 url 变量模板键映射到值的字典。

这些变量对于瓦片 url 中不会从一个瓦片更改到另一个瓦片的部分很有用（例如服务器主机名或图层名）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

瓦片集投影的最小缩放级别的分辨率（绘图单位/像素）。None 表示自动计算。

max_zoom = 30

类型:

整数

瓦片图层的最大缩放级别。这是最放大级别的缩放级别。

min_zoom = 0

类型:

整数

瓦片图层的最小缩放级别。这是最缩小级别的缩放级别。

name

类型:

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

snap_to_zoom = False

类型:

布尔值

强制初始范围捕捉到最接近的较大缩放级别。

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

tile_size = 256

类型:

整数

瓦片大小（以像素为单位）（例如 256）

url = ''

类型:

字符串

瓦片服务 url，例如 http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png

wrap_around = True

类型:

布尔值

通过根据地图边界包裹 x 轴，实现水平方向的连续平移。

注意

轴坐标不进行包裹。要切换轴标签的可见性，请使用 plot.axis.visible = False。

x_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 x 偏移量

y_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 y 偏移量

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[

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

并非所有模型都支持所有事件。有关哪些模型能够触发哪些事件的更多信息，请参阅 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）

返回值：

从属性名称到其值的映射

返回类型：

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, <

从该对象中移除回调

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

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

结果以一个从属性名称到值的 dict 的形式返回，如果主题没有覆盖该实例的任何值，则返回 None。

返回值：

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

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

Bases: Model

所有瓦片源类型的基类。

通常，瓦片源用作 TileRenderer 的必需输入。

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p63236", 
  "initial_resolution": null, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "max_zoom": 30, 
  "min_zoom": 0, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tile_size": 256, 
  "url": "", 
  "x_origin_offset": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "y_origin_offset": {
    "name": "unset", 
    "type": "symbol"
  }
}

attribution = ''

类型:

字符串

数据提供者归属内容。这可以包含 HTML 内容。

extra_url_vars = {}

类型:

Dict(String, Any)

一个将 url 变量模板键映射到值的字典。

这些变量对于瓦片 url 中不会从一个瓦片更改到另一个瓦片的部分很有用（例如服务器主机名或图层名）。

initial_resolution = None

类型:

Nullable(Float)

瓦片集投影的最小缩放级别的分辨率（绘图单位/像素）。None 表示自动计算。

max_zoom = 30

类型:

整数

瓦片图层的最大缩放级别。这是最放大级别的缩放级别。

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

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

tile_size = 256

类型:

整数

瓦片大小（以像素为单位）（例如 256）

url = ''

类型:

字符串

瓦片服务 url，例如 http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png

x_origin_offset = Undefined

类型:

Required(Float)

在绘图坐标中的 x 偏移量

y_origin_offset = Undefined

类型:

Required(Float)

在绘图坐标中的 y 偏移量

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）

返回值：

从属性名称到其值的映射

返回类型：

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

Bases: MercatorTileSource

与 TMSTileSource 的行为非常相似，但其瓷砖原点位于左上角。

这是 web 地图应用中最常用的瓷砖源。谷歌、MapQuest、Stadia、Esri 和 OpenStreetMap 等公司提供的服务使用 WMTS 规范，例如 http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png。

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p63249", 
  "initial_resolution": 156543.03392804097, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "max_zoom": 30, 
  "min_zoom": 0, 
  "name": null, 
  "snap_to_zoom": false, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tile_size": 256, 
  "url": "", 
  "wrap_around": true, 
  "x_origin_offset": 20037508.34, 
  "y_origin_offset": 20037508.34
}

attribution = ''

类型:

字符串

数据提供者归属内容。这可以包含 HTML 内容。

extra_url_vars = {}

类型:

Dict(String, Any)

一个将 url 变量模板键映射到值的字典。

这些变量对于瓦片 url 中不会从一个瓦片更改到另一个瓦片的部分很有用（例如服务器主机名或图层名）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

瓦片集投影的最小缩放级别的分辨率（绘图单位/像素）。None 表示自动计算。

max_zoom = 30

类型:

整数

瓦片图层的最大缩放级别。这是最放大级别的缩放级别。

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

snap_to_zoom = False

类型:

布尔值

强制初始范围捕捉到最接近的较大缩放级别。

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

tile_size = 256

类型:

整数

瓦片大小（以像素为单位）（例如 256）

url = ''

类型:

字符串

瓦片服务 url，例如 http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png

wrap_around = True

类型:

布尔值

通过根据地图边界包裹 x 轴，实现水平方向的连续平移。

注意

轴坐标不进行包裹。要切换轴标签的可见性，请使用 plot.axis.visible = False。

x_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 x 偏移量

y_origin_offset = 20037508.34

类型:

Required(Float)

在绘图坐标中的 y 偏移量

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]) → Nonebokeh.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）

返回值：

从属性名称到其值的映射

返回类型：

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

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

结果以一个从属性名称到值的 dict 的形式返回，如果主题没有覆盖该实例的任何值，则返回 None。

返回值：

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

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）