图像#

class Image(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基类: ImageBase

使用颜色映射器渲染作为标量数据给出的图像。

除了定义的模型属性外，Image还可以接受一个关键字参数palette来代替显式的color_mapper。该值应为颜色列表，或bokeh.palettes中内置调色板之一的名称。此调色板将用于自动构建Image属性的ColorMapper模型。

如果同时传递了palette和color_mapper，则将引发ValueError异常。如果两者都没有传递，则将使用Greys9调色板作为默认值。

JSON原型
{
  "anchor": "bottom_left", 
  "color_mapper": {
    "attributes": {
      "palette": [
        "#000000", 
        "#252525", 
        "#525252", 
        "#737373", 
        "#969696", 
        "#bdbdbd", 
        "#d9d9d9", 
        "#f0f0f0", 
        "#ffffff"
      ]
    }, 
    "id": "p58180", 
    "name": "LinearColorMapper", 
    "type": "object"
  }, 
  "decorations": [], 
  "dh": {
    "field": "dh", 
    "type": "field"
  }, 
  "dilate": false, 
  "dw": {
    "field": "dw", 
    "type": "field"
  }, 
  "global_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "id": "p58179", 
  "image": {
    "field": "image", 
    "type": "field"
  }, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "origin": "bottom_left", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "x": {
    "field": "x", 
    "type": "field"
  }, 
  "y": {
    "field": "y", 
    "type": "field"
  }
}
anchor = 'bottom_left'#
类型:

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

图像的位置应锚定在x、y坐标处。

color_mapper = LinearColorMapper(id='p58188', ...)#
类型:

Instance(ColorMapper)

一个ColorMapper，用于将image中的标量数据映射到用于显示的RGBA值。

也可以设置来自bokeh.palettes调色板的名称，在这种情况下，将使用配置了命名调色板的LinearColorMapper。

注意

颜色映射步骤在客户端进行。

decorations = []#
类型:

列表

图形装饰的集合，例如箭头。

使用GlyphRenderer.add_decoration()可以轻松设置图形渲染器所有图形的装饰。当需要更精细的控制时，使用此属性。

注意

装饰仅用于辅助图形的视觉外观，但它们不参与命中测试等。

dh = Field(field='dh', transform=Unspecified, units=Unspecified)#
类型:

距离规范

图像将占据的绘图区域的高度。

注意

这不是图像的高度像素数。该数字由图像本身固定。

dh_units = 'data'#
类型:

NotSerialized(Enum(SpatialUnits))

要用于关联属性的单位：屏幕或数据

dilate = False#
类型:

布尔值

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

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

dw = Field(field='dw', transform=Unspecified, units=Unspecified)#
类型:

距离规范

图像将占据的绘图区域的宽度。

注意

这不是图像的宽度像素数。该数字由图像本身固定。

dw_units = 'data'#
类型:

NotSerialized(Enum(SpatialUnits))

要用于关联属性的单位：屏幕或数据

global_alpha = 1.0#
类型:

Alpha规范

图像的全局 alpha 值。

image = Field(field='image', transform=Unspecified, units=Unspecified)#
类型:

数字规范

要进行颜色映射的图像的标量数据数组。

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

origin = 'bottom_left'#
类型:

Enum(ImageOrigin)

定义图像的坐标空间。

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

x = Field(field='x', transform=Unspecified, units=Unspecified)#
类型:

数字规范

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

y = Field(field='y', transform=Unspecified, units=Unspecified)#
类型:

数字规范

用于定位图像锚点的 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属性的名称

返回类型：

集合[字符串]

classmethod descriptors() → 列表[PropertyDescriptor[Any]]#

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

destroy() → None#

清理对文档和属性的引用。

equals(other: HasProps) → 布尔值#

模型的结构相等性。

参数：

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

返回值：

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

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

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

参数：

  • attr (字符串) – 此模型上 Bokeh 属性的名称

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

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

  • attr_selector (整数 | 字符串) – 链接可订阅 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: 字符串, *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: 字符串, *, raises: 布尔值 = True) → PropertyDescriptor[Any] | None#

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

参数：

  • name (字符串) – 要搜索的属性的名称

  • raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值：

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

on_change(attr: 字符串, *callbacks: PropertyCallback) → None#

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

参数：

  • attr (字符串) – 此对象上的属性名称

  • *callbacks (可调用对象) – 要注册的回调函数

返回值：

无

示例

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

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

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

返回值：

具有引用的属性的名称

返回类型：

集合[字符串]

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

返回值：

无

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

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

参数：

  • selector (类 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）