文本#

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

基础类: XYGlyph, TextGlyph

渲染文本。

示例

import numpy as np

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

N = 9
x = np.linspace(-2, 2, N)
y = x**2
a = "abcdefghijklmnopqrstuvwxyz"
text = [a[i*3:i*3+3] for i in range(N)]

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

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

glyph = Text(x="x", y="y", text="text", angle=0.3, text_color="#96deb3")
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)

anchor = Value(value='auto', transform=Unspecified, units=Unspecified)#

类型:: 数据规范

此图形边界框内的位置，x 和 y 坐标将锚定到该位置。这可以是一个命名的锚点，例如 top_left 或 center，或者一个从左到右和从上到下的百分比，或者它们的组合，在宽度和高度上独立地。如果设置为 auto，则锚点将从文本 align 和 baseline 中确定。

注意

此属性是实验性的，可能随时更改。

angle = 0#

类型:: 角度规范

文本旋转的角度，以水平方向为基准测量。

angle_units = 'rad'#

类型:: NotSerialized(Enum(AngleUnits))

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

background_fill_alpha = 1.0#

类型:: Alpha 规范

文本边界框的填充 alpha 值。

background_fill_color = None#

类型:: 颜色规范

文本边界框的填充颜色值。

background_hatch_alpha = 1.0#

类型:: Alpha 规范

文本边界框的阴影 alpha 值。

background_hatch_color = None#

类型:: 颜色规范

文本边界框的阴影颜色值。

background_hatch_extra = {}#

类型:: Dict(String, Instance(Texture))

文本边界框的阴影附加值。

background_hatch_pattern = None#

类型:: 阴影图案规范

文本边界框的阴影图案值。

background_hatch_scale = 12.0#

类型:: 数字规范

文本边界框的阴影比例值。

background_hatch_weight = 1.0#

类型:: 数字规范

文本边界框的阴影权重值。

border_line_alpha = 1.0#

类型:: Alpha 规范

文本边界框的线条 alpha 值。

border_line_cap = 'butt'#

类型:: 线帽规范

文本边界框的线帽值。

border_line_color = None#

类型:: 颜色规范

文本边界框的线条颜色值。

border_line_dash = []#

类型:: DashPatternSpec

文本边框线的虚线值。

border_line_dash_offset = 0#

类型:: IntSpec

文本边框线的虚线偏移值。

border_line_join = 'bevel'#

类型:: LineJoinSpec

文本边框线的连接值。

border_line_width = 1#

类型:: 数字规范

文本边框线的宽度值。

border_radius = 0#

类型:: Either(NonNegative, Tuple(NonNegative, NonNegative, NonNegative, NonNegative), Struct)

允许文本框具有圆角。为了获得最佳效果，应与 padding 配合使用。

注意

此属性是实验性的，可能随时更改。

decorations = []#

类型:: List

一系列图形装饰，例如箭头。

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

注意

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

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

outline_shape = 'box'#

类型:: 数据规范

指定文本框轮廓的形状。

文本框的默认轮廓是其边界框（或矩形）。这可以更改为一系列预定义的形状，如圆形、椭圆形、菱形、平行四边形等。这些形状在边界框上被外接圆，以便框的内容适合这些形状内。

此属性仅在设置边框线、背景填充和/或背景阴影属性时有效。用户可以选择 "none" 以避免绘制任何形状，即使设置了边框或背景视觉效果。

注意

此属性是实验性的，可能随时更改。

注意

目前，命中测试仅使用图形文本内容的边界框，这等同于使用框/矩形形状。

padding = 0#

类型:: Either(NonNegative, Tuple(NonNegative, NonNegative), Struct, Tuple(NonNegative, NonNegative, NonNegative, NonNegative), Struct)

图形文本与其边界框（边框）之间的额外空间。

注意

此属性是实验性的，可能随时更改。

syncable = True#

类型:: Bool

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 侧回调仍然会起作用。

tags = []#

类型:: List

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

此数据在查询文档以检索特定 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 也不会出于任何原因直接使用标签。

text = Field(field='text', transform=Unspecified, units=Unspecified)#

类型:: StringSpec

要呈现的文本值。

text_align = 'left'#

类型:: TextAlignSpec

文本的文本对齐值。

text_alpha = 1.0#

类型:: Alpha 规范

文本的文本 alpha 值。

text_baseline = 'bottom'#

类型:: TextBaselineSpec

文本的文本基线值。

text_color = '#444444'#

类型:: 颜色规范

文本的文本颜色值。

text_font = Value(value='helvetica', transform=Unspecified, units=Unspecified)#

类型:: StringSpec

文本的文本字体值。

text_font_size = Value(value='16px', transform=Unspecified, units=Unspecified)#

类型:: FontSizeSpec

文本的文本字体大小值。

text_font_style = 'normal'#

类型:: FontStyleSpec

文本的文本字体样式值。

text_line_height = 1.2#

类型:: 数字规范

文本的文本行高值。

text_outline_color = None#

类型:: 颜色规范

文本轮廓的颜色值。

x = Field(field='x', transform=Unspecified, units=Unspecified)#

类型:: 数字规范

用于定位文本锚点的 x 坐标。

x_offset = 0#

类型:: 数字规范

应用于 x 坐标的像素偏移值。

这很有用，例如，如果希望将文本以屏幕单位为单位从给定数据位置浮动固定距离。

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

类型:: 数字规范

用于定位文本锚点的 y 坐标。

y_offset = 0#

类型:: 数字规范

应用于 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 模型属性，无论何时另一个更改值。

参数:

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)
返回:: 从属性名称到其值的映射
返回类型:: 字典

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)
更新 (字典)

返回:

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）