坐标轴#

可以添加到 Bokeh 图形中的各种坐标轴的引导渲染器

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

基类: GuideRenderer

一个基类,用于定义所有坐标轴类型的通用属性。

注意

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

JSON 原型
{
  "axis_label": null, 
  "axis_label_align": "center", 
  "axis_label_orientation": "parallel", 
  "axis_label_standoff": 5, 
  "axis_label_text_align": "left", 
  "axis_label_text_alpha": 1.0, 
  "axis_label_text_baseline": "bottom", 
  "axis_label_text_color": "#444444", 
  "axis_label_text_font": "helvetica", 
  "axis_label_text_font_size": "13px", 
  "axis_label_text_font_style": "italic", 
  "axis_label_text_line_height": 1.2, 
  "axis_label_text_outline_color": null, 
  "axis_line_alpha": 1.0, 
  "axis_line_cap": "butt", 
  "axis_line_color": "black", 
  "axis_line_dash": [], 
  "axis_line_dash_offset": 0, 
  "axis_line_join": "bevel", 
  "axis_line_width": 1, 
  "background_fill_alpha": 1.0, 
  "background_fill_color": null, 
  "background_hatch_alpha": 1.0, 
  "background_hatch_color": "black", 
  "background_hatch_extra": {
    "type": "map"
  }, 
  "background_hatch_pattern": null, 
  "background_hatch_scale": 12.0, 
  "background_hatch_weight": 1.0, 
  "bounds": "auto", 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "dimension": "auto", 
  "face": "auto", 
  "fixed_location": null, 
  "formatter": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "group": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p55748", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "guide", 
  "major_label_orientation": "horizontal", 
  "major_label_overrides": {
    "type": "map"
  }, 
  "major_label_policy": {
    "id": "p55749", 
    "name": "AllLabels", 
    "type": "object"
  }, 
  "major_label_standoff": 5, 
  "major_label_text_align": "center", 
  "major_label_text_alpha": 1.0, 
  "major_label_text_baseline": "alphabetic", 
  "major_label_text_color": "#444444", 
  "major_label_text_font": "helvetica", 
  "major_label_text_font_size": "11px", 
  "major_label_text_font_style": "normal", 
  "major_label_text_line_height": 1.2, 
  "major_label_text_outline_color": null, 
  "major_tick_in": 2, 
  "major_tick_line_alpha": 1.0, 
  "major_tick_line_cap": "butt", 
  "major_tick_line_color": "black", 
  "major_tick_line_dash": [], 
  "major_tick_line_dash_offset": 0, 
  "major_tick_line_join": "bevel", 
  "major_tick_line_width": 1, 
  "major_tick_out": 6, 
  "minor_tick_in": 0, 
  "minor_tick_line_alpha": 1.0, 
  "minor_tick_line_cap": "butt", 
  "minor_tick_line_color": "black", 
  "minor_tick_line_dash": [], 
  "minor_tick_line_dash_offset": 0, 
  "minor_tick_line_join": "bevel", 
  "minor_tick_line_width": 1, 
  "minor_tick_out": 4, 
  "name": null, 
  "propagate_hover": false, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "ticker": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}
axis_label = None#
类型:

Nullable(TextLike)

坐标轴的文本或 LaTeX 符号标签,与坐标轴规则平行显示。

axis_label_align = 'center'#
类型:

Enum(Align)

坐标轴标签沿坐标轴的对齐方式。

axis_label_orientation = 'parallel'#
类型:

Either(Enum(LabelOrientation), Float)

坐标轴标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

axis_label_standoff = 5#
类型:

Int

坐标轴标签应从刻度标签偏移的像素距离。

axis_label_text_align = 'left'#
类型:

Enum(TextAlign)

坐标轴标签的文本对齐方式。

axis_label_text_alpha = 1.0#
类型:

Alpha

坐标轴标签的文本 Alpha 值。

axis_label_text_baseline = 'bottom'#
类型:

Enum(TextBaseline)

坐标轴标签的文本基线。

axis_label_text_color = '#444444'#
类型:

Nullable(Color)

坐标轴标签的文本颜色。

axis_label_text_font = 'helvetica'#
类型:

String

坐标轴标签的文本字体。

axis_label_text_font_size = '13px'#
类型:

FontSize

坐标轴标签的文本字体大小。

axis_label_text_font_style = 'italic'#
类型:

Enum(FontStyle)

坐标轴标签的文本字体样式。

axis_label_text_line_height = 1.2#
类型:

Float

坐标轴标签的文本行高。

axis_label_text_outline_color = None#
类型:

Nullable(Color)

坐标轴标签的文本轮廓颜色。

axis_line_alpha = 1.0#
类型:

Alpha

坐标轴线的线条 Alpha 值。

axis_line_cap = 'butt'#
类型:

Enum(LineCap)

坐标轴线的线帽样式。

axis_line_color = 'black'#
类型:

Nullable(Color)

坐标轴线的线条颜色。

axis_line_dash = []#
类型:

DashPattern

坐标轴线的线段虚线模式。

axis_line_dash_offset = 0#
类型:

Int

坐标轴线的线段虚线偏移量。

axis_line_join = 'bevel'#
类型:

Enum(LineJoin)

坐标轴线的线段连接样式。

axis_line_width = 1#
类型:

Float

坐标轴线的线宽。

background_fill_alpha = 1.0#
类型:

Alpha

坐标轴背景的填充 Alpha 值。

background_fill_color = None#
类型:

Nullable(Color)

坐标轴背景的填充颜色。

background_hatch_alpha = 1.0#
类型:

Alpha

坐标轴背景的阴影线 Alpha 值。

background_hatch_color = 'black'#
类型:

Nullable(Color)

坐标轴背景的阴影线颜色。

background_hatch_extra = {}#
类型:

Dict(String, Instance(Texture))

坐标轴背景的额外阴影线属性。

background_hatch_pattern = None#
类型:

Nullable(String)

坐标轴背景的阴影线图案。

background_hatch_scale = 12.0#
类型:

Size

坐标轴背景的阴影线比例。

background_hatch_weight = 1.0#
类型:

Size

坐标轴背景的阴影线粗细。

bounds = 'auto'#
类型:

Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime))

渲染坐标轴的边界。如果未设置,则坐标轴将在给定维度上跨越整个绘图。

context_menu = None#
类型:

Nullable(Instance(‘.models.ui.Menu’))

用户右键单击组件时显示的菜单。

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#
类型:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}#
类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如,这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

注意

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

dimension = 'auto'#
类型:

Either(Auto, Int)

这允许在支持此功能的上下文中覆盖推断的维度。当坐标轴用作框架坐标轴时,此属性无效。

注意

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

face = 'auto'#
类型:

Either(Auto, Enum(Enumeration(front, back)))

坐标轴将面向的方向。

注意

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

fixed_location = None#
类型:

Either(Null, Float, Factor)

设置为指定绘制坐标轴的固定坐标位置。刻度和主标签的方向由坐标轴所属的侧面板决定。

注意

当坐标轴位于中心绘图区域内的固定位置时,坐标轴标签将被抑制。

formatter = Undefined#
类型:

Instance(TickFormatter)

用于格式化刻度视觉外观的 TickFormatter

group = None#
类型:

Nullable(RendererGroup))

注意

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

html_attributes = {}#
类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#
类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者,可以在 html_attributes 字典中设置 idhtml_id 优先。

level = 'guide'#
类型:

Enum(RenderLevel)

指定绘制此渲染器的级别。

major_label_orientation = 'horizontal'#
类型:

Either(Enum(LabelOrientation), Float)

主标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

major_label_overrides = {}#
类型:

Dict(Either(Float, String), TextLike)

为特定刻度位置提供显式刻度标签值,以覆盖正常格式。

major_label_policy = AllLabels(id='p55836', ...)#
类型:

Instance(LabelingPolicy)

允许过滤掉标签,例如,清理标签以避免重叠。

major_label_standoff = 5#
类型:

Int

主刻度标签应从相关刻度偏移的像素距离。

major_label_text_align = 'center'#
类型:

Enum(TextAlign)

主刻度标签的文本对齐方式。

major_label_text_alpha = 1.0#
类型:

Alpha

主刻度标签的文本 Alpha 值。

major_label_text_baseline = 'alphabetic'#
类型:

Enum(TextBaseline)

主刻度标签的文本基线。

major_label_text_color = '#444444'#
类型:

Nullable(Color)

主要刻度标签的文本颜色。

major_label_text_font = 'helvetica'#
类型:

String

主要刻度标签的文本字体。

major_label_text_font_size = '11px'#
类型:

FontSize

主要刻度标签的文本字体大小。

major_label_text_font_style = 'normal'#
类型:

Enum(FontStyle)

主要刻度标签的文本字体样式。

major_label_text_line_height = 1.2#
类型:

Float

主要刻度标签的文本行高。

major_label_text_outline_color = None#
类型:

Nullable(Color)

主要刻度标签的文本轮廓颜色。

major_tick_in = 2#
类型:

Int

主要刻度线应延伸到主绘图区域的像素距离。

major_tick_line_alpha = 1.0#
类型:

Alpha

主要刻度线的线条 alpha 值。

major_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

主要刻度线的线帽样式。

major_tick_line_color = 'black'#
类型:

Nullable(Color)

主要刻度线的线条颜色。

major_tick_line_dash = []#
类型:

DashPattern

主要刻度线的线条虚线模式。

major_tick_line_dash_offset = 0#
类型:

Int

主要刻度线的线条虚线偏移。

major_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

主要刻度线的线连接样式。

major_tick_line_width = 1#
类型:

Float

主要刻度线的线条宽度。

major_tick_out = 6#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

minor_tick_in = 0#
类型:

Int

次要刻度线应延伸到主绘图区域的像素距离。

minor_tick_line_alpha = 1.0#
类型:

Alpha

次要刻度线的线条 alpha 值。

minor_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

次要刻度线的线帽样式。

minor_tick_line_color = 'black'#
类型:

Nullable(Color)

次要刻度线的线条颜色。

minor_tick_line_dash = []#
类型:

DashPattern

次要刻度线的线条虚线模式。

minor_tick_line_dash_offset = 0#
类型:

Int

次要刻度线的线条虚线偏移。

minor_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

次要刻度线的线连接样式。

minor_tick_line_width = 1#
类型:

Float

次要刻度线的线条宽度。

minor_tick_out = 4#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

name = None#
类型:

Nullable(String)

此模型的可选的、用户提供的名称。

当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用该名称。

propagate_hover = False#
类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

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

styles = {}#
类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#
类型:

List

用于底层 DOM 元素的附加样式表。

请注意,所有 bokeh 的组件都使用 shadow DOM,因此任何包含的样式表都必须反映这一点,例如,使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然有效。

tags = []#
类型:

List

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

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

ticker = Undefined#
类型:

Instance(Ticker)

用于计算轴组件位置的 Ticker。

该属性也可以传递浮点数序列,作为创建和配置 FixedTicker 的简写,例如以下代码

from bokeh.plotting import figure

p = figure()
p.xaxis.ticker = [10, 20, 37.4]

等效于

from bokeh.plotting import figure
from bokeh.models import FixedTicker

p = figure()
p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
visible = True#
类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)x 轴范围。如果未设置,则使用默认 x 轴范围。

y_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)y 轴范围。如果未设置,则使用默认 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

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

这是一个便捷方法,可简化添加 CustomJS 回调,以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:
  • attr (str) – 此模型上 Bokeh 属性的名称

  • other (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

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

返回:

从属性名称到其值的映射

返回类型:

dict

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, 可选) – 是否包含用户尚未显式设置的属性(默认值:True)

返回:

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

返回类型:

dict

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

返回:

Model

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

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

参数:
  • name (str) – 要设置的属性的名称

  • value (JSON-value) – 要设置为属性的值

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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#
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)

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

基类: Axis

一个轴,用于显示分类范围的刻度和标签。

CategoricalAxis 可以处理最多两层嵌套的因子范围,包括在顶层因子组之间绘制分隔线。

