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 原型

{
  "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": "p58864", 
  "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)

类型:

DataSpec

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

注意

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

angle = 0

类型:

AngleSpec

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

angle_units = 'rad'

类型:

NotSerialized(Enum(AngleUnits))

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

background_fill_alpha = 1.0

类型:

AlphaSpec

文本边界框的填充 alpha 值。

background_fill_color = None

类型:

ColorSpec

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

background_hatch_alpha = 1.0

类型:

AlphaSpec

文本边界框的阴影 alpha 值。

background_hatch_color = None

类型:

ColorSpec

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

background_hatch_extra = {}

类型:

Dict(String, Instance(Texture))

文本边界框的阴影额外值。

background_hatch_pattern = None

类型:

HatchPatternSpec

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

background_hatch_scale = 12.0

类型:

NumberSpec

文本边界框的阴影缩放值。

background_hatch_weight = 1.0

类型:

NumberSpec

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

border_line_alpha = 1.0

类型:

AlphaSpec

文本边界框的线条 alpha 值。

border_line_cap = 'butt'

类型:

LineCapSpec

文本边界框的线条端帽值。

border_line_color = None

类型:

ColorSpec

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

border_line_dash = []

类型:

DashPatternSpec

文本边界框的线条虚线值。

border_line_dash_offset = 0

类型:

IntSpec

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

border_line_join = 'bevel'

类型:

线连接规范

文本边界框的线连接值。

border_line_width = 1

类型:

NumberSpec

文本边界框的线宽值。

border_radius = 0

类型:

Either(NonNegative, Tuple(NonNegative, NonNegative, NonNegative, NonNegative), Struct)

允许框具有圆角。为了获得最佳效果，应将其与padding结合使用。

注意

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

decorations = []

类型:

列表

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

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

注意

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

display = 'auto'

类型:

Either(Enum(Enumeration(inline, block, auto)))

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

允许以下值

• "auto"（默认值）文本将被解析，需要TeX分隔符来包含数学内容，例如"$$x^2$$"或r"\[\frac{x}{y}\]"。这允许混合数学文本和常规文本内容。TeX显示模式由解析器推断。

• "block"文本按字面原样获取，并使用TeX的块模式。

• "inline"文本按字面原样获取，并使用TeX的行内模式。

macros = {}

类型:

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

用户定义的TeX宏。

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

示例

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

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'

类型:

DataSpec

指定文本框轮廓的形状。

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

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

注意

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

注意

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

padding = 0

类型:

Either(NonNegative, Tuple(NonNegative, NonNegative), Struct, Tuple(NonNegative, NonNegative, NonNegative, NonNegative), Struct)

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

注意

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

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

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

类型:

字符串规范

要渲染的文本值。

text_align = 'left'

类型:

文本对齐规范

文本的文本对齐值。

text_alpha = 1.0

类型:

AlphaSpec

文本的 alpha 值。

text_baseline = 'bottom'

类型:

TextBaselineSpec

文本的基线值。

text_color = '#444444'

类型:

ColorSpec

文本的颜色值。

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

类型:

字符串规范

文本的字体值。

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

类型:

FontSizeSpec

文本的字体大小值。

text_font_style = 'normal'

类型:

FontStyleSpec

文本的字体样式值。

text_line_height = 1.2

类型:

NumberSpec

文本的行高值。

text_outline_color = None

类型:

ColorSpec

文本轮廓的颜色值。

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

类型:

NumberSpec

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

x_offset = 0

类型:

NumberSpec

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

例如，如果希望将文本从给定数据位置偏移固定距离（以屏幕单位计），这将非常有用。

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

类型:

NumberSpec

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

y_offset = 0

类型:

NumberSpec

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

例如，如果希望将文本从给定数据位置偏移固定距离（以屏幕单位计），这将非常有用。

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

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

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

参数：

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

返回值：

无

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

返回值：

无

示例

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, 可选) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）

返回值：

属性名称到其值的映射

返回类型：

字典

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

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

参数：

• query (可调用对象) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含用户未显式设置的属性（默认值：True）

返回值：

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

返回类型：

字典

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中删除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类似 JSON)

返回值：

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) : 要设置的属性的名称

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

• models (字典 或 None, 可选) –

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

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

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

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

返回值：

无

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

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

参数：

• selector (类似 JSON)

• updates (字典)

返回值：

无

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

移除所有主题值并恢复默认值。

返回值：

无

update(**kwargs: Any) → 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）