ImageURL

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

Bases: XYGlyph

从给定 URL 加载并渲染图像。

示例

import numpy as np

from bokeh.io import curdoc, show
from bokeh.models import ColumnDataSource, Grid, ImageURL, LinearAxis, Plot, Range1d

url = "https://static.bokeh.org.cn/logos/logo.png"
N = 5

source = ColumnDataSource(dict(
    url = [url]*N,
    x1  = np.linspace(  0, 150, N),
    y1  = np.linspace(  0, 150, N),
    w1  = np.linspace( 10,  50, N),
    h1  = np.linspace( 10,  50, N),
    x2  = np.linspace(-50, 150, N),
    y2  = np.linspace(  0, 200, N),
))

xdr = Range1d(start=-100, end=200)
ydr = Range1d(start=-100, end=200)

plot = Plot(
    title=None, x_range=xdr, y_range=ydr, width=300, height=300,
    min_border=0, toolbar_location=None)

image1 = ImageURL(url="url", x="x1", y="y1", w="w1", h="h1", anchor="center")
plot.add_glyph(source, image1)

image2 = ImageURL(url="url", x="x2", y="y2", w=20, h=20, anchor="top_left")
plot.add_glyph(source, image2)

image3 = ImageURL(url=dict(value=url), x=200, y=-100, anchor="bottom_right")
plot.add_glyph(source, image3)

xaxis = LinearAxis()
plot.add_layout(xaxis, 'below')

yaxis = LinearAxis()
plot.add_layout(yaxis,'left')

plot.add_layout(Grid(dimension=0, ticker=xaxis.ticker))
plot.add_layout(Grid(dimension=1, ticker=yaxis.ticker))

curdoc().add_root(plot)

show(plot)

JSON 原型

{
  "anchor": "top_left", 
  "angle": {
    "type": "value", 
    "value": 0
  }, 
  "decorations": [], 
  "dilate": false, 
  "global_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "h": {
    "type": "value", 
    "value": null
  }, 
  "id": "p58264", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "retry_attempts": 0, 
  "retry_timeout": 0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "url": {
    "field": "url", 
    "type": "field"
  }, 
  "w": {
    "type": "value", 
    "value": null
  }, 
  "x": {
    "field": "x", 
    "type": "field"
  }, 
  "y": {
    "field": "y", 
    "type": "field"
  }
}

anchor = 'top_left'

类型:

Either(Enum(Anchor), Tuple(Either(Enum(Align), Enum(HAlign), Percent), Either(Enum(Align), Enum(VAlign), Percent)))

图像应在 x、y 坐标处对齐。

angle = 0

类型:

AngleSpec

图像旋转角度，以水平线为基准。

angle_units = 'rad'

类型:

NotSerialized(Enum(AngleUnits))

与相关属性关联的单位：deg、rad、grad 或 turn

decorations = []

类型:

列表

一组标记修饰，例如箭头。

使用 GlyphRenderer.add_decoration() 可轻松设置所有标记渲染器的标记修饰。如果需要更精细的控制，可以使用此属性。

注意

修饰仅用于辅助标记的视觉外观，但它们不会参与命中测试等操作。

dilate = False

类型:

布尔值

是否始终以使图像变大的方式对分数像素位置进行舍入。

如果像素舍入错误导致图像之间出现间隙（而它们应该紧密相邻），此设置可能很有用。

global_alpha = 1.0

类型:

NumberSpec

每个图像渲染时的整体不透明度（除了图像本身可能具有的任何固有 alpha 值）。

h = None

类型:

NullDistanceSpec

图像在数据空间中所占绘图区域的高度。

默认值为 None，在这种情况下，图像将以其实际图像大小显示（无论此处指定的单位如何）。

h_units = 'data'

类型:

NotSerialized(Enum(SpatialUnits))

与关联属性一起使用的单位：屏幕或数据

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

retry_attempts = 0

类型:

整数

从指定的 URL 重新加载图像的尝试次数。默认值为零。

retry_timeout = 0

类型:

整数

从指定的 URL 重新加载图像的尝试之间的超时（以毫秒为单位）。默认值为零毫秒。

syncable = True

类型:

布尔值

指示此模型是否应在网页浏览器中更新时同步回 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 也不会出于任何原因直接使用这些标签。

url = Field(field='url', transform=Unspecified, units=Unspecified)

类型:

字符串规范

要从中检索图像的 URL。

注意

图像的实际检索和加载是在客户端进行的。

w = None

类型:

NullDistanceSpec

图像在数据空间中占据的绘图区域的宽度。

默认值为 None，在这种情况下，图像将以其实际图像大小显示（无论此处指定的单位如何）。

w_units = 'data'

类型:

NotSerialized(Enum(SpatialUnits))

与关联属性一起使用的单位：屏幕或数据

x = Field(field='x', transform=Unspecified, units=Unspecified)

类型:

NumberSpec

用于定位图像锚点的 x 坐标。

y = Field(field='y', transform=Unspecified, units=Unspecified)

类型:

NumberSpec

用于定位图像锚点的 y 坐标。

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

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

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

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

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) – 要注册的回调函数

返回值:

无

示例

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

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

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

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

classmethod parameters() → list[Parameter]

生成适合从 Glyph 派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

选择器 (类似 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 服务器应用程序的上下文中，传入的属性更新将用执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知。会话可以将事件设置器与其自身进行比较，并抑制来自自身的任何更新。

返回值:

无

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

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

参数:

• 选择器 (类似 JSON)

• updates (dict)

返回值:

无

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

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

返回值:

无

update(**kwargs: Any) → None

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

返回值:

无

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

此模型附加到的 Document（可以为 None）