JSON 原型
{
  "axis_label": null, 
  "axis_label_align": "center", 
  "axis_label_orientation": "parallel", 
  "axis_label_standoff": 5, 
  "axis_label_text_align": "left", 
  "axis_label_text_alpha": 1.0, 
  "axis_label_text_baseline": "bottom", 
  "axis_label_text_color": "#444444", 
  "axis_label_text_font": "helvetica", 
  "axis_label_text_font_size": "13px", 
  "axis_label_text_font_style": "italic", 
  "axis_label_text_line_height": 1.2, 
  "axis_label_text_outline_color": null, 
  "axis_line_alpha": 1.0, 
  "axis_line_cap": "butt", 
  "axis_line_color": "black", 
  "axis_line_dash": [], 
  "axis_line_dash_offset": 0, 
  "axis_line_join": "bevel", 
  "axis_line_width": 1, 
  "background_fill_alpha": 1.0, 
  "background_fill_color": null, 
  "background_hatch_alpha": 1.0, 
  "background_hatch_color": "black", 
  "background_hatch_extra": {
    "type": "map"
  }, 
  "background_hatch_pattern": null, 
  "background_hatch_scale": 12.0, 
  "background_hatch_weight": 1.0, 
  "bounds": "auto", 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "dimension": "auto", 
  "face": "auto", 
  "fixed_location": null, 
  "formatter": {
    "id": "p55915", 
    "name": "CategoricalTickFormatter", 
    "type": "object"
  }, 
  "group": null, 
  "group_label_orientation": "parallel", 
  "group_text_align": "left", 
  "group_text_alpha": 1.0, 
  "group_text_baseline": "bottom", 
  "group_text_color": "grey", 
  "group_text_font": "helvetica", 
  "group_text_font_size": "11px", 
  "group_text_font_style": "bold", 
  "group_text_line_height": 1.2, 
  "group_text_outline_color": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p55913", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "guide", 
  "major_label_orientation": "horizontal", 
  "major_label_overrides": {
    "type": "map"
  }, 
  "major_label_policy": {
    "id": "p55916", 
    "name": "AllLabels", 
    "type": "object"
  }, 
  "major_label_standoff": 5, 
  "major_label_text_align": "center", 
  "major_label_text_alpha": 1.0, 
  "major_label_text_baseline": "alphabetic", 
  "major_label_text_color": "#444444", 
  "major_label_text_font": "helvetica", 
  "major_label_text_font_size": "11px", 
  "major_label_text_font_style": "normal", 
  "major_label_text_line_height": 1.2, 
  "major_label_text_outline_color": null, 
  "major_tick_in": 2, 
  "major_tick_line_alpha": 1.0, 
  "major_tick_line_cap": "butt", 
  "major_tick_line_color": "black", 
  "major_tick_line_dash": [], 
  "major_tick_line_dash_offset": 0, 
  "major_tick_line_join": "bevel", 
  "major_tick_line_width": 1, 
  "major_tick_out": 6, 
  "minor_tick_in": 0, 
  "minor_tick_line_alpha": 1.0, 
  "minor_tick_line_cap": "butt", 
  "minor_tick_line_color": "black", 
  "minor_tick_line_dash": [], 
  "minor_tick_line_dash_offset": 0, 
  "minor_tick_line_join": "bevel", 
  "minor_tick_line_width": 1, 
  "minor_tick_out": 4, 
  "name": null, 
  "propagate_hover": false, 
  "separator_line_alpha": 1.0, 
  "separator_line_cap": "butt", 
  "separator_line_color": "lightgrey", 
  "separator_line_dash": [], 
  "separator_line_dash_offset": 0, 
  "separator_line_join": "bevel", 
  "separator_line_width": 2, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subgroup_label_orientation": "parallel", 
  "subgroup_text_align": "left", 
  "subgroup_text_alpha": 1.0, 
  "subgroup_text_baseline": "bottom", 
  "subgroup_text_color": "#444444", 
  "subgroup_text_font": "helvetica", 
  "subgroup_text_font_size": "11px", 
  "subgroup_text_font_style": "bold", 
  "subgroup_text_line_height": 1.2, 
  "subgroup_text_outline_color": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "ticker": {
    "id": "p55914", 
    "name": "CategoricalTicker", 
    "type": "object"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}
axis_label = None#
类型:

Nullable(TextLike)

坐标轴的文本或 LaTeX 符号标签,与坐标轴规则平行显示。

axis_label_align = 'center'#
类型:

Enum(Align)

坐标轴标签沿坐标轴的对齐方式。

axis_label_orientation = 'parallel'#
类型:

Either(Enum(LabelOrientation), Float)

坐标轴标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

axis_label_standoff = 5#
类型:

Int

坐标轴标签应从刻度标签偏移的像素距离。

axis_label_text_align = 'left'#
类型:

Enum(TextAlign)

坐标轴标签的文本对齐方式。

axis_label_text_alpha = 1.0#
类型:

Alpha

坐标轴标签的文本 Alpha 值。

axis_label_text_baseline = 'bottom'#
类型:

Enum(TextBaseline)

坐标轴标签的文本基线。

axis_label_text_color = '#444444'#
类型:

Nullable(Color)

坐标轴标签的文本颜色。

axis_label_text_font = 'helvetica'#
类型:

String

坐标轴标签的文本字体。

axis_label_text_font_size = '13px'#
类型:

FontSize

坐标轴标签的文本字体大小。

axis_label_text_font_style = 'italic'#
类型:

Enum(FontStyle)

坐标轴标签的文本字体样式。

axis_label_text_line_height = 1.2#
类型:

Float

坐标轴标签的文本行高。

axis_label_text_outline_color = None#
类型:

Nullable(Color)

坐标轴标签的文本轮廓颜色。

axis_line_alpha = 1.0#
类型:

Alpha

坐标轴线的线条 Alpha 值。

axis_line_cap = 'butt'#
类型:

Enum(LineCap)

坐标轴线的线帽样式。

axis_line_color = 'black'#
类型:

Nullable(Color)

坐标轴线的线条颜色。

axis_line_dash = []#
类型:

DashPattern

坐标轴线的线段虚线模式。

axis_line_dash_offset = 0#
类型:

Int

坐标轴线的线段虚线偏移量。

axis_line_join = 'bevel'#
类型:

Enum(LineJoin)

坐标轴线的线段连接样式。

axis_line_width = 1#
类型:

Float

坐标轴线的线宽。

background_fill_alpha = 1.0#
类型:

Alpha

坐标轴背景的填充 Alpha 值。

background_fill_color = None#
类型:

Nullable(Color)

坐标轴背景的填充颜色。

background_hatch_alpha = 1.0#
类型:

Alpha

坐标轴背景的阴影线 Alpha 值。

background_hatch_color = 'black'#
类型:

Nullable(Color)

坐标轴背景的阴影线颜色。

background_hatch_extra = {}#
类型:

Dict(String, Instance(Texture))

坐标轴背景的额外阴影线属性。

background_hatch_pattern = None#
类型:

Nullable(String)

坐标轴背景的阴影线图案。

background_hatch_scale = 12.0#
类型:

Size

坐标轴背景的阴影线比例。

background_hatch_weight = 1.0#
类型:

Size

坐标轴背景的阴影线粗细。

bounds = 'auto'#
类型:

Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime))

渲染坐标轴的边界。如果未设置,则坐标轴将在给定维度上跨越整个绘图。

context_menu = None#
类型:

Nullable(Instance(‘.models.ui.Menu’))

用户右键单击组件时显示的菜单。

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#
类型:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}#
类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如,这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

注意

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

dimension = 'auto'#
类型:

Either(Auto, Int)

这允许在支持此功能的上下文中覆盖推断的维度。当坐标轴用作框架坐标轴时,此属性无效。

注意

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

face = 'auto'#
类型:

Either(Auto, Enum(Enumeration(front, back)))

坐标轴将面向的方向。

注意

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

fixed_location = None#
类型:

Either(Null, Float, Factor)

设置为指定绘制坐标轴的固定坐标位置。刻度和主标签的方向由坐标轴所属的侧面板决定。

注意

当坐标轴位于中心绘图区域内的固定位置时,坐标轴标签将被抑制。

formatter = CategoricalTickFormatter(id='p56061', ...)#
类型:

Instance(TickFormatter)

用于格式化刻度视觉外观的 TickFormatter

group = None#
类型:

Nullable(RendererGroup))

注意

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

group_label_orientation = 'parallel'#
类型:

Either(Enum(LabelOrientation), Float)

组标签文本应朝哪个方向定向。

如果提供了一个数字,则文本的角度是从水平方向测量的。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

group_text_align = 'left'#
类型:

Enum(TextAlign)

组分类标签的文本对齐方式。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

group_text_alpha = 1.0#
类型:

Alpha

分组类别标签的文本alpha值。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

group_text_baseline = 'bottom'#
类型:

Enum(TextBaseline)

分组类别标签的文本基线。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

group_text_color = 'grey'#
类型:

Nullable(Color)

分组类别标签的文本颜色。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

group_text_font = 'helvetica'#
类型:

String

分组类别标签的文本字体。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

group_text_font_size = '11px'#
类型:

FontSize

分组类别标签的文本字体大小。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

group_text_font_style = 'bold'#
类型:

Enum(FontStyle)

分组类别标签的文本字体样式。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

group_text_line_height = 1.2#
类型:

Float

分组类别标签的文本行高。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

group_text_outline_color = None#
类型:

Nullable(Color)

分组类别标签的文本轮廓颜色。

此属性始终应用于最外层嵌套中的因子。如果分类因子列表是扁平的(即没有嵌套),则此属性无效。

html_attributes = {}#
类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#
类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者,可以在 html_attributes 字典中设置 idhtml_id 优先。

level = 'guide'#
类型:

Enum(RenderLevel)

指定绘制此渲染器的级别。

major_label_orientation = 'horizontal'#
类型:

Either(Enum(LabelOrientation), Float)

主标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

major_label_overrides = {}#
类型:

Dict(Either(Float, String), TextLike)

为特定刻度位置提供显式刻度标签值,以覆盖正常格式。

major_label_policy = AllLabels(id='p56130', ...)#
类型:

Instance(LabelingPolicy)

允许过滤掉标签,例如,清理标签以避免重叠。

major_label_standoff = 5#
类型:

Int

主刻度标签应从相关刻度偏移的像素距离。

major_label_text_align = 'center'#
类型:

Enum(TextAlign)

主刻度标签的文本对齐方式。

major_label_text_alpha = 1.0#
类型:

Alpha

主刻度标签的文本 Alpha 值。

major_label_text_baseline = 'alphabetic'#
类型:

Enum(TextBaseline)

主刻度标签的文本基线。

major_label_text_color = '#444444'#
类型:

Nullable(Color)

主要刻度标签的文本颜色。

major_label_text_font = 'helvetica'#
类型:

String

主要刻度标签的文本字体。

major_label_text_font_size = '11px'#
类型:

FontSize

主要刻度标签的文本字体大小。

major_label_text_font_style = 'normal'#
类型:

Enum(FontStyle)

主要刻度标签的文本字体样式。

major_label_text_line_height = 1.2#
类型:

Float

主要刻度标签的文本行高。

major_label_text_outline_color = None#
类型:

Nullable(Color)

主要刻度标签的文本轮廓颜色。

major_tick_in = 2#
类型:

Int

主要刻度线应延伸到主绘图区域的像素距离。

major_tick_line_alpha = 1.0#
类型:

Alpha

主要刻度线的线条 alpha 值。

major_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

主要刻度线的线帽样式。

major_tick_line_color = 'black'#
类型:

Nullable(Color)

主要刻度线的线条颜色。

major_tick_line_dash = []#
类型:

DashPattern

主要刻度线的线条虚线模式。

major_tick_line_dash_offset = 0#
类型:

Int

主要刻度线的线条虚线偏移。

major_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

主要刻度线的线连接样式。

major_tick_line_width = 1#
类型:

Float

主要刻度线的线条宽度。

major_tick_out = 6#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

minor_tick_in = 0#
类型:

Int

次要刻度线应延伸到主绘图区域的像素距离。

minor_tick_line_alpha = 1.0#
类型:

Alpha

次要刻度线的线条 alpha 值。

minor_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

