标记#

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

基类：XYGlyph，LineGlyph，FillGlyph，HatchGlyph

用于具有线和填充属性的简单标记符号的基类，这些标记位于 (x, y) 位置，并具有指定的尺寸。

注意

为简单起见，所有标记都声明了线和填充属性，但某些标记类型（asterisk、cross、x）仅绘制线。对于这些标记，填充值将被忽略。

注意

这是一个用于帮助组织 Bokeh 模型类型层次结构的抽象基类。 **它本身不适合实例化。**

angle = 0.0#

类型:: AngleSpec

用于旋转标记的角度。

angle_units = 'rad'#

类型:: NotSerialized(Enum(AngleUnits))

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

decorations = []#

类型:: 列表

一个符号装饰的集合，例如箭头。

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

注意

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

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

标记的阴影线权重值。

hit_dilation = 1.0#

类型:: 尺寸

用于扩大点击半径的系数，点击半径用于定义标记对 Hover 和 Tap 工具的交互响应范围。

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

size = 4#

类型:: SizeSpec

标记在屏幕空间单位中的尺寸（直径）值。

syncable = True#

类型:: Bool

指示此模型是否应该在 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 也不会出于任何原因直接使用这些标签。

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

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) – 要注册的回调函数

返回:

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

返回:: 模型

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。

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