TeXGlyph#
- class TeXGlyph(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
基类:
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": "p60846", "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)#
- 类型:
此字形边框框内的位置，
x和y坐标将锚定到该位置。这可以是命名的锚点，例如top_left或center，或者是从左到右和从上到下的百分比，或者是这些的组合，在宽度和高度上独立。如果设置为auto，则锚点将根据文本align和baseline确定。注意
此属性是实验性的，随时可能更改。
- angle_units = 'rad'#
- 类型:
用于关联属性的单位：度 (deg)、弧度 (rad)、梯度 (grad) 或圈数 (turn)
- background_hatch_pattern = None#
- 类型:
HatchPatternSpec
文本边框框的阴影线图案值。
- border_line_cap = 'butt'#
- 类型:
LineCapSpec
文本边框框的线帽值。
- border_line_dash = []#
- 类型:
DashPatternSpec
文本边框框的线条虚线值。
- border_line_dash_offset = 0#
- 类型:
IntSpec
文本边框框的线条虚线偏移值。
- border_line_join = 'bevel'#
- 类型:
LineJoinSpec
文本边框框的线条连接值。
- border_radius = 0#
- 类型:
Either(NonNegative,Tuple(NonNegative,NonNegative,NonNegative,NonNegative),Struct)
允许框具有圆角。为了获得最佳效果，应与
padding结合使用。注意
此属性是实验性的，随时可能更改。
- decorations = []#
- 类型:
字形装饰的集合，例如箭头头部。
使用
GlyphRenderer.add_decoration()可以轻松设置字形渲染器的所有字形。当需要更精细的控制时，请使用此属性。注意
装饰仅用于辅助字形的视觉外观，但不参与点击测试等。
- display = 'auto'#
- 类型:
Enum(Enumeration(inline, block, auto))
定义如何解释文本以及使用哪种 TeX 显示模式。
允许以下值
"auto"（默认）文本被解析，需要 TeX 分隔符来包围数学内容，例如"$$x^2$$"或r"\[\frac{x}{y}\]"。这允许混合数学文本和常规文本内容。TeX 显示模式由解析器推断。"block"文本被逐字采用，并使用 TeX 的块模式。"inline"文本被逐字采用，并使用 TeX 的行内模式。
- macros = {}#
-
用户定义的 TeX 宏。
这是一个从控制序列名称（不带前导反斜杠）到替换字符串或替换字符串和参数数量的元组的映射。
示例
TeX(text=r"\R \rightarrow \R^2", macros={"RR": r"{\bf R}"})
- name = None#
-
此模型的可选的、用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。
>>> plot.scatter([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#
- 类型:
指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。在处理不需要更新值的频繁更新对象时，设置为
False可能有助于减少网络流量。注意
将此属性设置为
False将阻止此对象上的任何on_change()回调触发。但是，任何 JS 端回调仍将有效。
- tags = []#
- 类型:
要附加到此模型的可选的、用户提供的任意值列表。
当查询文档以检索特定的 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 也不会出于任何原因直接使用这些标签。
- text = Field(field='text', transform=Unspecified, units=Unspecified)#
- 类型:
要渲染的文本值。
- text_align = 'left'#
- 类型:
TextAlignSpec
文本的文本对齐值。
- text_baseline = 'bottom'#
- 类型:
TextBaselineSpec
文本的文本基线值。
- text_font = Value(value='helvetica', transform=Unspecified, units=Unspecified)#
- 类型:
文本的文本字体值。
- text_font_size = Value(value='16px', transform=Unspecified, units=Unspecified)#
- 类型:
文本的文本字体大小值。
- text_font_style = 'normal'#
- 类型:
FontStyleSpec
文本的文本字体样式值。
- text_line_height = 1.2#
- 类型:
文本的文本行高值。
- x = Field(field='x', transform=Unspecified, units=Unspecified)#
- 类型:
用于定位文本锚点的 x 坐标。
- y = Field(field='y', transform=Unspecified, units=Unspecified)#
- 类型:
用于定位文本锚点的 y 坐标。
- apply_theme(property_values: dict[str, Any]) None#
应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。
传入的字典可以保持原样并与其他实例共享以节省内存（因此调用者和
HasProps实例都不应修改它）。- 参数:
property_values (dict) – 代替默认值使用的主题值
- 返回值:
None
- classmethod clear_extensions() None#
清除所有当前已定义的自定义扩展。
序列化调用将导致任何当前已定义的自定义扩展被包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[PropertyDescriptor[Any]]#
按定义顺序列出的属性描述符列表。
- 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 模型属性的值更改时更新另一个属性。- 参数:
在版本 1.1 中添加
- Raises:
示例
使用
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的属性的描述符- 返回类型:
- 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 properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#
收集此类上属性的名称。
警告
在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使当前对此方法的使用具有前瞻性，请将返回值包装在
list中。- 返回值:
属性名称
- classmethod properties_with_refs() dict[str, Property[Any]]#
收集此类上所有也具有引用的属性的名称。
此方法始终遍历类层次结构，并包含在任何父类上定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#
收集将属性名称映射到其值的字典。
此方法始终遍历类层次结构，并包含在任何父类上定义的属性。
不可序列化的属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损地重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#
使用谓词查询
HasProps实例的属性值。
- select(selector: SelectorType) Iterable[Model]#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回值:
seq[Model]
- select_one(selector: SelectorType) Model | None#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: JSON-like
- 返回值:
Model
- 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-like)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None#
获取任何主题提供的覆盖。
结果作为从属性名称到值的字典返回，如果没有主题覆盖此实例的任何值，则返回
None。- 返回值:
dict 或 None
- to_serializable(serializer: Serializer) ObjectRefRep#
将此对象转换为可序列化的表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#