次要刻度线的线帽样式。

minor_tick_line_color = 'black'#
类型:

Nullable(Color)

次要刻度线的线条颜色。

minor_tick_line_dash = []#
类型:

DashPattern

次要刻度线的线条虚线模式。

minor_tick_line_dash_offset = 0#
类型:

Int

次要刻度线的线条虚线偏移。

minor_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

次要刻度线的线连接样式。

minor_tick_line_width = 1#
类型:

Float

次要刻度线的线条宽度。

minor_tick_out = 4#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

name = None#
类型:

Nullable(String)

此模型的可选的、用户提供的名称。

当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用该名称。

propagate_hover = False#
类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

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

separator_line_alpha = 1.0#
类型:

Alpha

顶层类别组之间分隔线的线条 alpha 值。

此属性始终应用于最外层嵌套的因子。

separator_line_cap = 'butt'#
类型:

Enum(LineCap)

顶层类别组之间分隔线的线帽样式。

此属性始终应用于最外层嵌套的因子。

separator_line_color = 'lightgrey'#
类型:

Nullable(Color)

顶层类别组之间分隔线的线条颜色。

此属性始终应用于最外层嵌套的因子。

separator_line_dash = []#
类型:

DashPattern

顶层类别组之间分隔线的线条虚线模式。

此属性始终应用于最外层嵌套的因子。

separator_line_dash_offset = 0#
类型:

Int

顶层类别组之间分隔线的线条虚线偏移。

此属性始终应用于最外层嵌套的因子。

separator_line_join = 'bevel'#
类型:

Enum(LineJoin)

顶层类别组之间分隔线的线连接样式。

此属性始终应用于最外层嵌套的因子。

separator_line_width = 2#
类型:

Float

顶层类别组之间分隔线的线条宽度。

此属性始终应用于最外层嵌套的因子。

styles = {}#
类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#
类型:

List

用于底层 DOM 元素的附加样式表。

请注意,所有 bokeh 的组件都使用 shadow DOM,因此任何包含的样式表都必须反映这一点,例如,使用 :host CSS 伪选择器来访问根 DOM 元素。

subgroup_label_orientation = 'parallel'#
类型:

Either(Enum(LabelOrientation), Float)

子分组标签文本应朝向哪个方向。

如果提供了一个数字,则文本的角度是从水平方向测量的。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

subgroup_text_align = 'left'#
类型:

Enum(TextAlign)

子分组类别标签的文本对齐方式。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

subgroup_text_alpha = 1.0#
类型:

Alpha

子分组类别标签的文本alpha值。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

subgroup_text_baseline = 'bottom'#
类型:

Enum(TextBaseline)

子分组类别标签的文本基线。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

subgroup_text_color = '#444444'#
类型:

Nullable(Color)

子分组类别标签的文本颜色。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

subgroup_text_font = 'helvetica'#
类型:

String

子分组类别标签的文本字体。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

subgroup_text_font_size = '11px'#
类型:

FontSize

子分组类别标签的文本字体大小。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

subgroup_text_font_style = 'bold'#
类型:

Enum(FontStyle)

子分组类别标签的文本字体样式。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

subgroup_text_line_height = 1.2#
类型:

Float

子分组类别标签的文本行高。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

subgroup_text_outline_color = None#
类型:

Nullable(Color)

子分组类别标签的文本轮廓颜色。

此属性始终应用于中间层嵌套的因子。如果类别因子列表只有零层或一层嵌套,则此属性无效。

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然有效。

tags = []#
类型:

List

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

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

ticker = CategoricalTicker(id='p56339', ...)#
类型:

Instance(Ticker)

用于计算轴组件位置的 Ticker。

该属性也可以传递浮点数序列,作为创建和配置 FixedTicker 的简写,例如以下代码

from bokeh.plotting import figure

p = figure()
p.xaxis.ticker = [10, 20, 37.4]

等效于

from bokeh.plotting import figure
from bokeh.models import FixedTicker

p = figure()
p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
visible = True#
类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)x 轴范围。如果未设置,则使用默认 x 轴范围。

y_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)y 轴范围。如果未设置,则使用默认 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

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

这是一个便捷方法,可简化添加 CustomJS 回调,以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:
  • attr (str) – 此模型上 Bokeh 属性的名称

  • other (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

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

返回:

从属性名称到其值的映射

返回类型:

dict

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, 可选) – 是否包含用户尚未显式设置的属性(默认值:True)

返回:

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

返回类型:

dict

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

返回:

Model

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

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

参数:
  • name (str) – 要设置的属性的名称

  • value (JSON-value) – 要设置为属性的值

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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#
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)

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

基类: Axis

所有数值型、非类别轴类型的基类。

注意

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

JSON 原型
{
  "axis_label": null, 
  "axis_label_align": "center", 
  "axis_label_orientation": "parallel", 
  "axis_label_standoff": 5, 
  "axis_label_text_align": "left", 
  "axis_label_text_alpha": 1.0, 
  "axis_label_text_baseline": "bottom", 
  "axis_label_text_color": "#444444", 
  "axis_label_text_font": "helvetica", 
  "axis_label_text_font_size": "13px", 
  "axis_label_text_font_style": "italic", 
  "axis_label_text_line_height": 1.2, 
  "axis_label_text_outline_color": null, 
  "axis_line_alpha": 1.0, 
  "axis_line_cap": "butt", 
  "axis_line_color": "black", 
  "axis_line_dash": [], 
  "axis_line_dash_offset": 0, 
  "axis_line_join": "bevel", 
  "axis_line_width": 1, 
  "background_fill_alpha": 1.0, 
  "background_fill_color": null, 
  "background_hatch_alpha": 1.0, 
  "background_hatch_color": "black", 
  "background_hatch_extra": {
    "type": "map"
  }, 
  "background_hatch_pattern": null, 
  "background_hatch_scale": 12.0, 
  "background_hatch_weight": 1.0, 
  "bounds": "auto", 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "dimension": "auto", 
  "face": "auto", 
  "fixed_location": null, 
  "formatter": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "group": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p56352", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "guide", 
  "major_label_orientation": "horizontal", 
  "major_label_overrides": {
    "type": "map"
  }, 
  "major_label_policy": {
    "id": "p56353", 
    "name": "AllLabels", 
    "type": "object"
  }, 
  "major_label_standoff": 5, 
  "major_label_text_align": "center", 
  "major_label_text_alpha": 1.0, 
  "major_label_text_baseline": "alphabetic", 
  "major_label_text_color": "#444444", 
  "major_label_text_font": "helvetica", 
  "major_label_text_font_size": "11px", 
  "major_label_text_font_style": "normal", 
  "major_label_text_line_height": 1.2, 
  "major_label_text_outline_color": null, 
  "major_tick_in": 2, 
  "major_tick_line_alpha": 1.0, 
  "major_tick_line_cap": "butt", 
  "major_tick_line_color": "black", 
  "major_tick_line_dash": [], 
  "major_tick_line_dash_offset": 0, 
  "major_tick_line_join": "bevel", 
  "major_tick_line_width": 1, 
  "major_tick_out": 6, 
  "minor_tick_in": 0, 
  "minor_tick_line_alpha": 1.0, 
  "minor_tick_line_cap": "butt", 
  "minor_tick_line_color": "black", 
  "minor_tick_line_dash": [], 
  "minor_tick_line_dash_offset": 0, 
  "minor_tick_line_join": "bevel", 
  "minor_tick_line_width": 1, 
  "minor_tick_out": 4, 
  "name": null, 
  "propagate_hover": false, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "ticker": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}
axis_label = None#
类型:

Nullable(TextLike)

坐标轴的文本或 LaTeX 符号标签,与坐标轴规则平行显示。

axis_label_align = 'center'#
类型:

Enum(Align)

坐标轴标签沿坐标轴的对齐方式。

axis_label_orientation = 'parallel'#
类型:

Either(Enum(LabelOrientation), Float)

坐标轴标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

axis_label_standoff = 5#
类型:

Int

坐标轴标签应从刻度标签偏移的像素距离。

axis_label_text_align = 'left'#
类型:

Enum(TextAlign)

坐标轴标签的文本对齐方式。

axis_label_text_alpha = 1.0#
类型:

Alpha

坐标轴标签的文本 Alpha 值。

axis_label_text_baseline = 'bottom'#
类型:

Enum(TextBaseline)

坐标轴标签的文本基线。

axis_label_text_color = '#444444'#
类型:

Nullable(Color)

坐标轴标签的文本颜色。

axis_label_text_font = 'helvetica'#
类型:

String

坐标轴标签的文本字体。

axis_label_text_font_size = '13px'#
类型:

FontSize

坐标轴标签的文本字体大小。

axis_label_text_font_style = 'italic'#
类型:

Enum(FontStyle)

坐标轴标签的文本字体样式。

axis_label_text_line_height = 1.2#
类型:

Float

坐标轴标签的文本行高。

axis_label_text_outline_color = None#
类型:

Nullable(Color)

坐标轴标签的文本轮廓颜色。

axis_line_alpha = 1.0#
类型:

Alpha

坐标轴线的线条 Alpha 值。

axis_line_cap = 'butt'#
类型:

Enum(LineCap)

坐标轴线的线帽样式。

axis_line_color = 'black'#
类型:

Nullable(Color)

坐标轴线的线条颜色。

axis_line_dash = []#
类型:

DashPattern

坐标轴线的线段虚线模式。

axis_line_dash_offset = 0#
类型:

Int

坐标轴线的线段虚线偏移量。

axis_line_join = 'bevel'#
类型:

Enum(LineJoin)

坐标轴线的线段连接样式。

axis_line_width = 1#
类型:

Float

坐标轴线的线宽。

background_fill_alpha = 1.0#
类型:

Alpha

坐标轴背景的填充 Alpha 值。

background_fill_color = None#
类型:

Nullable(Color)

坐标轴背景的填充颜色。

background_hatch_alpha = 1.0#
类型:

Alpha

坐标轴背景的阴影线 Alpha 值。

background_hatch_color = 'black'#
类型:

Nullable(Color)

坐标轴背景的阴影线颜色。

background_hatch_extra = {}#
类型:

Dict(String, Instance(Texture))

坐标轴背景的额外阴影线属性。

background_hatch_pattern = None#
类型:

Nullable(String)

坐标轴背景的阴影线图案。

background_hatch_scale = 12.0#
类型:

Size

坐标轴背景的阴影线比例。

background_hatch_weight = 1.0#
类型:

Size

坐标轴背景的阴影线粗细。

bounds = 'auto'#
类型:

Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime))

渲染坐标轴的边界。如果未设置,则坐标轴将在给定维度上跨越整个绘图。

context_menu = None#
类型:

Nullable(Instance(‘.models.ui.Menu’))

用户右键单击组件时显示的菜单。

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#
类型:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}#
类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如,这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

注意

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

dimension = 'auto'#
类型:

Either(Auto, Int)

这允许在支持此功能的上下文中覆盖推断的维度。当坐标轴用作框架坐标轴时,此属性无效。

注意

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

face = 'auto'#
类型:

Either(Auto, Enum(Enumeration(front, back)))

坐标轴将面向的方向。

注意

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

fixed_location = None#
类型:

Either(Null, Float, Factor)

设置为指定绘制坐标轴的固定坐标位置。刻度和主标签的方向由坐标轴所属的侧面板决定。

注意

当坐标轴位于中心绘图区域内的固定位置时,坐标轴标签将被抑制。

formatter = Undefined#
类型:

Instance(TickFormatter)

用于格式化刻度视觉外观的 TickFormatter

group = None#
类型:

Nullable(RendererGroup))

注意

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

html_attributes = {}#
类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#
类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者,可以在 html_attributes 字典中设置 idhtml_id 优先。

level = 'guide'#
类型:

Enum(RenderLevel)

指定绘制此渲染器的级别。

major_label_orientation = 'horizontal'#
类型:

Either(Enum(LabelOrientation), Float)

主标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

major_label_overrides = {}#
类型:

Dict(Either(Float, String), TextLike)

为特定刻度位置提供显式刻度标签值,以覆盖正常格式。

