Rect#

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

基类: XYGlyph, LineGlyph, FillGlyph, HatchGlyph

渲染矩形，以中心位置（x 和 y）、宽度、高度和旋转角度为特征。

警告

Rect 图形在对数刻度上没有明确定义。请改用 Block 或 Quad 图形。

示例

import numpy as np

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

N = 9
x = np.linspace(-2, 2, N)
y = x**2
w = x/15.0 + 0.3
h = y/20.0 + 0.3

source = ColumnDataSource(dict(x=x, y=y, w=w, h=h))

plot = Plot(
    title=None, width=300, height=300,
    min_border=0, toolbar_location=None)

glyph = Rect(x="x", y="y", width="w", height="h", angle=-0.7, fill_color="#cab2d6")
plot.add_glyph(source, glyph)

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 原型
{
  "angle": {
    "type": "value", 
    "value": 0.0
  }, 
  "border_radius": 0, 
  "decorations": [], 
  "dilate": false, 
  "fill_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "fill_color": {
    "type": "value", 
    "value": "gray"
  }, 
  "hatch_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "hatch_color": {
    "type": "value", 
    "value": "black"
  }, 
  "hatch_extra": {
    "type": "map"
  }, 
  "hatch_pattern": {
    "type": "value", 
    "value": null
  }, 
  "hatch_scale": {
    "type": "value", 
    "value": 12.0
  }, 
  "hatch_weight": {
    "type": "value", 
    "value": 1.0
  }, 
  "height": {
    "field": "height", 
    "type": "field"
  }, 
  "id": "p58884", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "line_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "line_cap": {
    "type": "value", 
    "value": "butt"
  }, 
  "line_color": {
    "type": "value", 
    "value": "black"
  }, 
  "line_dash": {
    "type": "value", 
    "value": []
  }, 
  "line_dash_offset": {
    "type": "value", 
    "value": 0
  }, 
  "line_join": {
    "type": "value", 
    "value": "bevel"
  }, 
  "line_width": {
    "type": "value", 
    "value": 1
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "width": {
    "field": "width", 
    "type": "field"
  }, 
  "x": {
    "field": "x", 
    "type": "field"
  }, 
  "y": {
    "field": "y", 
    "type": "field"
  }
}
angle = 0.0#
类型:

AngleSpec

要旋转矩形的角度，以水平方向测量。

angle_units = 'rad'#
类型:

NotSerialized(Enum(AngleUnits))

用于关联属性的单位：deg、rad、grad 或 turn

border_radius = 0#
类型:

Either(NonNegative, Tuple(NonNegative, NonNegative, NonNegative, NonNegative), Struct)

允许框具有圆角。

注意

此属性是实验性的，随时可能更改。

decorations = []#
类型:

列表

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

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

注意

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

dilate = False#
类型:

布尔值

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

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

fill_alpha = 1.0#
类型:

AlphaSpec

矩形的填充透明度值。

fill_color = 'gray'#
类型:

ColorSpec

矩形的填充颜色值。

hatch_alpha = 1.0#
类型:

AlphaSpec

矩形的阴影透明度值。

hatch_color = 'black'#
类型:

ColorSpec

矩形的阴影颜色值。

hatch_extra = {}#
类型:

Dict(String, Instance(Texture))

矩形的阴影额外值。

hatch_pattern = None#
类型:

HatchPatternSpec

矩形的阴影图案值。

hatch_scale = 12.0#
类型:

NumberSpec

矩形的阴影缩放值。

hatch_weight = 1.0#
类型:

NumberSpec

矩形的阴影粗细值。

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

DistanceSpec

矩形的整体高度。

height_units = 'data'#
类型:

NotSerialized(Enum(SpatialUnits))

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

line_alpha = 1.0#
类型:

AlphaSpec

矩形线条的透明度值。

line_cap = 'butt'#
类型:

LineCapSpec

矩形线条端点的样式值。

line_color = 'black'#
类型:

ColorSpec

矩形线条的颜色值。

line_dash = []#
类型:

DashPatternSpec

矩形线条虚线样式值。

line_dash_offset = 0#
类型:

IntSpec

矩形线条虚线偏移值。

line_join = 'bevel'#
类型:

LineJoinSpec

矩形线条连接点的样式值。

line_width = 1#
类型:

NumberSpec

矩形线条的宽度值。

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

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

DistanceSpec

矩形的整体宽度。

width_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) – 要代替默认值使用的主题值

返回值：

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

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

生成适合派生自 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 的数据

返回值：

模型

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

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

参数：

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

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

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

    这用于防止 Bokeh 应用程序的“回弹”更新。

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

返回值：

None

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

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

参数：

  • selector (类似 JSON 的数据)

  • updates (dict)

返回值：

None

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

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

结果以属性名称到值的字典形式返回，如果主题未覆盖此实例的任何值，则返回 None。

返回值：

字典或 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）