tiles

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

基类： MercatorTileSource

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

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p65283", 
  "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, AnyRef)

一个字典，将 URL 变量模板键映射到值。

这些变量对于瓦片 URL 中不随瓦片变化的部分很有用（例如，服务器主机名或图层名称）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

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

max_zoom = 30

类型:

Int

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

min_zoom = 0

类型:

Int

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

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

snap_to_zoom = False

类型:

Bool

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

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

tile_size = 256

类型:

Int

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

url = ''

类型:

字符串

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

use_latlon = False

类型:

Bool

标志，指示以米或经纬度输出 {XMIN}、{YMIN}、{XMAX}、{YMAX} 的选项。

wrap_around = True

类型:

Bool

通过基于地图边界环绕 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 中项目的索引

Added in version 1.1

Raises:

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

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

• query (可调用对象) – 接受属性描述符并返回 True 或 False 的可调用对象

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

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

基类： TileSource

Mercator 瓦片服务（例如 WMTSTileSource）的基类。

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p65299", 
  "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, AnyRef)

一个字典，将 URL 变量模板键映射到值。

这些变量对于瓦片 URL 中不随瓦片变化的部分很有用（例如，服务器主机名或图层名称）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

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

max_zoom = 30

类型:

Int

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

min_zoom = 0

类型:

Int

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

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

snap_to_zoom = False

类型:

Bool

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

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

tile_size = 256

类型:

Int

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

url = ''

类型:

字符串

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

wrap_around = True

类型:

Bool

通过基于地图边界环绕 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

类方法 clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制一个 HasProps 对象。

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

类方法 dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

类方法 descriptors() → list[PropertyDescriptor[Any]]

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回:

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

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

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

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

参数:

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

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

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

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

Added in version 1.1

Raises:

ValueError –

示例

此代码使用 js_link

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回:

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 中的特定事件。

类方法 parameters() → list[Parameter]

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

返回:

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回:

属性名称

类方法 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 (可调用对象) – 接受属性描述符并返回 True 或 False 的可调用对象

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

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 (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)

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

基类： MercatorTileSource

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

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p65314", 
  "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, AnyRef)

一个字典，将 URL 变量模板键映射到值。

这些变量对于瓦片 URL 中不随瓦片变化的部分很有用（例如，服务器主机名或图层名称）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

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

max_zoom = 30

类型:

Int

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

min_zoom = 0

类型:

Int

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

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

snap_to_zoom = False

类型:

Bool

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

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

tile_size = 256

类型:

Int

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

url = ''

类型:

字符串

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

wrap_around = True

类型:

Bool

通过基于地图边界环绕 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 中项目的索引

Added in version 1.1

Raises:

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

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

• query (可调用对象) – 接受属性描述符并返回 True 或 False 的可调用对象

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

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

基类： MercatorTileSource

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

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

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p65329", 
  "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, AnyRef)

一个字典，将 URL 变量模板键映射到值。

这些变量对于瓦片 URL 中不随瓦片变化的部分很有用（例如，服务器主机名或图层名称）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

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

max_zoom = 30

类型:

Int

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

min_zoom = 0

类型:

Int

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

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

snap_to_zoom = False

类型:

Bool

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

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

tile_size = 256

类型:

Int

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

url = ''

类型:

字符串

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

wrap_around = True

类型:

Bool

通过基于地图边界环绕 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 中项目的索引

Added in version 1.1

Raises:

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

当指定事件在此 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, 可选) – 是否包括自对象创建以来未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

• query (可调用对象) – 接受属性描述符并返回 True 或 False 的可调用对象

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

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

Bases: Model

A base class for all tile source types.

In general, tile sources are used as a required input for TileRenderer.

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p65344", 
  "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, AnyRef)

一个字典，将 URL 变量模板键映射到值。

这些变量对于瓦片 URL 中不随瓦片变化的部分很有用（例如，服务器主机名或图层名称）。

initial_resolution = None

类型:

Nullable(Float)

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

max_zoom = 30

类型:

Int

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

min_zoom = 0

类型:

Int

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

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

tile_size = 256

类型:

Int

瓦片大小，以像素为单位（例如 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 中项目的索引

Added in version 1.1

Raises:

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

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

• query (可调用对象) – 接受属性描述符并返回 True 或 False 的可调用对象

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

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

基类： MercatorTileSource

行为方式与 TMSTileSource 非常相似，但其瓦片原点位于左上角。

这是 Web 地图应用程序最常用的瓦片源。Google、MapQuest、Stadia、Esri 和 OpenStreetMap 等公司提供的服务都使用 WMTS 规范，例如 http://c.tile.openstreetmap.org/{Z}/{X}/{Y}.png。

JSON 原型

{
  "attribution": "", 
  "extra_url_vars": {
    "type": "map"
  }, 
  "id": "p65357", 
  "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, AnyRef)

一个字典，将 URL 变量模板键映射到值。

这些变量对于瓦片 URL 中不随瓦片变化的部分很有用（例如，服务器主机名或图层名称）。

initial_resolution = 156543.03392804097

类型:

Nullable(Float)

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

max_zoom = 30

类型:

Int

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

min_zoom = 0

类型:

Int

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

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

snap_to_zoom = False

类型:

Bool

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

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

tile_size = 256

类型:

Int

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

url = ''

类型:

字符串

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

wrap_around = True

类型:

Bool

通过基于地图边界环绕 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 中项目的索引

Added in version 1.1

Raises:

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

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

• query (可调用对象) – 接受属性描述符并返回 True 或 False 的可调用对象

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

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 (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)