major_label_policy = AllLabels(id='p56440', ...)#
类型:

Instance(LabelingPolicy)

允许过滤掉标签,例如,清理标签以避免重叠。

major_label_standoff = 5#
类型:

Int

主刻度标签应从相关刻度偏移的像素距离。

major_label_text_align = 'center'#
类型:

Enum(TextAlign)

主刻度标签的文本对齐方式。

major_label_text_alpha = 1.0#
类型:

Alpha

主刻度标签的文本 Alpha 值。

major_label_text_baseline = 'alphabetic'#
类型:

Enum(TextBaseline)

主刻度标签的文本基线。

major_label_text_color = '#444444'#
类型:

Nullable(Color)

主要刻度标签的文本颜色。

major_label_text_font = 'helvetica'#
类型:

String

主要刻度标签的文本字体。

major_label_text_font_size = '11px'#
类型:

FontSize

主要刻度标签的文本字体大小。

major_label_text_font_style = 'normal'#
类型:

Enum(FontStyle)

主要刻度标签的文本字体样式。

major_label_text_line_height = 1.2#
类型:

Float

主要刻度标签的文本行高。

major_label_text_outline_color = None#
类型:

Nullable(Color)

主要刻度标签的文本轮廓颜色。

major_tick_in = 2#
类型:

Int

主要刻度线应延伸到主绘图区域的像素距离。

major_tick_line_alpha = 1.0#
类型:

Alpha

主要刻度线的线条 alpha 值。

major_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

主要刻度线的线帽样式。

major_tick_line_color = 'black'#
类型:

Nullable(Color)

主要刻度线的线条颜色。

major_tick_line_dash = []#
类型:

DashPattern

主要刻度线的线条虚线模式。

major_tick_line_dash_offset = 0#
类型:

Int

主要刻度线的线条虚线偏移。

major_tick_line_join = 'bevel'# 主刻度线连接样式
类型:

Enum(LineJoin)

主要刻度线的线连接样式。

major_tick_line_width = 1# 主刻度线宽度
类型:

Float

主要刻度线的线条宽度。

major_tick_out = 6# 主刻度线向外长度
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

minor_tick_in = 0# 副刻度线向内长度
类型:

Int

次要刻度线应延伸到主绘图区域的像素距离。

minor_tick_line_alpha = 1.0# 副刻度线透明度
类型:

Alpha

次要刻度线的线条 alpha 值。

minor_tick_line_cap = 'butt'# 副刻度线端点样式
类型:

Enum(LineCap)

次要刻度线的线帽样式。

minor_tick_line_color = 'black'# 副刻度线颜色
类型:

Nullable(Color)

次要刻度线的线条颜色。

minor_tick_line_dash = []# 副刻度线虚线模式
类型:

DashPattern

次要刻度线的线条虚线模式。

minor_tick_line_dash_offset = 0# 副刻度线虚线偏移
类型:

Int

次要刻度线的线条虚线偏移。

minor_tick_line_join = 'bevel'# 副刻度线连接样式
类型:

Enum(LineJoin)

次要刻度线的线连接样式。

minor_tick_line_width = 1# 副刻度线宽度
类型:

Float

次要刻度线的线条宽度。

minor_tick_out = 4# 副刻度线向外长度
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

name = None# 名称
类型:

Nullable(String)

此模型的可选的、用户提供的名称。

当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用该名称。

propagate_hover = False# 传播悬停事件
类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

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

styles = {}# 样式
类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []# 样式表
类型:

List

用于底层 DOM 元素的附加样式表。

请注意,所有 bokeh 的组件都使用 shadow DOM,因此任何包含的样式表都必须反映这一点,例如,使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True# 可同步的
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然有效。

tags = []# 标签
类型:

List

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

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

ticker = Undefined# 刻度生成器
类型:

Instance(Ticker)

用于计算轴组件位置的 Ticker。

该属性也可以传递浮点数序列,作为创建和配置 FixedTicker 的简写,例如以下代码

from bokeh.plotting import figure

p = figure()
p.xaxis.ticker = [10, 20, 37.4]

等效于

from bokeh.plotting import figure
from bokeh.models import FixedTicker

p = figure()
p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
visible = True# 可见的
类型:

布尔值

渲染器是否可见。

x_range_name = 'default'# X轴范围名称
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)x 轴范围。如果未设置,则使用默认 x 轴范围。

y_range_name = 'default'# Y轴范围名称
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)y 轴范围。如果未设置,则使用默认 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

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

这是一个便捷方法,可简化添加 CustomJS 回调,以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:
  • attr (str) – 此模型上 Bokeh 属性的名称

  • other (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# JavaScript 属性更改事件

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

返回:

从属性名称到其值的映射

返回类型:

dict

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, 可选) – 是否包含用户尚未显式设置的属性(默认值:True)

返回:

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

返回类型:

dict

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

返回:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) None# 从 JSON 设置

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

参数:
  • name (str) – 要设置的属性的名称

  • value (JSON-value) – 要设置为属性的值

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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# 序列化

将此对象转换为可序列化的表示形式。

触发(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
取消应用主题() None#

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

返回:

None

更新(**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)
属性 document: Document | None#

此模型附加到的 Document (可以为 None)

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

基类: LinearAxis

一个 LinearAxis,它在日期时间刻度上选择合适的数字作为刻度位置。默认配置为 DatetimeTickFormatter

JSON 原型
{
  "axis_label": null, 
  "axis_label_align": "center", 
  "axis_label_orientation": "parallel", 
  "axis_label_standoff": 5, 
  "axis_label_text_align": "left", 
  "axis_label_text_alpha": 1.0, 
  "axis_label_text_baseline": "bottom", 
  "axis_label_text_color": "#444444", 
  "axis_label_text_font": "helvetica", 
  "axis_label_text_font_size": "13px", 
  "axis_label_text_font_style": "italic", 
  "axis_label_text_line_height": 1.2, 
  "axis_label_text_outline_color": null, 
  "axis_line_alpha": 1.0, 
  "axis_line_cap": "butt", 
  "axis_line_color": "black", 
  "axis_line_dash": [], 
  "axis_line_dash_offset": 0, 
  "axis_line_join": "bevel", 
  "axis_line_width": 1, 
  "background_fill_alpha": 1.0, 
  "background_fill_color": null, 
  "background_hatch_alpha": 1.0, 
  "background_hatch_color": "black", 
  "background_hatch_extra": {
    "type": "map"
  }, 
  "background_hatch_pattern": null, 
  "background_hatch_scale": 12.0, 
  "background_hatch_weight": 1.0, 
  "bounds": "auto", 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "dimension": "auto", 
  "face": "auto", 
  "fixed_location": null, 
  "formatter": {
    "attributes": {
      "boundary_scaling": false, 
      "context": {
        "attributes": {
          "boundary_scaling": false, 
          "context": {
            "attributes": {
              "boundary_scaling": false, 
              "days": "", 
              "hide_repeats": true, 
              "hourmin": "", 
              "hours": "", 
              "microseconds": "%b %d, %Y", 
              "milliseconds": "%b %d, %Y", 
              "minsec": "", 
              "minutes": "", 
              "months": "", 
              "seconds": "", 
              "years": ""
            }, 
            "id": "p56531", 
            "name": "DatetimeTickFormatter", 
            "type": "object"
          }, 
          "context_which": "all", 
          "days": "%Y", 
          "hide_repeats": true, 
          "hourmin": "%b %d, %Y", 
          "hours": "%b %d, %Y", 
          "microseconds": "%T", 
          "milliseconds": "%T", 
          "minsec": "%b %d, %Y", 
          "minutes": "%b %d, %Y", 
          "months": "", 
          "seconds": "%b %d, %Y", 
          "years": ""
        }, 
        "id": "p56532", 
        "name": "DatetimeTickFormatter", 
        "type": "object"
      }, 
      "context_which": "all", 
      "days": "%b %d", 
      "hours": "%H:%M", 
      "minsec": "%T", 
      "minutes": "%H:%M", 
      "months": "%b %Y", 
      "seconds": "%T", 
      "strip_leading_zeros": [
        "microseconds", 
        "milliseconds", 
        "seconds"
      ]
    }, 
    "id": "p56533", 
    "name": "DatetimeTickFormatter", 
    "type": "object"
  }, 
  "group": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p56517", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "guide", 
  "major_label_orientation": "horizontal", 
  "major_label_overrides": {
    "type": "map"
  }, 
  "major_label_policy": {
    "id": "p56534", 
    "name": "AllLabels", 
    "type": "object"
  }, 
  "major_label_standoff": 5, 
  "major_label_text_align": "center", 
  "major_label_text_alpha": 1.0, 
  "major_label_text_baseline": "alphabetic", 
  "major_label_text_color": "#444444", 
  "major_label_text_font": "helvetica", 
  "major_label_text_font_size": "11px", 
  "major_label_text_font_style": "normal", 
  "major_label_text_line_height": 1.2, 
  "major_label_text_outline_color": null, 
  "major_tick_in": 2, 
  "major_tick_line_alpha": 1.0, 
  "major_tick_line_cap": "butt", 
  "major_tick_line_color": "black", 
  "major_tick_line_dash": [], 
  "major_tick_line_dash_offset": 0, 
  "major_tick_line_join": "bevel", 
  "major_tick_line_width": 1, 
  "major_tick_out": 6, 
  "minor_tick_in": 0, 
  "minor_tick_line_alpha": 1.0, 
  "minor_tick_line_cap": "butt", 
  "minor_tick_line_color": "black", 
  "minor_tick_line_dash": [], 
  "minor_tick_line_dash_offset": 0, 
  "minor_tick_line_join": "bevel", 
  "minor_tick_line_width": 1, 
  "minor_tick_out": 4, 
  "name": null, 
  "propagate_hover": false, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "ticker": {
    "attributes": {
      "tickers": [
        {
          "attributes": {
            "mantissas": [
              1, 
              2, 
              5
            ], 
            "max_interval": 500.0, 
            "num_minor_ticks": 0
          }, 
          "id": "p56519", 
          "name": "AdaptiveTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "base": 60, 
            "mantissas": [
              1, 
              2, 
              5, 
              10, 
              15, 
              20, 
              30
            ], 
            "max_interval": 1800000.0, 
            "min_interval": 1000.0, 
            "num_minor_ticks": 0
          }, 
          "id": "p56520", 
          "name": "AdaptiveTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "base": 24, 
            "mantissas": [
              1, 
              2, 
              4, 
              6, 
              8, 
              12
            ], 
            "max_interval": 43200000.0, 
            "min_interval": 3600000.0, 
            "num_minor_ticks": 0
          }, 
          "id": "p56521", 
          "name": "AdaptiveTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "days": [
              1, 
              2, 
              3, 
              4, 
              5, 
              6, 
              7, 
              8, 
              9, 
              10, 
              11, 
              12, 
              13, 
              14, 
              15, 
              16, 
              17, 
              18, 
              19, 
              20, 
              21, 
              22, 
              23, 
              24, 
              25, 
              26, 
              27, 
              28, 
              29, 
              30, 
              31
            ]
          }, 
          "id": "p56522", 
          "name": "DaysTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "days": [
              1, 
              4, 
              7, 
              10, 
              13, 
              16, 
              19, 
              22, 
              25, 
              28
            ]
          }, 
          "id": "p56523", 
          "name": "DaysTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "days": [
              1, 
              8, 
              15, 
              22
            ]
          }, 
          "id": "p56524", 
          "name": "DaysTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "days": [
              1, 
              15
            ]
          }, 
          "id": "p56525", 
          "name": "DaysTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "months": [
              0, 
              1, 
              2, 
              3, 
              4, 
              5, 
              6, 
              7, 
              8, 
              9, 
              10, 
              11
            ]
          }, 
          "id": "p56526", 
          "name": "MonthsTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "months": [
              0, 
              2, 
              4, 
              6, 
              8, 
              10
            ]
          }, 
          "id": "p56527", 
          "name": "MonthsTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "months": [
              0, 
              4, 
              8
            ]
          }, 
          "id": "p56528", 
          "name": "MonthsTicker", 
          "type": "object"
        }, 
        {
          "attributes": {
            "months": [
              0, 
              6
            ]
          }, 
          "id": "p56529", 
          "name": "MonthsTicker", 
          "type": "object"
        }, 
        {
          "id": "p56530", 
          "name": "YearsTicker", 
          "type": "object"
        }
      ]
    }, 
    "id": "p56518", 
    "name": "DatetimeTicker", 
    "type": "object"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}
