HArea

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

基类：LineGlyph, FillGlyph, HatchGlyph

在两个相同长度、具有相同 y 坐标的 x 坐标序列之间渲染水平方向的区域。

示例

import numpy as np

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

N = 30
y = np.linspace(-2, 3, N)
x1 = np.zeros(N)
x2 = 10 - y**2

source = ColumnDataSource(dict(x1=x1, x2=x2, y=y))

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

glyph = HArea(x1="x1", x2="x2", y="y", fill_color="#f46d43")
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 原型

{
  "decorations": [], 
  "fill_alpha": 1.0, 
  "fill_color": "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
  }, 
  "id": "p57903", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "x1": {
    "field": "x1", 
    "type": "field"
  }, 
  "x2": {
    "field": "x2", 
    "type": "field"
  }, 
  "y": {
    "field": "y", 
    "type": "field"
  }
}

decorations = []

类型:

列表

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

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

注意

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

fill_alpha = 1.0

类型:

Alpha

水平方向区域的填充 alpha 值。

fill_color = 'gray'

类型:

Nullable(Color)

水平方向区域的填充颜色值。

hatch_alpha = 1.0

类型:

AlphaSpec

水平方向区域的阴影 alpha 值。

hatch_color = 'black'

类型:

ColorSpec

水平方向区域的阴影颜色值。

hatch_extra = {}

类型:

Dict(String, Instance(Texture))

水平方向区域的阴影额外值。

hatch_pattern = None

类型:

HatchPatternSpec

水平方向区域的阴影图案值。

hatch_scale = 12.0

类型:

NumberSpec

水平方向区域的阴影比例值。

hatch_weight = 1.0

类型:

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

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

类型:

NumberSpec

区域一侧点的 x 坐标。

x2 = Field(field='x2', 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 模型属性更改值时更新一个 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]

生成适合从图形派生的函数的 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]

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

参数:

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

返回值:

无

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

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

参数:

• selector (JSON-like)

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