HAreaStep#

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

基类：FillGlyph，HatchGlyph

使用阶梯线渲染两个等长序列的x坐标之间的水平区域，这两个序列具有相同的y坐标。

示例

import numpy as np

from bokeh.io import curdoc, show
from bokeh.models import ColumnDataSource, Grid, HAreaStep, 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 = HAreaStep(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": "p57946", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "step_mode": "before", 
  "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() 可以轻松设置 glyph 渲染器的所有图形。当需要更细致的控制时，请使用此属性。

注意

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

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

step_mode = 'before'#
类型：:

Enum(StepMode)

阶梯“级别”相对于 x 和 y 坐标的位置。该参数可以取三个值之一

  • before: (默认) 在每个 y 坐标之前绘制阶梯级别 (第一个点之前没有阶梯)

  • after: 在每个 y 坐标之后绘制阶梯级别 (最后一个点之后没有阶梯)

  • center: 在每个 y 坐标的中心绘制阶梯级别

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

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) – 要用作默认值的主题值

返回值：

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 模型属性更改值时更新一个 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, optional) – 是否包含自对象创建以来未显式设置的属性。 (默认值: True)

返回值：

属性名称到其值的映射

返回值类型：

字典

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)

返回值：

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

返回值类型：

字典

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

返回值：

None

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

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

参数：

  • selector (JSON-like)

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