轴标签 = None#
类型:

Nullable(TextLike)

坐标轴的文本或 LaTeX 符号标签,与坐标轴规则平行显示。

轴标签对齐方式 = 'center'#
类型:

Enum(Align)

坐标轴标签沿坐标轴的对齐方式。

轴标签方向 = 'parallel'#
类型:

Either(Enum(LabelOrientation), Float)

坐标轴标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

轴标签偏移 = 5#
类型:

Int

坐标轴标签应从刻度标签偏移的像素距离。

轴标签文本对齐 = 'left'#
类型:

Enum(TextAlign)

坐标轴标签的文本对齐方式。

轴标签文本Alpha值 = 1.0#
类型:

Alpha

坐标轴标签的文本 Alpha 值。

轴标签文本基线 = 'bottom'#
类型:

Enum(TextBaseline)

坐标轴标签的文本基线。

轴标签文本颜色 = '#444444'#
类型:

Nullable(Color)

坐标轴标签的文本颜色。

轴标签文本字体 = 'helvetica'#
类型:

String

坐标轴标签的文本字体。

轴标签文本字体大小 = '13px'#
类型:

FontSize

坐标轴标签的文本字体大小。

轴标签文本字体样式 = 'italic'#
类型:

Enum(FontStyle)

坐标轴标签的文本字体样式。

轴标签文本行高 = 1.2#
类型:

Float

坐标轴标签的文本行高。

轴标签文本轮廓颜色 = None#
类型:

Nullable(Color)

坐标轴标签的文本轮廓颜色。

轴线Alpha值 = 1.0#
类型:

Alpha

坐标轴线的线条 Alpha 值。

轴线端帽 = 'butt'#
类型:

Enum(LineCap)

坐标轴线的线帽样式。

轴线颜色 = 'black'#
类型:

Nullable(Color)

坐标轴线的线条颜色。

轴线虚线 = []#
类型:

DashPattern

坐标轴线的线段虚线模式。

轴线虚线偏移 = 0#
类型:

Int

坐标轴线的线段虚线偏移量。

轴线连接 = 'bevel'#
类型:

Enum(LineJoin)

坐标轴线的线段连接样式。

轴线宽度 = 1#
类型:

Float

坐标轴线的线宽。

背景填充Alpha值 = 1.0#
类型:

Alpha

坐标轴背景的填充 Alpha 值。

背景填充颜色 = None#
类型:

Nullable(Color)

坐标轴背景的填充颜色。

背景阴影Alpha值 = 1.0#
类型:

Alpha

坐标轴背景的阴影线 Alpha 值。

背景阴影颜色 = 'black'#
类型:

Nullable(Color)

坐标轴背景的阴影线颜色。

背景阴影额外属性 = {}#
类型:

Dict(String, Instance(Texture))

坐标轴背景的额外阴影线属性。

背景阴影图案 = None#
类型:

Nullable(String)

坐标轴背景的阴影线图案。

背景阴影缩放 = 12.0#
类型:

Size

坐标轴背景的阴影线比例。

背景阴影粗细 = 1.0#
类型:

Size

坐标轴背景的阴影线粗细。

边界 = 'auto'#
类型:

Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime))

渲染坐标轴的边界。如果未设置,则坐标轴将在给定维度上跨越整个绘图。

上下文菜单 = None#
类型:

Nullable(Instance(‘.models.ui.Menu’))

用户右键单击组件时显示的菜单。

注意

右键单击时使用 Shift 键显示原生上下文菜单。

CSS类 = []#
类型:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

CSS变量 = {}#
类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如,这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

注意

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

维度 = 'auto'#
类型:

Either(Auto, Int)

这允许在支持此功能的上下文中覆盖推断的维度。当坐标轴用作框架坐标轴时,此属性无效。

注意

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

= 'auto'#
类型:

Either(Auto, Enum(Enumeration(front, back)))

坐标轴将面向的方向。

注意

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

固定位置 = None#
类型:

Either(Null, Float, Factor)

设置为指定绘制坐标轴的固定坐标位置。刻度和主标签的方向由坐标轴所属的侧面板决定。

注意

当坐标轴位于中心绘图区域内的固定位置时,坐标轴标签将被抑制。

格式化器 = DatetimeTickFormatter(id='p57185', ...)#
类型:

Instance(TickFormatter)

用于格式化刻度视觉外观的 TickFormatter

= None#
类型:

Nullable(RendererGroup))

注意

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

HTML属性 = {}#
类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

HTML ID = None#
类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者,可以在 html_attributes 字典中设置 idhtml_id 优先。

层级 = 'guide'#
类型:

Enum(RenderLevel)

指定绘制此渲染器的级别。

主标签方向 = 'horizontal'#
类型:

Either(Enum(LabelOrientation), Float)

主标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

主标签覆盖 = {}#
类型:

Dict(Either(Float, String), TextLike)

为特定刻度位置提供显式刻度标签值,以覆盖正常格式。

主标签策略 = AllLabels(id='p57312', ...)#
类型:

Instance(LabelingPolicy)

允许过滤掉标签,例如,清理标签以避免重叠。

主标签偏移 = 5#
类型:

Int

主刻度标签应从相关刻度偏移的像素距离。

主标签文本对齐 = 'center'#
类型:

Enum(TextAlign)

主刻度标签的文本对齐方式。

主标签文本Alpha值 = 1.0#
类型:

Alpha

主刻度标签的文本 Alpha 值。

主标签文本基线 = 'alphabetic'#
类型:

Enum(TextBaseline)

主刻度标签的文本基线。

主标签文本颜色 = '#444444'#
类型:

Nullable(Color)

主要刻度标签的文本颜色。

主标签文本字体 = 'helvetica'#
类型:

String

主要刻度标签的文本字体。

主标签文本字体大小 = '11px'#
类型:

FontSize

主要刻度标签的文本字体大小。

主标签文本字体样式 = 'normal'#
类型:

Enum(FontStyle)

主要刻度标签的文本字体样式。

主标签文本行高 = 1.2#
类型:

Float

主要刻度标签的文本行高。

主标签文本轮廓颜色 = None#
类型:

Nullable(Color)

主要刻度标签的文本轮廓颜色。

主刻度线向内长度 = 2#
类型:

Int

主要刻度线应延伸到主绘图区域的像素距离。

主刻度线Alpha值 = 1.0#
类型:

Alpha

主要刻度线的线条 alpha 值。

主刻度线端帽 = 'butt'#
类型:

Enum(LineCap)

主要刻度线的线帽样式。

主刻度线颜色 = 'black'#
类型:

Nullable(Color)

主要刻度线的线条颜色。

主刻度线虚线 = []#
类型:

DashPattern

主要刻度线的线条虚线模式。

主刻度线虚线偏移 = 0#
类型:

Int

主要刻度线的线条虚线偏移。

主刻度线连接 = 'bevel'#
类型:

Enum(LineJoin)

主要刻度线的线连接样式。

主刻度线宽度 = 1#
类型:

Float

主要刻度线的线条宽度。

主刻度线向外长度 = 6#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

次刻度线向内长度 = 0#
类型:

Int

次要刻度线应延伸到主绘图区域的像素距离。

次刻度线Alpha值 = 1.0#
类型:

Alpha

次要刻度线的线条 alpha 值。

次刻度线端帽 = 'butt'#
类型:

Enum(LineCap)

次要刻度线的线帽样式。

次刻度线颜色 = 'black'#
类型:

Nullable(Color)

次要刻度线的线条颜色。

次刻度线虚线 = []#
类型:

DashPattern

次要刻度线的线条虚线模式。

次刻度线虚线偏移 = 0#
类型:

Int

次要刻度线的线条虚线偏移。

次刻度线连接 = 'bevel'#
类型:

Enum(LineJoin)

次要刻度线的线连接样式。

次刻度线宽度 = 1#
类型:

Float

次要刻度线的线条宽度。

次刻度线向外长度 = 4#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

名称 = None#
类型:

Nullable(String)

此模型的可选的、用户提供的名称。

当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用该名称。

传递悬停 = False#
类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

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

样式 = {}#
类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

样式表 = []#
类型:

List

用于底层 DOM 元素的附加样式表。

请注意,所有 bokeh 的组件都使用 shadow DOM,因此任何包含的样式表都必须反映这一点,例如,使用 :host CSS 伪选择器来访问根 DOM 元素。

可同步 = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然有效。

标签 = []#
类型:

List

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

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

刻度生成器 = DatetimeTicker(id='p57943', ...)#
类型:

Instance(Ticker)

用于计算轴组件位置的 Ticker。

该属性也可以传递浮点数序列,作为创建和配置 FixedTicker 的简写,例如以下代码

from bokeh.plotting import figure

p = figure()
p.xaxis.ticker = [10, 20, 37.4]

等效于

from bokeh.plotting import figure
from bokeh.models import FixedTicker

p = figure()
p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
可见 = True#
类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)x 轴范围。如果未设置,则使用默认 x 轴范围。

y_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)y 轴范围。如果未设置,则使用默认 y 轴范围。

应用主题(property_values: dict[str, Any]) None#

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

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

参数:

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

返回:

None

类方法 清除扩展() None#

清除任何当前定义的自定义扩展。

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

克隆(**overrides: Any) Self#

复制 HasProps 对象。

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

类方法 dataspecs() dict[str, DataSpec]#

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

类方法 描述符() list[PropertyDescriptor[Any]]#

属性描述符列表,按定义顺序排列。

销毁() None#

清理对文档和属性的引用

相等(other: HasProps) bool#

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回:

如果属性在结构上相等,则为 True,否则为 False

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

这是一个便捷方法,可简化添加 CustomJS 回调,以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:
  • attr (str) – 此模型上 Bokeh 属性的名称

  • other (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)
类方法 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, 可选) – 是否包含自对象创建以来尚未显式设置的属性。(默认值:True)

返回:

从属性名称到其值的映射

返回类型:

dict

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, 可选) – 是否包含用户尚未显式设置的属性(默认值:True)

返回:

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

返回类型:

dict

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

返回:

Model

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

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

参数:
  • name (str) – 要设置的属性的名称

  • value (JSON-value) – 要设置为属性的值

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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#
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)

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

基类: ContinuousAxis

一个在线性刻度上选择合适数字作为刻度位置的轴。默认配置为 BasicTickFormatter

