TeXGlyph#

class TeXGlyph(*args: Any, id: ID | None = None, **kwargs: Any)[源代码]#

基础类：MathTextGlyph

使用LaTeX符号渲染数学内容。

请参阅数学符号在用户指南中了解更多信息。

注意

Bokeh 使用 MathJax 来渲染包含数学符号的文本。

MathJax 仅支持数学模式的宏（不支持文本模式的宏）。您可以在这里查看更多关于标准 TeX/LaTeX 和 MathJax 之间差异的信息：https://docs.mathjax.org/en/latest/input/tex/differences.html

JSON Prototype

{
  "anchor": {
    "type": "value", 
    "value": "auto"
  }, 
  "angle": {
    "type": "value", 
    "value": 0
  }, 
  "background_fill_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "background_fill_color": {
    "type": "value", 
    "value": null
  }, 
  "background_hatch_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "background_hatch_color": {
    "type": "value", 
    "value": null
  }, 
  "background_hatch_extra": {
    "type": "map"
  }, 
  "background_hatch_pattern": {
    "type": "value", 
    "value": null
  }, 
  "background_hatch_scale": {
    "type": "value", 
    "value": 12.0
  }, 
  "background_hatch_weight": {
    "type": "value", 
    "value": 1.0
  }, 
  "border_line_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "border_line_cap": {
    "type": "value", 
    "value": "butt"
  }, 
  "border_line_color": {
    "type": "value", 
    "value": null
  }, 
  "border_line_dash": {
    "type": "value", 
    "value": []
  }, 
  "border_line_dash_offset": {
    "type": "value", 
    "value": 0
  }, 
  "border_line_join": {
    "type": "value", 
    "value": "bevel"
  }, 
  "border_line_width": {
    "type": "value", 
    "value": 1
  }, 
  "border_radius": 0, 
  "decorations": [], 
  "display": "auto", 
  "id": "p59135", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "macros": {
    "type": "map"
  }, 
  "name": null, 
  "outline_shape": {
    "type": "value", 
    "value": "box"
  }, 
  "padding": 0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text": {
    "field": "text", 
    "type": "field"
  }, 
  "text_align": {
    "type": "value", 
    "value": "left"
  }, 
  "text_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "text_baseline": {
    "type": "value", 
    "value": "bottom"
  }, 
  "text_color": {
    "type": "value", 
    "value": "#444444"
  }, 
  "text_font": {
    "type": "value", 
    "value": "helvetica"
  }, 
  "text_font_size": {
    "type": "value", 
    "value": "16px"
  }, 
  "text_font_style": {
    "type": "value", 
    "value": "normal"
  }, 
  "text_line_height": {
    "type": "value", 
    "value": 1.2
  }, 
  "text_outline_color": {
    "type": "value", 
    "value": null
  }, 
  "x": {
    "field": "x", 
    "type": "field"
  }, 
  "x_offset": {
    "type": "value", 
    "value": 0
  }, 
  "y": {
    "field": "y", 
    "type": "field"
  }, 
  "y_offset": {
    "type": "value", 
    "value": 0
  }
}

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

Type:: DataSpec

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

注意

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

angle = 0#

Type:: AngleSpec

文本旋转的角度，从水平方向测量。

angle_units = 'rad'#

Type:: NotSerialized(Enum(AngleUnits))

用于关联属性的单位：度、弧度、梯度或圈

background_fill_alpha = 1.0#

Type:: AlphaSpec

文本边界框的填充透明度值。

background_fill_color = None#

Type:: ColorSpec

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

background_hatch_alpha = 1.0#

Type:: AlphaSpec

文本边界框的填充透明度值。

background_hatch_color = None#

Type:: ColorSpec

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

background_hatch_extra = {}#

Type:: Dict(String, Instance(Texture))

文本边界框的额外填充值。

background_hatch_pattern = None#

Type:: HatchPatternSpec

文本边界框的填充图案值。

background_hatch_scale = 12.0#

Type:: NumberSpec

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

background_hatch_weight = 1.0#

Type:: NumberSpec

文本边界框的填充权重值。

border_line_alpha = 1.0#

Type:: AlphaSpec

文本边界框的线条透明度值。

border_line_cap = 'butt'#

Type:: LineCapSpec

文本边界框的线帽值。

border_line_color = None#

Type:: ColorSpec

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

border_line_dash = []#

Type:: DashPatternSpec

文本边界框的虚线值。

border_line_dash_offset = 0#

Type:: IntSpec

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

border_line_join = 'bevel'#

Type:: LineJoinSpec

文本边界框的线条连接值。

border_line_width = 1#

Type:: NumberSpec

文本边界框的线条宽度值。

border_radius = 0#

Type:: Either(NonNegative, Tuple(NonNegative, NonNegative, NonNegative, NonNegative), Struct)

允许盒子具有圆角。为了达到最佳效果，应与 padding 结合使用。

