线段#

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

Bases: LineGlyph

渲染线段。

示例

import numpy as np

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

N = 9
x = np.linspace(-2, 2, N)
y = x**2

source = ColumnDataSource(dict(
        x=x,
        y=y,
        xm01=x-x**3/10 + 0.3,
        ym01=y-x**2/10 + 0.5,
    ),
)

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

glyph = Segment(x0="x", y0="y", x1="xm01", y1="ym01", line_color="#f4a582", line_width=3)
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": [], 
  "id": "p58769", 
  "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": [], 
  "x0": {
    "field": "x0", 
    "type": "field"
  }, 
  "x1": {
    "field": "x1", 
    "type": "field"
  }, 
  "y0": {
    "field": "y0", 
    "type": "field"
  }, 
  "y1": {
    "field": "y1", 
    "type": "field"
  }
}
decorations = []#
类型:

列表

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

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

注意

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

line_alpha = 1.0#
类型:

AlphaSpec

线段的线 alpha 值。

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

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

NumberSpec

起始点的 x 坐标。

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

NumberSpec

结束点的 x 坐标。

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

NumberSpec

起始点的 y 坐标。

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

NumberSpec

结束点的 y 坐标。

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

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

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

参数:

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

返回值:

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

生成适合从图形派生的函数的 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) : 要设置的属性名称

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

  • models (dict or None, optional) –

    模型 ID 到模型的映射（默认值：None）

    这在要更新的属性也具有具有引用的值的情况下是必需的。

  • 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)
属性 document: Document | None#

该模型所附加的 Document（可以是 None）

本页内容