JSON 原型
{
  "axis_label": null, 
  "axis_label_align": "center", 
  "axis_label_orientation": "parallel", 
  "axis_label_standoff": 5, 
  "axis_label_text_align": "left", 
  "axis_label_text_alpha": 1.0, 
  "axis_label_text_baseline": "bottom", 
  "axis_label_text_color": "#444444", 
  "axis_label_text_font": "helvetica", 
  "axis_label_text_font_size": "13px", 
  "axis_label_text_font_style": "italic", 
  "axis_label_text_line_height": 1.2, 
  "axis_label_text_outline_color": null, 
  "axis_line_alpha": 1.0, 
  "axis_line_cap": "butt", 
  "axis_line_color": "black", 
  "axis_line_dash": [], 
  "axis_line_dash_offset": 0, 
  "axis_line_join": "bevel", 
  "axis_line_width": 1, 
  "background_fill_alpha": 1.0, 
  "background_fill_color": null, 
  "background_hatch_alpha": 1.0, 
  "background_hatch_color": "black", 
  "background_hatch_extra": {
    "type": "map"
  }, 
  "background_hatch_pattern": null, 
  "background_hatch_scale": 12.0, 
  "background_hatch_weight": 1.0, 
  "bounds": "auto", 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "dimension": "auto", 
  "face": "auto", 
  "fixed_location": null, 
  "formatter": {
    "id": "p58012", 
    "name": "BasicTickFormatter", 
    "type": "object"
  }, 
  "group": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p58010", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "guide", 
  "major_label_orientation": "horizontal", 
  "major_label_overrides": {
    "type": "map"
  }, 
  "major_label_policy": {
    "id": "p58013", 
    "name": "AllLabels", 
    "type": "object"
  }, 
  "major_label_standoff": 5, 
  "major_label_text_align": "center", 
  "major_label_text_alpha": 1.0, 
  "major_label_text_baseline": "alphabetic", 
  "major_label_text_color": "#444444", 
  "major_label_text_font": "helvetica", 
  "major_label_text_font_size": "11px", 
  "major_label_text_font_style": "normal", 
  "major_label_text_line_height": 1.2, 
  "major_label_text_outline_color": null, 
  "major_tick_in": 2, 
  "major_tick_line_alpha": 1.0, 
  "major_tick_line_cap": "butt", 
  "major_tick_line_color": "black", 
  "major_tick_line_dash": [], 
  "major_tick_line_dash_offset": 0, 
  "major_tick_line_join": "bevel", 
  "major_tick_line_width": 1, 
  "major_tick_out": 6, 
  "minor_tick_in": 0, 
  "minor_tick_line_alpha": 1.0, 
  "minor_tick_line_cap": "butt", 
  "minor_tick_line_color": "black", 
  "minor_tick_line_dash": [], 
  "minor_tick_line_dash_offset": 0, 
  "minor_tick_line_join": "bevel", 
  "minor_tick_line_width": 1, 
  "minor_tick_out": 4, 
  "name": null, 
  "propagate_hover": false, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "ticker": {
    "attributes": {
      "mantissas": [
        1, 
        2, 
        5
      ]
    }, 
    "id": "p58011", 
    "name": "BasicTicker", 
    "type": "object"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}
axis_label = None#
类型:

Nullable(TextLike)

坐标轴的文本或 LaTeX 符号标签,与坐标轴规则平行显示。

axis_label_align = 'center'#
类型:

Enum(Align)

坐标轴标签沿坐标轴的对齐方式。

axis_label_orientation = 'parallel'#
类型:

Either(Enum(LabelOrientation), Float)

坐标轴标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

axis_label_standoff = 5#
类型:

Int

坐标轴标签应从刻度标签偏移的像素距离。

axis_label_text_align = 'left'#
类型:

Enum(TextAlign)

坐标轴标签的文本对齐方式。

axis_label_text_alpha = 1.0#
类型:

Alpha

坐标轴标签的文本 Alpha 值。

axis_label_text_baseline = 'bottom'#
类型:

Enum(TextBaseline)

坐标轴标签的文本基线。

axis_label_text_color = '#444444'#
类型:

Nullable(Color)

坐标轴标签的文本颜色。

axis_label_text_font = 'helvetica'#
类型:

String

坐标轴标签的文本字体。

axis_label_text_font_size = '13px'#
类型:

FontSize

坐标轴标签的文本字体大小。

axis_label_text_font_style = 'italic'#
类型:

Enum(FontStyle)

坐标轴标签的文本字体样式。

axis_label_text_line_height = 1.2#
类型:

Float

坐标轴标签的文本行高。

axis_label_text_outline_color = None#
类型:

Nullable(Color)

坐标轴标签的文本轮廓颜色。

axis_line_alpha = 1.0#
类型:

Alpha

坐标轴线的线条 Alpha 值。

axis_line_cap = 'butt'#
类型:

Enum(LineCap)

坐标轴线的线帽样式。

axis_line_color = 'black'#
类型:

Nullable(Color)

坐标轴线的线条颜色。

axis_line_dash = []#
类型:

DashPattern

坐标轴线的线段虚线模式。

axis_line_dash_offset = 0#
类型:

Int

坐标轴线的线段虚线偏移量。

axis_line_join = 'bevel'#
类型:

Enum(LineJoin)

坐标轴线的线段连接样式。

axis_line_width = 1#
类型:

Float

坐标轴线的线宽。

background_fill_alpha = 1.0#
类型:

Alpha

坐标轴背景的填充 Alpha 值。

background_fill_color = None#
类型:

Nullable(Color)

坐标轴背景的填充颜色。

background_hatch_alpha = 1.0#
类型:

Alpha

坐标轴背景的阴影线 Alpha 值。

background_hatch_color = 'black'#
类型:

Nullable(Color)

坐标轴背景的阴影线颜色。

background_hatch_extra = {}#
类型:

Dict(String, Instance(Texture))

坐标轴背景的额外阴影线属性。

background_hatch_pattern = None#
类型:

Nullable(String)

坐标轴背景的阴影线图案。

background_hatch_scale = 12.0#
类型:

Size

坐标轴背景的阴影线比例。

background_hatch_weight = 1.0#
类型:

Size

坐标轴背景的阴影线粗细。

bounds = 'auto'#
类型:

Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime))

渲染坐标轴的边界。如果未设置,则坐标轴将在给定维度上跨越整个绘图。

context_menu = None#
类型:

Nullable(Instance(‘.models.ui.Menu’))

用户右键单击组件时显示的菜单。

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#
类型:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}#
类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如,这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

注意

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

dimension = 'auto'#
类型:

Either(Auto, Int)

这允许在支持此功能的上下文中覆盖推断的维度。当坐标轴用作框架坐标轴时,此属性无效。

注意

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

face = 'auto'#
类型:

Either(Auto, Enum(Enumeration(front, back)))

坐标轴将面向的方向。

注意

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

fixed_location = None#
类型:

Either(Null, Float, Factor)

设置为指定绘制坐标轴的固定坐标位置。刻度和主标签的方向由坐标轴所属的侧面板决定。

注意

当坐标轴位于中心绘图区域内的固定位置时,坐标轴标签将被抑制。

formatter = BasicTickFormatter(id='p58158', ...)#
类型:

Instance(TickFormatter)

用于格式化刻度视觉外观的 TickFormatter

group = None#
类型:

Nullable(RendererGroup))

注意

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

html_attributes = {}#
类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#
类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者,可以在 html_attributes 字典中设置 idhtml_id 优先。

level = 'guide'#
类型:

Enum(RenderLevel)

指定绘制此渲染器的级别。

major_label_orientation = 'horizontal'#
类型:

Either(Enum(LabelOrientation), Float)

主标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

major_label_overrides = {}#
类型:

Dict(Either(Float, String), TextLike)

为特定刻度位置提供显式刻度标签值,以覆盖正常格式。

major_label_policy = AllLabels(id='p58187', ...)#
类型:

Instance(LabelingPolicy)

允许过滤掉标签,例如,清理标签以避免重叠。

major_label_standoff = 5#
类型:

Int

主刻度标签应从相关刻度偏移的像素距离。

major_label_text_align = 'center'#
类型:

Enum(TextAlign)

主刻度标签的文本对齐方式。

major_label_text_alpha = 1.0#
类型:

Alpha

主刻度标签的文本 Alpha 值。

major_label_text_baseline = 'alphabetic'#
类型:

Enum(TextBaseline)

主刻度标签的文本基线。

major_label_text_color = '#444444'#
类型:

Nullable(Color)

主要刻度标签的文本颜色。

major_label_text_font = 'helvetica'#
类型:

String

主要刻度标签的文本字体。

major_label_text_font_size = '11px'#
类型:

FontSize

主要刻度标签的文本字体大小。

major_label_text_font_style = 'normal'#
类型:

Enum(FontStyle)

主要刻度标签的文本字体样式。

major_label_text_line_height = 1.2#
类型:

Float

主要刻度标签的文本行高。

major_label_text_outline_color = None#
类型:

Nullable(Color)

主要刻度标签的文本轮廓颜色。

major_tick_in = 2#
类型:

Int

主要刻度线应延伸到主绘图区域的像素距离。

major_tick_line_alpha = 1.0#
类型:

Alpha

主要刻度线的线条 alpha 值。

major_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

主要刻度线的线帽样式。

major_tick_line_color = 'black'#
类型:

Nullable(Color)

主要刻度线的线条颜色。

major_tick_line_dash = []#
类型:

DashPattern

主要刻度线的线条虚线模式。

major_tick_line_dash_offset = 0#
类型:

Int

主要刻度线的线条虚线偏移。

major_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

主要刻度线的线连接样式。

major_tick_line_width = 1#
类型:

Float

主要刻度线的线条宽度。

major_tick_out = 6#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

minor_tick_in = 0#
类型:

Int

次要刻度线应延伸到主绘图区域的像素距离。

minor_tick_line_alpha = 1.0#
类型:

Alpha

次要刻度线的线条 alpha 值。

minor_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

次要刻度线的线帽样式。

minor_tick_line_color = 'black'#
类型:

Nullable(Color)

次要刻度线的线条颜色。

minor_tick_line_dash = []#
类型:

DashPattern

次要刻度线的线条虚线模式。

minor_tick_line_dash_offset = 0#
类型:

Int

次要刻度线的线条虚线偏移。

minor_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

次要刻度线的线连接样式。

minor_tick_line_width = 1#
类型:

Float

次要刻度线的线条宽度。

minor_tick_out = 4#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

name = None#
类型:

Nullable(String)

此模型的可选的、用户提供的名称。

当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用该名称。

propagate_hover = False#
类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

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

styles = {}#
类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#
类型:

List

用于底层 DOM 元素的附加样式表。

请注意,所有 bokeh 的组件都使用 shadow DOM,因此任何包含的样式表都必须反映这一点,例如,使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然有效。

tags = []#
类型:

List

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

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

ticker = BasicTicker(id='p58328', ...)#
类型:

Instance(Ticker)

用于计算轴组件位置的 Ticker。

该属性也可以传递浮点数序列,作为创建和配置 FixedTicker 的简写,例如以下代码

from bokeh.plotting import figure

p = figure()
p.xaxis.ticker = [10, 20, 37.4]

等效于

from bokeh.plotting import figure
from bokeh.models import FixedTicker

p = figure()
p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
visible = True#
类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)x 轴范围。如果未设置,则使用默认 x 轴范围。

y_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)y 轴范围。如果未设置,则使用默认 y 轴范围。

应用主题(property_values: dict[str, Any]) None#

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

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

参数:

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

返回:

None

classmethod 清除扩展() None#

清除任何当前定义的自定义扩展。

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

克隆(**overrides: Any) Self#

复制 HasProps 对象。

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

classmethod 数据规格() dict[str, DataSpec]#

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

classmethod 描述符() list[PropertyDescriptor[Any]]#

属性描述符列表,按定义顺序排列。

销毁() None#

清理对文档和属性的引用

equals(other: HasProps) bool#

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回:

如果属性在结构上相等,则为 True,否则为 False

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

这是一个便捷方法,可简化添加 CustomJS 回调,以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:
  • attr (str) – 此模型上 Bokeh 属性的名称

  • other (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

参数:
  • 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]

classmethod properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str,
参数:

include_defaults (bool, 可选) – 是否包含自对象创建以来尚未显式设置的属性。(默认值:True)

返回:

从属性名称到其值的映射

返回类型:

dict

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, 可选) – 是否包含用户尚未显式设置的属性(默认值:True)

返回:

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

返回类型:

dict

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

返回:

Model

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

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

参数:
  • name (str) – 要设置的属性的名称

  • value (JSON-value) – 要设置为属性的值

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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#
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)

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

基类: ContinuousAxis

一个轴,用于在对数刻度上选择合适的刻度位置数字。默认情况下使用 LogTickFormatter 进行配置。

