Circle#

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

Bases: RadialGlyph, LineGlyph, FillGlyph, HatchGlyph

渲染圆形标记。

示例

import numpy as np

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

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

source = ColumnDataSource(dict(x=x, y=y, radii=radii))

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

glyph = Circle(x="x", y="y", radius="radii", line_color="#3288bd", fill_color="white", 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 Prototype
{
  "decorations": [], 
  "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
  }, 
  "hit_dilation": 1.0, 
  "id": "p59504", 
  "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, 
  "radius": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "radius_dimension": "x", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "x": {
    "field": "x", 
    "type": "field"
  }, 
  "y": {
    "field": "y", 
    "type": "field"
  }
}
decorations = []#
Type:

List

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

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

注意

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

fill_alpha = 1.0#
Type:

AlphaSpec

圆的填充 alpha 值。

fill_color = 'gray'#
Type:

ColorSpec

圆的填充颜色值。

hatch_alpha = 1.0#
Type:

AlphaSpec

圆的阴影线 alpha 值。

hatch_color = 'black'#
Type:

ColorSpec

圆的阴影线颜色值。

hatch_extra = {}#
Type:

Dict(String, Instance(Texture))

圆的额外阴影线值。

hatch_pattern = None#
Type:

HatchPatternSpec

圆的阴影线图案值。

hatch_scale = 12.0#
Type:

FloatSpec

圆的阴影线比例值。

hatch_weight = 1.0#
Type:

FloatSpec

圆的阴影线粗细值。

hit_dilation = 1.0#
Type:

Size

用于扩大悬停和点击工具的命中半径的因子。 使此值更大可以使工具“更敏感”。

line_alpha = 1.0#
Type:

AlphaSpec

圆的线条 alpha 值。

line_cap = 'butt'#
Type:

LineCapSpec

圆的线帽值。

line_color = 'black'#
Type:

ColorSpec

圆的线条颜色值。

line_dash = []#
Type:

DashPatternSpec

圆的线条虚线值。

line_dash_offset = 0#
Type:

IntSpec

圆的线条虚线偏移值。

line_join = 'bevel'#
Type:

LineJoinSpec

圆的线连接值。

line_width = 1#
Type:

FloatSpec

圆的线条宽度值。

name = None#
Type:

Nullable(String)

此模型的一个任意的、用户提供的名称。

当查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

radius = Undefined#
Type:

DistanceSpec

圆的半径值（默认情况下，以数据单位表示）。

警告

请注意，即使在数据空间纵横比不是 1:1 的情况下，圆形字形也始终在屏幕上绘制为圆形。 在所有指定半径值的情况下，半径的“距离”都沿 radius_dimension 指定的维度测量。 如果纵横比非常大或非常小，则绘制的圆圈可能看起来比预期的要大或小得多。 有关更多信息，请参见 #626。

radius_dimension = 'x'#
Type:

Enum(RadiusDimension)

沿哪个维度测量圆半径。

当数据空间纵横比不是 1:1 时，绘制的圆的大小取决于用于测量半径“距离”的方向。 此属性允许控制该方向。

将此维度设置为“max”将计算 x 和 y 维度上的半径，并使用两者中的最大值，“min”选择最小值。

radius_units = 'data'#
Type:

NotSerialized(Enum(SpatialUnits))

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

syncable = True#
Type:

Bool

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。 当处理我们不需要其更新值的频繁更新的对象时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止触发此对象上的任何 on_change() 回调。 但是，任何 JS 端的回调仍然有效。

tags = []#
Type:

List

要附加到此模型的可选的、用户提供的任意值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([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)#
Type:

NumberSpec

圆的中心点的 x 坐标。

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

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 属性的名称

Return type:

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 的属性的描述符

Return type:

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#

当此 Model 上发生指定的事件时，运行回调。

并非所有 Model 都支持所有事件。 请参阅 bokeh.events 中的特定事件，以获取有关哪些 Model 能够触发它们的更多信息。

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

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

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

返回值：

具有引用的属性的名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

收集一个字典，该字典将属性名称映射到它们的值。

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

不可序列化的属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数：

include_defaults (bool, optional) – 是否包括自对象创建以来未显式设置的属性。（默认值：True）

返回值：

从属性名称到其值的映射

Return type:

字典

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）

返回值：

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

Return type:

字典

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

返回值：

None

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

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

参数：

  • selector (类 JSON)

  • updates (字典)

返回值：

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)