注意

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

decorations = []#

Type:: List

一组字形装饰，例如箭头头部。

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

注意

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

display = 'auto'#

Type:: Either(Enum(枚举(inline, block, auto)))

定义文本如何解释以及使用哪种TeX显示模式。

允许以下值：

"auto"（默认值）文本被解析，要求使用TeX分隔符来包围数学内容，例如 "$$x^2$$" 或 r"\[\frac{x}{y}\]"。这允许混合数学文本和常规文本内容。TeX显示模式由解析器推断。
"block" 文本被逐字采用，并使用TeX的块模式。
"inline" 文本被逐字采用，并使用TeX的内联模式。

macros = {}#

Type:: Dict(String, Either(String, Tuple(String, Int)))

用户定义的TeX宏。

这是从控制序列名称（不带前导反斜杠）到替换字符串或替换字符串和参数数量的元组的映射。

示例：

TeX(text=r"\R \rightarrow \R^2", macros={"RR": r"{\bf R}"})

name = None#

Type:: 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'#

Type:: DataSpec

指定文本框轮廓的形状。

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

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

注意

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

注意

目前，点击测试仅使用字形文本内容的边界框，这相当于使用盒子/矩形形状。

padding = 0#

Type:: Either(NonNegative, Tuple(NonNegative, NonNegative), Struct, Tuple(NonNegative, NonNegative, NonNegative, NonNegative), Struct)

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

注意

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

syncable = True#

Type:: Bool

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

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []#

Type:: 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)#

Type:: StringSpec

要渲染的文本值。

text_align = 'left'#

Type:: TextAlignSpec

文本的对齐值。

text_alpha = 1.0#

Type:: AlphaSpec

文本的alpha值。

text_baseline = 'bottom'#

Type:: TextBaselineSpec

文本的基线值。

text_color = '#444444'#

Type:: ColorSpec

文本的颜色值。

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

Type:: StringSpec

文本的字体值。

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

Type:: FontSizeSpec

文本的字体大小值。

text_font_style = 'normal'#

Type:: FontStyleSpec

文本的字体样式值。

text_line_height = 1.2#

Type:: NumberSpec

文本的行高值。

text_outline_color = None#

Type:: ColorSpec

文本的轮廓颜色值。

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

Type:: NumberSpec

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

x_offset = 0#

Type:: NumberSpec

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

这很有用，例如，如果希望将文本“浮动”到与给定数据位置固定的屏幕单位距离。

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

Type:: NumberSpec

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

y_offset = 0#

Type:: NumberSpec

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

这很有用，例如，如果希望将文本“浮动”到与给定数据位置固定距离的屏幕单位。

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

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

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:: property_values (dict) – 用于替换默认值的主题值
Returns:: 无

classmethod clear_extensions() → None#

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self#

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]#

收集此类上所有DataSpec属性的名称。

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

Returns:: DataSpec 属性的名称
Return type:: set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]#: 属性描述符的列表，按定义的顺序排列。

destroy() → None#: 清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构相等性。

Parameters:: 其他 (HasProps) – 要比较的其他实例
Returns:: 如果属性在结构上相等，则为True，否则为False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None#

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

attr (str) – 此模型上的Bokeh属性的名称
其他 (Model) – 一个要链接到 self.attr 的 Bokeh 模型
other_attr (str) – 要链接在一起的other上的属性
attr_selector (int | str) – 用于链接可下标对象 attr 中项目的索引

在版本1.1中添加

Raises:: 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，给定属性名称。

Parameters:

name (str) – 要搜索的属性的名称
raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None#

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

attr (str) – 此对象上的一个属性名称
*callbacks (callable) – 要注册的回调函数

Returns:

无

示例

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值。

Returns:: 列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]#

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:: 属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]#

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

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

Returns:: 具有引用的属性名称
Return type:: set[str]

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

收集一个将属性名称映射到其值的字典。

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

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

Parameters:: include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）
Returns:: 从属性名称到其值的映射
Return type:: dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]#

使用谓词查询HasProps实例的属性值。

Parameters:

query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False
include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]#: 返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#: 从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]#

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:: selector (类似JSON的)
Returns:: 序列[模型]

select_one(selector: SelectorType) → Model | None#

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:: 模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None#

从JSON设置此对象的属性值。

Parameters:

name (str) – 要设置的属性名称
value (JSON-value) – 要设置给属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对Bokeh应用程序的“回旋镖”更新。

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

Returns:

无

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

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

Parameters:

selector (类似JSON的)
更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None#

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:: 字典或无

to_serializable(serializer: Serializer) → ObjectRefRep#: 将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#

unapply_theme() → None#

移除任何主题值并恢复默认设置。

Returns:: 无

update(**kwargs: Any) → None#

从给定的关键字参数更新对象的属性。

Returns:: 无

示例

以下是等价的：

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）