JSON 原型
{
  "axis_label": null, 
  "axis_label_align": "center", 
  "axis_label_orientation": "parallel", 
  "axis_label_standoff": 5, 
  "axis_label_text_align": "left", 
  "axis_label_text_alpha": 1.0, 
  "axis_label_text_baseline": "bottom", 
  "axis_label_text_color": "#444444", 
  "axis_label_text_font": "helvetica", 
  "axis_label_text_font_size": "13px", 
  "axis_label_text_font_style": "italic", 
  "axis_label_text_line_height": 1.2, 
  "axis_label_text_outline_color": null, 
  "axis_line_alpha": 1.0, 
  "axis_line_cap": "butt", 
  "axis_line_color": "black", 
  "axis_line_dash": [], 
  "axis_line_dash_offset": 0, 
  "axis_line_join": "bevel", 
  "axis_line_width": 1, 
  "background_fill_alpha": 1.0, 
  "background_fill_color": null, 
  "background_hatch_alpha": 1.0, 
  "background_hatch_color": "black", 
  "background_hatch_extra": {
    "type": "map"
  }, 
  "background_hatch_pattern": null, 
  "background_hatch_scale": 12.0, 
  "background_hatch_weight": 1.0, 
  "bounds": "auto", 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "dimension": "auto", 
  "face": "auto", 
  "fixed_location": null, 
  "formatter": {
    "id": "p58343", 
    "name": "LogTickFormatter", 
    "type": "object"
  }, 
  "group": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p58341", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "guide", 
  "major_label_orientation": "horizontal", 
  "major_label_overrides": {
    "type": "map"
  }, 
  "major_label_policy": {
    "id": "p58344", 
    "name": "AllLabels", 
    "type": "object"
  }, 
  "major_label_standoff": 5, 
  "major_label_text_align": "center", 
  "major_label_text_alpha": 1.0, 
  "major_label_text_baseline": "alphabetic", 
  "major_label_text_color": "#444444", 
  "major_label_text_font": "helvetica", 
  "major_label_text_font_size": "11px", 
  "major_label_text_font_style": "normal", 
  "major_label_text_line_height": 1.2, 
  "major_label_text_outline_color": null, 
  "major_tick_in": 2, 
  "major_tick_line_alpha": 1.0, 
  "major_tick_line_cap": "butt", 
  "major_tick_line_color": "black", 
  "major_tick_line_dash": [], 
  "major_tick_line_dash_offset": 0, 
  "major_tick_line_join": "bevel", 
  "major_tick_line_width": 1, 
  "major_tick_out": 6, 
  "minor_tick_in": 0, 
  "minor_tick_line_alpha": 1.0, 
  "minor_tick_line_cap": "butt", 
  "minor_tick_line_color": "black", 
  "minor_tick_line_dash": [], 
  "minor_tick_line_dash_offset": 0, 
  "minor_tick_line_join": "bevel", 
  "minor_tick_line_width": 1, 
  "minor_tick_out": 4, 
  "name": null, 
  "propagate_hover": false, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "ticker": {
    "attributes": {
      "mantissas": [
        1, 
        5
      ]
    }, 
    "id": "p58342", 
    "name": "LogTicker", 
    "type": "object"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}
axis_label = None#
类型:

Nullable(TextLike)

坐标轴的文本或 LaTeX 符号标签,与坐标轴规则平行显示。

axis_label_align = 'center'#
类型:

Enum(Align)

坐标轴标签沿坐标轴的对齐方式。

axis_label_orientation = 'parallel'#
类型:

Either(Enum(LabelOrientation), Float)

坐标轴标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

axis_label_standoff = 5#
类型:

Int

坐标轴标签应从刻度标签偏移的像素距离。

axis_label_text_align = 'left'#
类型:

Enum(TextAlign)

坐标轴标签的文本对齐方式。

axis_label_text_alpha = 1.0#
类型:

Alpha

坐标轴标签的文本 Alpha 值。

axis_label_text_baseline = 'bottom'#
类型:

Enum(TextBaseline)

坐标轴标签的文本基线。

axis_label_text_color = '#444444'#
类型:

Nullable(Color)

坐标轴标签的文本颜色。

axis_label_text_font = 'helvetica'#
类型:

String

坐标轴标签的文本字体。

axis_label_text_font_size = '13px'#
类型:

FontSize

坐标轴标签的文本字体大小。

axis_label_text_font_style = 'italic'#
类型:

Enum(FontStyle)

坐标轴标签的文本字体样式。

axis_label_text_line_height = 1.2#
类型:

Float

坐标轴标签的文本行高。

axis_label_text_outline_color = None#
类型:

Nullable(Color)

坐标轴标签的文本轮廓颜色。

axis_line_alpha = 1.0#
类型:

Alpha

坐标轴线的线条 Alpha 值。

axis_line_cap = 'butt'#
类型:

Enum(LineCap)

坐标轴线的线帽样式。

axis_line_color = 'black'#
类型:

Nullable(Color)

坐标轴线的线条颜色。

axis_line_dash = []#
类型:

DashPattern

坐标轴线的线段虚线模式。

axis_line_dash_offset = 0#
类型:

Int

坐标轴线的线段虚线偏移量。

axis_line_join = 'bevel'#
类型:

Enum(LineJoin)

坐标轴线的线段连接样式。

axis_line_width = 1#
类型:

Float

坐标轴线的线宽。

background_fill_alpha = 1.0#
类型:

Alpha

坐标轴背景的填充 Alpha 值。

background_fill_color = None#
类型:

Nullable(Color)

坐标轴背景的填充颜色。

background_hatch_alpha = 1.0#
类型:

Alpha

坐标轴背景的阴影线 Alpha 值。

background_hatch_color = 'black'#
类型:

Nullable(Color)

坐标轴背景的阴影线颜色。

background_hatch_extra = {}#
类型:

Dict(String, Instance(Texture))

坐标轴背景的额外阴影线属性。

background_hatch_pattern = None#
类型:

Nullable(String)

坐标轴背景的阴影线图案。

background_hatch_scale = 12.0#
类型:

Size

坐标轴背景的阴影线比例。

background_hatch_weight = 1.0#
类型:

Size

坐标轴背景的阴影线粗细。

bounds = 'auto'#
类型:

Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime))

渲染坐标轴的边界。如果未设置,则坐标轴将在给定维度上跨越整个绘图。

context_menu = None#
类型:

Nullable(Instance(‘.models.ui.Menu’))

用户右键单击组件时显示的菜单。

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#
类型:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}#
类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如,这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

注意

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

dimension = 'auto'#
类型:

Either(Auto, Int)

这允许在支持此功能的上下文中覆盖推断的维度。当坐标轴用作框架坐标轴时,此属性无效。

注意

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

face = 'auto'#
类型:

Either(Auto, Enum(Enumeration(front, back)))

坐标轴将面向的方向。

注意

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

fixed_location = None#
类型:

Either(Null, Float, Factor)

设置为指定绘制坐标轴的固定坐标位置。刻度和主标签的方向由坐标轴所属的侧面板决定。

注意

当坐标轴位于中心绘图区域内的固定位置时,坐标轴标签将被抑制。

formatter = LogTickFormatter(id='p58489', ...)#
类型:

Instance(TickFormatter)

用于格式化刻度视觉外观的 TickFormatter

group = None#
类型:

Nullable(RendererGroup))

注意

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

html_attributes = {}#
类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#
类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者,可以在 html_attributes 字典中设置 idhtml_id 优先。

level = 'guide'#
类型:

Enum(RenderLevel)

指定绘制此渲染器的级别。

major_label_orientation = 'horizontal'#
类型:

Either(Enum(LabelOrientation), Float)

主标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

major_label_overrides = {}#
类型:

Dict(Either(Float, String), TextLike)

为特定刻度位置提供显式刻度标签值,以覆盖正常格式。

major_label_policy = AllLabels(id='p58518', ...)#
类型:

Instance(LabelingPolicy)

允许过滤掉标签,例如,清理标签以避免重叠。

major_label_standoff = 5#
类型:

Int

主刻度标签应从相关刻度偏移的像素距离。

major_label_text_align = 'center'#
类型:

Enum(TextAlign)

主刻度标签的文本对齐方式。

major_label_text_alpha = 1.0#
类型:

Alpha

主刻度标签的文本 Alpha 值。

major_label_text_baseline = 'alphabetic'#
类型:

Enum(TextBaseline)

主刻度标签的文本基线。

major_label_text_color = '#444444'#
类型:

Nullable(Color)

主要刻度标签的文本颜色。

major_label_text_font = 'helvetica'#
类型:

String

主要刻度标签的文本字体。

major_label_text_font_size = '11px'#
类型:

FontSize

主要刻度标签的文本字体大小。

major_label_text_font_style = 'normal'#
类型:

Enum(FontStyle)

主要刻度标签的文本字体样式。

major_label_text_line_height = 1.2#
类型:

Float

主要刻度标签的文本行高。

major_label_text_outline_color = None#
类型:

Nullable(Color)

主要刻度标签的文本轮廓颜色。

major_tick_in = 2#
类型:

Int

主要刻度线应延伸到主绘图区域的像素距离。

major_tick_line_alpha = 1.0#
类型:

Alpha

主要刻度线的线条 alpha 值。

major_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

主要刻度线的线帽样式。

major_tick_line_color = 'black'#
类型:

Nullable(Color)

主要刻度线的线条颜色。

major_tick_line_dash = []#
类型:

DashPattern

主要刻度线的线条虚线模式。

major_tick_line_dash_offset = 0#
类型:

Int

主要刻度线的线条虚线偏移。

major_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

主要刻度线的线连接样式。

major_tick_line_width = 1#
类型:

Float

主要刻度线的线条宽度。

major_tick_out = 6#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

minor_tick_in = 0#
类型:

Int

次要刻度线应延伸到主绘图区域的像素距离。

minor_tick_line_alpha = 1.0#
类型:

Alpha

次要刻度线的线条 alpha 值。

minor_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

次要刻度线的线帽样式。

minor_tick_line_color = 'black'#
类型:

Nullable(Color)

次要刻度线的线条颜色。

minor_tick_line_dash = []#
类型:

DashPattern

次要刻度线的线条虚线模式。

minor_tick_line_dash_offset = 0#
类型:

Int

次要刻度线的线条虚线偏移。

minor_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

次要刻度线的线连接样式。

minor_tick_line_width = 1#
类型:

Float

次要刻度线的线条宽度。

minor_tick_out = 4#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

name = None#
类型:

Nullable(String)

此模型的可选的、用户提供的名称。

当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用该名称。

propagate_hover = False#
类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

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

styles = {}#
类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#
类型:

List

用于底层 DOM 元素的附加样式表。

请注意,所有 bokeh 的组件都使用 shadow DOM,因此任何包含的样式表都必须反映这一点,例如,使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然有效。

tags = []#
类型:

List

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

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

ticker = LogTicker(id='p58659', ...)#
类型:

Instance(Ticker)

用于计算轴组件位置的 Ticker。

该属性也可以传递浮点数序列,作为创建和配置 FixedTicker 的简写,例如以下代码

from bokeh.plotting import figure

p = figure()
p.xaxis.ticker = [10, 20, 37.4]

等效于

from bokeh.plotting import figure
from bokeh.models import FixedTicker

p = figure()
p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
visible = True#
类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)x 轴范围。如果未设置,则使用默认 x 轴范围。

y_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)y 轴范围。如果未设置,则使用默认 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

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

这是一个便捷方法,可简化添加 CustomJS 回调,以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:
  • attr (str) – 此模型上 Bokeh 属性的名称

  • other (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

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

返回:

从属性名称到其值的映射

返回类型:

dict

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, 可选) – 是否包含用户尚未显式设置的属性(默认值:True)

返回:

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

返回类型:

dict

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

返回:

Model

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

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

参数:
  • name (str) – 要设置的属性的名称

  • value (JSON-value) – 要设置为属性的值

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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#
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)

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

基类: LinearAxis

一个轴,用于在墨卡托坐标系上选择合适的刻度位置数字。默认情况下使用 MercatorTickFormatter 进行配置。

参数:

dimension ('lat''lon', 可选) – 此轴将显示纬度值还是经度值。(默认: ‘lat’)

JSON 原型
{
  "axis_label": null, 
  "axis_label_align": "center", 
  "axis_label_orientation": "parallel", 
  "axis_label_standoff": 5, 
  "axis_label_text_align": "left", 
  "axis_label_text_alpha": 1.0, 
  "axis_label_text_baseline": "bottom", 
  "axis_label_text_color": "#444444", 
  "axis_label_text_font": "helvetica", 
  "axis_label_text_font_size": "13px", 
  "axis_label_text_font_style": "italic", 
  "axis_label_text_line_height": 1.2, 
  "axis_label_text_outline_color": null, 
  "axis_line_alpha": 1.0, 
  "axis_line_cap": "butt", 
  "axis_line_color": "black", 
  "axis_line_dash": [], 
  "axis_line_dash_offset": 0, 
  "axis_line_join": "bevel", 
  "axis_line_width": 1, 
  "background_fill_alpha": 1.0, 
  "background_fill_color": null, 
  "background_hatch_alpha": 1.0, 
  "background_hatch_color": "black", 
  "background_hatch_extra": {
    "type": "map"
  }, 
  "background_hatch_pattern": null, 
  "background_hatch_scale": 12.0, 
  "background_hatch_weight": 1.0, 
  "bounds": "auto", 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "dimension": "auto", 
  "face": "auto", 
  "fixed_location": null, 
  "formatter": {
    "attributes": {
      "dimension": "lat"
    }, 
    "id": "p58674", 
    "name": "MercatorTickFormatter", 
    "type": "object"
  }, 
  "group": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p58672", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "guide", 
  "major_label_orientation": "horizontal", 
  "major_label_overrides": {
    "type": "map"
  }, 
  "major_label_policy": {
    "id": "p58675", 
    "name": "AllLabels", 
    "type": "object"
  }, 
  "major_label_standoff": 5, 
  "major_label_text_align": "center", 
  "major_label_text_alpha": 1.0, 
  "major_label_text_baseline": "alphabetic", 
  "major_label_text_color": "#444444", 
  "major_label_text_font": "helvetica", 
  "major_label_text_font_size": "11px", 
  "major_label_text_font_style": "normal", 
  "major_label_text_line_height": 1.2, 
  "major_label_text_outline_color": null, 
  "major_tick_in": 2, 
  "major_tick_line_alpha": 1.0, 
  "major_tick_line_cap": "butt", 
  "major_tick_line_color": "black", 
  "major_tick_line_dash": [], 
  "major_tick_line_dash_offset": 0, 
  "major_tick_line_join": "bevel", 
  "major_tick_line_width": 1, 
  "major_tick_out": 6, 
  "minor_tick_in": 0, 
  "minor_tick_line_alpha": 1.0, 
  "minor_tick_line_cap": "butt", 
  "minor_tick_line_color": "black", 
  "minor_tick_line_dash": [], 
  "minor_tick_line_dash_offset": 0, 
  "minor_tick_line_join": "bevel", 
  "minor_tick_line_width": 1, 
  "minor_tick_out": 4, 
  "name": null, 
  "propagate_hover": false, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "ticker": {
    "attributes": {
      "dimension": "lat", 
      "mantissas": [
        1, 
        2, 
        5
      ]
    }, 
    "id": "p58673", 
    "name": "MercatorTicker", 
    "type": "object"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}
axis_label = None#
类型:

Nullable(TextLike)

坐标轴的文本或 LaTeX 符号标签,与坐标轴规则平行显示。

axis_label_align = 'center'#
类型:

Enum(Align)

坐标轴标签沿坐标轴的对齐方式。

axis_label_orientation = 'parallel'#
类型:

Either(Enum(LabelOrientation), Float)

坐标轴标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

axis_label_standoff = 5#
类型:

Int

坐标轴标签应从刻度标签偏移的像素距离。

axis_label_text_align = 'left'#
类型:

Enum(TextAlign)

坐标轴标签的文本对齐方式。

axis_label_text_alpha = 1.0#
类型:

Alpha

坐标轴标签的文本 Alpha 值。

axis_label_text_baseline = 'bottom'#
类型:

Enum(TextBaseline)

坐标轴标签的文本基线。

axis_label_text_color = '#444444'#
类型:

Nullable(Color)

坐标轴标签的文本颜色。

axis_label_text_font = 'helvetica'#
类型:

String

坐标轴标签的文本字体。

axis_label_text_font_size = '13px'#
类型:

FontSize

坐标轴标签的文本字体大小。

axis_label_text_font_style = 'italic'#
类型:

Enum(FontStyle)

坐标轴标签的文本字体样式。

axis_label_text_line_height = 1.2#
类型:

Float

坐标轴标签的文本行高。

axis_label_text_outline_color = None#
类型:

Nullable(Color)

坐标轴标签的文本轮廓颜色。

axis_line_alpha = 1.0#
类型:

Alpha

坐标轴线的线条 Alpha 值。

axis_line_cap = 'butt'#
类型:

Enum(LineCap)

坐标轴线的线帽样式。

axis_line_color = 'black'#
类型:

Nullable(Color)

坐标轴线的线条颜色。

axis_line_dash = []#
类型:

DashPattern

坐标轴线的线段虚线模式。

axis_line_dash_offset = 0#
类型:

Int

坐标轴线的线段虚线偏移量。

axis_line_join = 'bevel'#
类型:

Enum(LineJoin)

坐标轴线的线段连接样式。

axis_line_width = 1#
类型:

Float

坐标轴线的线宽。

background_fill_alpha = 1.0#
类型:

Alpha

坐标轴背景的填充 Alpha 值。

background_fill_color = None#
类型:

Nullable(Color)

坐标轴背景的填充颜色。

background_hatch_alpha = 1.0#
类型:

Alpha

坐标轴背景的阴影线 Alpha 值。

background_hatch_color = 'black'#
类型:

Nullable(Color)

坐标轴背景的阴影线颜色。

background_hatch_extra = {}#
类型:

Dict(String, Instance(Texture))

坐标轴背景的额外阴影线属性。

background_hatch_pattern = None#
类型:

Nullable(String)

坐标轴背景的阴影线图案。

background_hatch_scale = 12.0#
类型:

Size

坐标轴背景的阴影线比例。

background_hatch_weight = 1.0#
类型:

Size

坐标轴背景的阴影线粗细。

bounds = 'auto'#
类型:

Either(Auto, Tuple(Float, Float), Tuple(Datetime, Datetime))

渲染坐标轴的边界。如果未设置,则坐标轴将在给定维度上跨越整个绘图。

context_menu = None#
类型:

Nullable(Instance(‘.models.ui.Menu’))

用户右键单击组件时显示的菜单。

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#
类型:

List

要添加到底层 DOM 元素的其他 CSS 类列表。

css_variables = {}#
类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如,这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表中的 :host { ... } 下设置相同的变量。

注意

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

dimension = 'auto'#
类型:

Either(Auto, Int)

这允许在支持此功能的上下文中覆盖推断的维度。当坐标轴用作框架坐标轴时,此属性无效。

注意

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

face = 'auto'#
类型:

Either(Auto, Enum(Enumeration(front, back)))

坐标轴将面向的方向。

注意

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

fixed_location = None#
类型:

Either(Null, Float, Factor)

设置为指定绘制坐标轴的固定坐标位置。刻度和主标签的方向由坐标轴所属的侧面板决定。

注意

当坐标轴位于中心绘图区域内的固定位置时,坐标轴标签将被抑制。

formatter = MercatorTickFormatter(id='p58820', ...)#
类型:

Instance(TickFormatter)

用于格式化刻度视觉外观的 TickFormatter

group = None#
类型:

Nullable(RendererGroup))

注意

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

html_attributes = {}#
类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#
类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者,可以在 html_attributes 字典中设置 idhtml_id 优先。

level = 'guide'#
类型:

Enum(RenderLevel)

指定绘制此渲染器的级别。

major_label_orientation = 'horizontal'#
类型:

Either(Enum(LabelOrientation), Float)

主标签文本应朝向哪个方向。如果提供数字,则文本的角度是从水平方向测量的。

major_label_overrides = {}#
类型:

Dict(Either(Float, String), TextLike)

为特定刻度位置提供显式刻度标签值,以覆盖正常格式。

major_label_policy = AllLabels(id='p58849', ...)#
类型:

Instance(LabelingPolicy)

允许过滤掉标签,例如,清理标签以避免重叠。

major_label_standoff = 5#
类型:

Int

主刻度标签应从相关刻度偏移的像素距离。

major_label_text_align = 'center'#
类型:

Enum(TextAlign)

主刻度标签的文本对齐方式。

major_label_text_alpha = 1.0#
类型:

Alpha

主刻度标签的文本 Alpha 值。

major_label_text_baseline = 'alphabetic'#
类型:

Enum(TextBaseline)

主刻度标签的文本基线。

major_label_text_color = '#444444'#
类型:

Nullable(Color)

主要刻度标签的文本颜色。

major_label_text_font = 'helvetica'#
类型:

String

主要刻度标签的文本字体。

major_label_text_font_size = '11px'#
类型:

FontSize

主要刻度标签的文本字体大小。

major_label_text_font_style = 'normal'#
类型:

Enum(FontStyle)

主要刻度标签的文本字体样式。

major_label_text_line_height = 1.2#
类型:

Float

主要刻度标签的文本行高。

major_label_text_outline_color = None#
类型:

Nullable(Color)

主要刻度标签的文本轮廓颜色。

major_tick_in = 2#
类型:

Int

主要刻度线应延伸到主绘图区域的像素距离。

major_tick_line_alpha = 1.0#
类型:

Alpha

主要刻度线的线条 alpha 值。

major_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

主要刻度线的线帽样式。

major_tick_line_color = 'black'#
类型:

Nullable(Color)

主要刻度线的线条颜色。

major_tick_line_dash = []#
类型:

DashPattern

主要刻度线的线条虚线模式。

major_tick_line_dash_offset = 0#
类型:

Int

主要刻度线的线条虚线偏移。

major_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

主要刻度线的线连接样式。

major_tick_line_width = 1#
类型:

Float

主要刻度线的线条宽度。

major_tick_out = 6#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

minor_tick_in = 0#
类型:

Int

次要刻度线应延伸到主绘图区域的像素距离。

minor_tick_line_alpha = 1.0#
类型:

Alpha

次要刻度线的线条 alpha 值。

minor_tick_line_cap = 'butt'#
类型:

Enum(LineCap)

次要刻度线的线帽样式。

minor_tick_line_color = 'black'#
类型:

Nullable(Color)

次要刻度线的线条颜色。

minor_tick_line_dash = []#
类型:

DashPattern

次要刻度线的线条虚线模式。

minor_tick_line_dash_offset = 0#
类型:

Int

次要刻度线的线条虚线偏移。

minor_tick_line_join = 'bevel'#
类型:

Enum(LineJoin)

次要刻度线的线连接样式。

minor_tick_line_width = 1#
类型:

Float

次要刻度线的线条宽度。

minor_tick_out = 4#
类型:

Int

主要刻度线应延伸到主绘图区域之外的像素距离。

name = None#
类型:

Nullable(String)

此模型的可选的、用户提供的名称。

当查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称,不强制执行唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用该名称。

propagate_hover = False#
类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

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

styles = {}#
类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#
类型:

List

用于底层 DOM 元素的附加样式表。

请注意,所有 bokeh 的组件都使用 shadow DOM,因此任何包含的样式表都必须反映这一点,例如,使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然有效。

tags = []#
类型:

List

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

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

ticker = MercatorTicker(id='p58990', ...)#
类型:

Instance(Ticker)

用于计算轴组件位置的 Ticker。

该属性也可以传递浮点数序列,作为创建和配置 FixedTicker 的简写,例如以下代码

from bokeh.plotting import figure

p = figure()
p.xaxis.ticker = [10, 20, 37.4]

等效于

from bokeh.plotting import figure
from bokeh.models import FixedTicker

p = figure()
p.xaxis.ticker = FixedTicker(ticks=[10, 20, 37.4])
visible = True#
类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)x 轴范围。如果未设置,则使用默认 x 轴范围。

y_range_name = 'default'#
类型:

String

用于在绘图上渲染字形时计算屏幕位置的特定(命名)y 轴范围。如果未设置,则使用默认 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

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

这是一个便捷方法,可简化添加 CustomJS 回调,以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:
  • attr (str) – 此模型上 Bokeh 属性的名称

  • other (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

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

返回:

从属性名称到其值的映射

返回类型:

dict

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, 可选) – 是否包含用户尚未显式设置的属性(默认值:True)

返回:

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

返回类型:

dict

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

返回:

Model

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

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

参数:
  • name (str) – 要设置的属性的名称

  • value (JSON-value) – 要设置为属性的值

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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#
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)