轴#
各种类型的轴的指南渲染器,可以添加到 Bokeh 图表中
- class Axis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
-
一个定义所有轴类型共同属性的基类。
注意
这是一个用于帮助组织 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, "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, "id": "p54292", "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": "p54293", "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_orientation = 'parallel'#
- 类型:
轴标签文本的方向。如果提供一个数字,则文本的角度从水平方向测量。
- axis_label_text_baseline = 'bottom'#
- 类型:
轴标签的文本基线。
- axis_line_dash = []#
- 类型:
轴线虚线。
- bounds = 'auto'#
-
渲染轴的边界。如果未设置,则轴将跨越给定维度上的整个绘图。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如,这可用于在画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。
此处定义的变量等效于在 CSS 样式表中
:host { ... }
下设置相同的变量。注意
此属性为实验性,可能随时更改。
- fixed_location = None#
-
设置为指定绘制轴的固定坐标位置。刻度和主标签的方向由轴所属的侧面板决定。
注意
当轴位于中央绘图区域内的固定位置时,轴标签将被抑制。
- formatter = Undefined#
- 类型:
用于格式化刻度视觉外观的
TickFormatter
。
- group = None#
- 类型:
注意
此属性为实验性,可能随时更改。
- level = 'guide'#
- 类型:
指定绘制此渲染器的级别。
- major_label_orientation = 'horizontal'#
- 类型:
主标签文本的方向。如果提供数字,则文本的角度从水平方向测量。
- major_label_text_baseline = 'alphabetic'#
- 类型:
主要刻度标签的文本基线。
- major_tick_line_dash = []#
- 类型:
主要刻度线的线型。
- minor_tick_line_dash = []#
- 类型:
次要刻度线的线型。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称很有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
不保证提供的任何名称的唯一性或其他条件,并且 Bokeh 不会直接出于任何原因使用该名称。
- stylesheets = []#
- 类型:
要用于底层 DOM 元素的额外样式表。
请注意,所有 Bokeh 组件都使用阴影 DOM,因此任何包含的样式表都必须反映这一点,例如使用
:host
CSS 伪选择器来访问根 DOM 元素。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False
可能有助于在处理经常更新的对象时减少网络流量,这些对象的更新值我们不需要。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供值的列表,用于附加到此模型。
当查询文档以检索特定的 Bokeh 模型时,此数据可能会有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到模型的一种便捷方法,这些元数据可以通过
CustomJS
回调等访问。注意
不会对提供的任何标签实施唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。
- ticker = Undefined#
-
用于计算轴组件位置的刻度器。
该属性也可以传递一个浮点数序列作为创建和配置
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])
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些值将用于代替默认值,但不会覆盖应用程序设置的值。
传递的字典可以保留原样并与其他实例共享以节省内存(因此调用者或
HasProps
实例都不应该修改它)。- 参数:
property_values (dict) – 要代替默认值使用的主题值
- 返回:
None
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序排列的属性描述符列表。
- equals(other: HasProps) bool #
模型的结构相等。
- 参数:
other (HasProps) – 要比较的另一个实例
- 返回:
True,如果属性在结构上相等,否则为 False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
使用 JavaScript 链接两个 Bokeh 模型属性。
这是一种简化方法,它简化了添加
CustomJS
回调以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。- 参数:
在版本 1.1 中添加
- 引发:
示例
使用
js_link
的此代码select.js_link('value', plot, 'sizing_mode')
等效于以下内容
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
此外,要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
这等效于
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
- js_on_change(event: str, *callbacks: JSChangeCallback) None #
将
CustomJS
回调附加到任意 BokehJS 模型事件。在 BokehJS 端,模型属性的更改事件格式为
"change:property_name"
。为了方便起见,如果传递给此方法的事件名称也是模型上属性的名称,则它将自动以"change:"
为前缀# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
但是,除了属性更改事件外,还有其他一些事件可能对响应有用。例如,要运行一个回调,以便每当数据流到
ColumnDataSource
时运行,请在源上使用"stream"
事件source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
在类中查找 Bokeh 属性的
PropertyDescriptor
,给出属性名称。- 参数:
- 返回:
名为
name
的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None #
在该对象上添加一个回调,以触发
attr
更改时。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
当该模型上发生指定的事件时运行回调。
并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息,请参阅 bokeh.events 中的特定事件。
- classmethod 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]] #
收集此类上所有具有引用的属性的名称。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集一个字典,将属性名称映射到它们的值。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
不可序列化的属性被跳过,属性值采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[Model] #
查询此对象及其所有引用以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用以查找与给定选择器匹配的对象。如果找到多个对象,则会引发错误。返回单个匹配对象,如果没有找到,则返回 None :param selector: :type selector: JSON-like
- 返回:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象的属性值。
- 参数:
name – (str) : 要设置的属性的名称
json – (JSON-value) : 要设置为属性的值
models (dict or None, optional) –
模型 ID 到模型的映射(默认值:None)
这在要更新的属性的值也包含引用的情况下是必要的。
setter (ClientSession or ServerSession or None, optional) –
这用于防止“回旋镖”更新到 Bokeh 应用程序。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与自身进行比较,并抑制来自自身的任何更新。
- 返回:
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 #
- class CategoricalAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "id": "p54443", "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, "id": "p54441", "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": "p54444", "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": "p54442", "name": "CategoricalTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label_orientation = 'parallel'#
- 类型:
轴标签文本的方向。如果提供一个数字,则文本的角度从水平方向测量。
- axis_label_text_baseline = 'bottom'#
- 类型:
轴标签的文本基线。
- axis_line_dash = []#
- 类型:
轴线虚线。
- bounds = 'auto'#
-
渲染轴的边界。如果未设置,则轴将跨越给定维度上的整个绘图。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如,这可用于在画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。
此处定义的变量等效于在 CSS 样式表中
:host { ... }
下设置相同的变量。注意
此属性为实验性,可能随时更改。
- fixed_location = None#
-
设置为指定绘制轴的固定坐标位置。刻度和主标签的方向由轴所属的侧面板决定。
注意
当轴位于中央绘图区域内的固定位置时,轴标签将被抑制。
- formatter = CategoricalTickFormatter(id='p54565', ...)#
- 类型:
用于格式化刻度视觉外观的
TickFormatter
。
- group = None#
- 类型:
注意
此属性为实验性,可能随时更改。
- group_label_orientation = 'parallel'#
- 类型:
组标签文本应朝向的方向。
如果提供数字,则文本的角度是从水平方向测量的。
此属性始终适用于最外层嵌套级别的因子。如果分类因子列表是平面的(即没有嵌套),则此属性无效。
- group_text_align = 'left'#
-
分组类别标签的文本对齐方式。
此属性始终适用于最外层嵌套级别的因子。如果分类因子列表是平面的(即没有嵌套),则此属性无效。
- group_text_baseline = 'bottom'#
- 类型:
分组类别标签的文本基线。
此属性始终适用于最外层嵌套级别的因子。如果分类因子列表是平面的(即没有嵌套),则此属性无效。
- group_text_color = 'grey'#
-
分组类别标签的文本颜色。
此属性始终适用于最外层嵌套级别的因子。如果分类因子列表是平面的(即没有嵌套),则此属性无效。
- group_text_font = 'helvetica'#
- 类型:
分组类别标签的文本字体。
此属性始终适用于最外层嵌套级别的因子。如果分类因子列表是平面的(即没有嵌套),则此属性无效。
- group_text_font_size = '11px'#
- 类型:
分组类别标签的文本字号。
此属性始终适用于最外层嵌套级别的因子。如果分类因子列表是平面的(即没有嵌套),则此属性无效。
- group_text_font_style = 'bold'#
-
分组类别标签的文本字体样式。
此属性始终适用于最外层嵌套级别的因子。如果分类因子列表是平面的(即没有嵌套),则此属性无效。
- group_text_outline_color = None#
-
分组类别标签的文本轮廓颜色。
此属性始终适用于最外层嵌套级别的因子。如果分类因子列表是平面的(即没有嵌套),则此属性无效。
- level = 'guide'#
- 类型:
指定绘制此渲染器的级别。
- major_label_orientation = 'horizontal'#
- 类型:
主标签文本的方向。如果提供数字,则文本的角度从水平方向测量。
- major_label_text_baseline = 'alphabetic'#
- 类型:
主要刻度标签的文本基线。
- major_tick_line_dash = []#
- 类型:
主要刻度线的线型。
- minor_tick_line_dash = []#
- 类型:
次要刻度线的线型。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称很有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
不保证提供的任何名称的唯一性或其他条件,并且 Bokeh 不会直接出于任何原因使用该名称。
- separator_line_dash = []#
- 类型:
顶级类别分组之间分隔线的虚线样式。
此属性始终适用于最外层嵌套中的因子。
- stylesheets = []#
- 类型:
要用于底层 DOM 元素的额外样式表。
请注意,所有 Bokeh 组件都使用阴影 DOM,因此任何包含的样式表都必须反映这一点,例如使用
:host
CSS 伪选择器来访问根 DOM 元素。
- 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 = None#
-
子组分类标签的文本轮廓颜色。
此属性始终适用于嵌套中间级别的因子。如果分类因子的列表只有零或一个嵌套级别,那么此属性将不起作用。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False
可能有助于在处理经常更新的对象时减少网络流量,这些对象的更新值我们不需要。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供值的列表,用于附加到此模型。
当查询文档以检索特定的 Bokeh 模型时,此数据可能会有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到模型的一种便捷方法,这些元数据可以通过
CustomJS
回调等访问。注意
不会对提供的任何标签实施唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。
- ticker = CategoricalTicker(id='p54835', ...)#
-
用于计算轴组件位置的刻度器。
该属性也可以传递一个浮点数序列作为创建和配置
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])
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些值将用于代替默认值,但不会覆盖应用程序设置的值。
传递的字典可以保留原样并与其他实例共享以节省内存(因此调用者或
HasProps
实例都不应该修改它)。- 参数:
property_values (dict) – 要代替默认值使用的主题值
- 返回:
None
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序排列的属性描述符列表。
- equals(other: HasProps) bool #
模型的结构相等。
- 参数:
other (HasProps) – 要比较的另一个实例
- 返回:
True,如果属性在结构上相等,否则为 False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
使用 JavaScript 链接两个 Bokeh 模型属性。
这是一种简化方法,它简化了添加
CustomJS
回调以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。- 参数:
在版本 1.1 中添加
- 引发:
示例
使用
js_link
的此代码select.js_link('value', plot, 'sizing_mode')
等效于以下内容
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
此外,要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
这等效于
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
- js_on_change(event: str, *callbacks: JSChangeCallback) None #
将
CustomJS
回调附加到任意 BokehJS 模型事件。在 BokehJS 端,模型属性的更改事件格式为
"change:property_name"
。为了方便起见,如果传递给此方法的事件名称也是模型上属性的名称,则它将自动以"change:"
为前缀# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
但是,除了属性更改事件外,还有其他一些事件可能对响应有用。例如,要运行一个回调,以便每当数据流到
ColumnDataSource
时运行,请在源上使用"stream"
事件source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
在类中查找 Bokeh 属性的
PropertyDescriptor
,给出属性名称。- 参数:
- 返回:
名为
name
的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None #
在该对象上添加一个回调,以触发
attr
更改时。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
当该模型上发生指定的事件时运行回调。
并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息,请参阅 bokeh.events 中的特定事件。
- classmethod 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]] #
收集此类上所有具有引用的属性的名称。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: <
收集一个字典,将属性名称映射到它们的值。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
不可序列化的属性被跳过,属性值采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[Model] #
查询此对象及其所有引用以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用以查找与给定选择器匹配的对象。如果找到多个对象,则会引发错误。返回单个匹配对象,如果没有找到,则返回 None :param selector: :type selector: JSON-like
- 返回:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象的属性值。
- 参数:
name – (str) : 要设置的属性的名称
json – (JSON-value) : 要设置为属性的值
models (dict or None, optional) –
模型 ID 到模型的映射(默认值:None)
这在要更新的属性的值也包含引用的情况下是必要的。
setter (ClientSession or ServerSession or None, optional) –
这用于防止“回旋镖”更新到 Bokeh 应用程序。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与自身进行比较,并抑制来自自身的任何更新。
- 返回:
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 #
- class ContinuousAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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, "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, "id": "p54848", "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": "p54849", "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_orientation = 'parallel'#
- 类型:
轴标签文本的方向。如果提供一个数字,则文本的角度从水平方向测量。
- axis_label_text_baseline = 'bottom'#
- 类型:
轴标签的文本基线。
- axis_line_dash = []#
- 类型:
轴线虚线。
- bounds = 'auto'#
-
渲染轴的边界。如果未设置,则轴将跨越给定维度上的整个绘图。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如,这可用于在画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。
此处定义的变量等效于在 CSS 样式表中
:host { ... }
下设置相同的变量。注意
此属性为实验性,可能随时更改。
- fixed_location = None#
-
设置为指定绘制轴的固定坐标位置。刻度和主标签的方向由轴所属的侧面板决定。
注意
当轴位于中央绘图区域内的固定位置时,轴标签将被抑制。
- formatter = Undefined#
- 类型:
用于格式化刻度视觉外观的
TickFormatter
。
- group = None#
- 类型:
注意
此属性为实验性,可能随时更改。
- level = 'guide'#
- 类型:
指定绘制此渲染器的级别。
- major_label_orientation = 'horizontal'#
- 类型:
主标签文本的方向。如果提供数字,则文本的角度从水平方向测量。
- major_label_text_baseline = 'alphabetic'#
- 类型:
主要刻度标签的文本基线。
主要刻度标签的文本轮廓颜色。
- major_tick_line_dash = []#
- 类型:
主要刻度线的线型。
- minor_tick_line_dash = []#
- 类型:
次要刻度线的线型。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称很有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
不保证提供的任何名称的唯一性或其他条件,并且 Bokeh 不会直接出于任何原因使用该名称。
- stylesheets = []#
- 类型:
要用于底层 DOM 元素的额外样式表。
请注意,所有 Bokeh 组件都使用阴影 DOM,因此任何包含的样式表都必须反映这一点,例如使用
:host
CSS 伪选择器来访问根 DOM 元素。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False
可能有助于在处理经常更新的对象时减少网络流量,这些对象的更新值我们不需要。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供值的列表,用于附加到此模型。
当查询文档以检索特定的 Bokeh 模型时,此数据可能会有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到模型的一种便捷方法,这些元数据可以通过
CustomJS
回调等访问。注意
不会对提供的任何标签实施唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。
- ticker = Undefined#
-
用于计算轴组件位置的刻度器。
该属性也可以传递一个浮点数序列作为创建和配置
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])
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些值将用于代替默认值,但不会覆盖应用程序设置的值。
传递的字典可以保留原样并与其他实例共享以节省内存(因此调用者或
HasProps
实例都不应该修改它)。- 参数:
property_values (dict) – 要代替默认值使用的主题值
- 返回:
None
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序排列的属性描述符列表。
- equals(other: HasProps) bool #
模型的结构相等。
- 参数:
other (HasProps) – 要比较的另一个实例
- 返回:
True,如果属性在结构上相等,否则为 False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
使用 JavaScript 链接两个 Bokeh 模型属性。
这是一种简化方法,它简化了添加
CustomJS
回调以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。- 参数:
在版本 1.1 中添加
- 引发:
示例
使用
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:
将
CustomJS
回调附加到任意 BokehJS 模型事件。在 BokehJS 端,模型属性的更改事件格式为
"change:property_name"
。为了方便起见,如果传递给此方法的事件名称也是模型上属性的名称,则它将自动以"change:"
为前缀# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
但是,除了属性更改事件外,还有其他一些事件可能对响应有用。例如,要运行一个回调,以便每当数据流到
ColumnDataSource
时运行,请在源上使用"stream"
事件source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
在类中查找 Bokeh 属性的
PropertyDescriptor
,给出属性名称。- 参数:
- 返回:
名为
name
的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None #
在该对象上添加一个回调,以触发
attr
更改时。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
当该模型上发生指定的事件时运行回调。
并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息,请参阅 bokeh.events 中的特定事件。
- classmethod 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]] #
收集此类上所有具有引用的属性的名称。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集一个字典,将属性名称映射到它们的值。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
不可序列化的属性被跳过,属性值采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- remove_on_change(attr: str, *<
从此对象中删除回调
- 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) : 要设置的属性的名称
json – (JSON-value) : 要设置为属性的值
models (dict or None, optional) –
模型 ID 到模型的映射(默认值:None)
这在要更新的属性的值也包含引用的情况下是必要的。
setter (ClientSession or ServerSession or None, optional) –
这用于防止“回旋镖”更新到 Bokeh 应用程序。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与自身进行比较,并抑制来自自身的任何更新。
- 返回:
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 #
- 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)
- class DatetimeAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "id": "p55011", "name": "DatetimeTickFormatter", "type": "object" }, "group": null, "id": "p54997", "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": "p55012", "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": "p54999", "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": "p55000", "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": "p55001", "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": "p55002", "name": "DaysTicker", "type": "object" }, { "attributes": { "days": [ 1, 4, 7, 10, 13, 16, 19, 22, 25, 28 ] }, "id": "p55003", "name": "DaysTicker", "type": "object" }, { "attributes": { "days": [ 1, 8, 15, 22 ] }, "id": "p55004", "name": "DaysTicker", "type": "object" }, { "attributes": { "days": [ 1, 15 ] }, "id": "p55005", "name": "DaysTicker", "type": "object" }, { "attributes": { "months": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ] }, "id": "p55006", "name": "MonthsTicker", "type": "object" }, { "attributes": { "months": [ 0, 2, 4, 6, 8, 10 ] }, "id": "p55007", "name": "MonthsTicker", "type": "object" }, { "attributes": { "months": [ 0, 4, 8 ] }, "id": "p55008", "name": "MonthsTicker", "type": "object" }, { "attributes": { "months": [ 0, 6 ] }, "id": "p55009", "name": "MonthsTicker", "type": "object" }, { "id": "p55010", "name": "YearsTicker", "type": "object" } ] }, "id": "p54998", "name": "DatetimeTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label_orientation = 'parallel'#
- 类型:
轴标签文本的方向。如果提供一个数字,则文本的角度从水平方向测量。
- axis_label_text_baseline = 'bottom'#
- 类型:
轴标签的文本基线。
- axis_line_dash = []#
- 类型:
轴线虚线。
- bounds = 'auto'#
-
渲染轴的边界。如果未设置,则轴将跨越给定维度上的整个绘图。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如,这可用于在画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。
此处定义的变量等效于在 CSS 样式表中
:host { ... }
下设置相同的变量。注意
此属性为实验性,可能随时更改。
- fixed_location = None#
-
设置为指定绘制轴的固定坐标位置。刻度和主标签的方向由轴所属的侧面板决定。
注意
当轴位于中央绘图区域内的固定位置时,轴标签将被抑制。
- formatter = DatetimeTickFormatter(id='p55493', ...)#
- 类型:
用于格式化刻度视觉外观的
TickFormatter
。
- group = None#
- 类型:
注意
此属性为实验性,可能随时更改。
- level = 'guide'#
- 类型:
指定绘制此渲染器的级别。
- major_label_orientation = 'horizontal'#
- 类型:
主标签文本的方向。如果提供数字,则文本的角度从水平方向测量。
- major_label_text_baseline = 'alphabetic'#
- 类型:
主要刻度标签的文本基线。
- major_tick_line_dash = []#
- 类型:
主要刻度线的线型。
- minor_tick_line_dash = []#
- 类型:
次要刻度线的线型。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称很有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
不保证提供的任何名称的唯一性或其他条件,并且 Bokeh 不会直接出于任何原因使用该名称。
- stylesheets = []#
- 类型:
要用于底层 DOM 元素的额外样式表。
请注意,所有 Bokeh 组件都使用阴影 DOM,因此任何包含的样式表都必须反映这一点,例如使用
:host
CSS 伪选择器来访问根 DOM 元素。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False
可能有助于在处理经常更新的对象时减少网络流量,这些对象的更新值我们不需要。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供值的列表,用于附加到此模型。
当查询文档以检索特定的 Bokeh 模型时,此数据可能会有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到模型的一种便捷方法,这些元数据可以通过
CustomJS
回调等访问。注意
不会对提供的任何标签实施唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。
- ticker = DatetimeTicker(id='p56135', ...)#
-
用于计算轴组件位置的刻度器。
该属性也可以传递一个浮点数序列作为创建和配置
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])
- apply
应用一组主题值,这些值将用于代替默认值,但不会覆盖应用程序设置的值。
传递的字典可以保留原样并与其他实例共享以节省内存(因此调用者或
HasProps
实例都不应该修改它)。- 参数:
property_values (dict) – 要代替默认值使用的主题值
- 返回:
None
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序排列的属性描述符列表。
- equals(other: HasProps) bool #
模型的结构相等。
- 参数:
other (HasProps) – 要比较的另一个实例
- 返回:
True,如果属性在结构上相等,否则为 False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
使用 JavaScript 链接两个 Bokeh 模型属性。
这是一种简化方法,它简化了添加
CustomJS
回调以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。- 参数:
在版本 1.1 中添加
- 引发:
示例
使用
js_link
的此代码select.js_link('value', plot, 'sizing_mode')
等效于以下内容
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
此外,要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
这等效于
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
- js_on_change(event: str, *callbacks: JSChangeCallback) None #
将
CustomJS
回调附加到任意 BokehJS 模型事件。在 BokehJS 端,模型属性的更改事件格式为
"change:property_name"
。为了方便起见,如果传递给此方法的事件名称也是模型上属性的名称,则它将自动以"change:"
为前缀# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
但是,除了属性更改事件外,还有其他一些事件可能对响应有用。例如,要运行一个回调,以便每当数据流到
ColumnDataSource
时运行,请在源上使用"stream"
事件source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
在类中查找 Bokeh 属性的
PropertyDescriptor
,给出属性名称。- 参数:
- 返回:
名为
name
的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None #
在该对象上添加一个回调,以触发
attr
更改时。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
当该模型上发生指定的事件时运行回调。
并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息,请参阅 bokeh.events 中的特定事件。
- classmethod parameters() list[Parameter] #
生成适合从 glyph 派生的函数的 Python
Parameter
值。- 返回:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
收集此类上属性的名称。
警告
在 Bokeh 的未来版本中,此方法将返回一个字典,将属性名称映射到属性对象。为了使当前对此方法的用法面向未来,请将返回值包装在
list
中。- 返回:
属性名称
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集一个字典,将属性名称映射到它们的值。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
不可序列化的属性被跳过,属性值采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[Model] #
查询此对象及其所有引用以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用以查找与给定选择器匹配的对象。如果找到多个对象,则会引发错误。返回单个匹配对象,如果没有找到,则返回 None :param selector: :type selector: JSON-like
- 返回:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象的属性值。
- 参数:
name – (str) : 要设置的属性的名称
json – (JSON-value) : 要设置为属性的值
models (dict or None, optional) –
模型 ID 到模型的映射(默认值:None)
这在要更新的属性的值也包含引用的情况下是必要的。
setter (ClientSession or ServerSession or None, optional) –
这用于防止“回旋镖”更新到 Bokeh 应用程序。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与自身进行比较,并抑制来自自身的任何更新。
- 返回:
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 #
- class LinearAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "id": "p56198", "name": "BasicTickFormatter", "type": "object" }, "group": null, "id": "p56196", "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": "p56199", "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": "p56197", "name": "BasicTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label_orientation = 'parallel'#
- 类型:
轴标签文本的方向。如果提供一个数字,则文本的角度从水平方向测量。
- axis_label_text_baseline = 'bottom'#
- 类型:
轴标签的文本基线。
- axis_line_dash = []#
- 类型:
轴线虚线。
- bounds = 'auto'#
-
渲染轴的边界。如果未设置,则轴将跨越给定维度上的整个绘图。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如,这可用于在画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。
此处定义的变量等效于在 CSS 样式表中
:host { ... }
下设置相同的变量。注意
此属性为实验性,可能随时更改。
- fixed_location = None#
-
设置为指定绘制轴的固定坐标位置。刻度和主标签的方向由轴所属的侧面板决定。
注意
当轴位于中央绘图区域内的固定位置时,轴标签将被抑制。
- formatter = BasicTickFormatter(id='p56320', ...)#
- 类型:
用于格式化刻度视觉外观的
TickFormatter
。
- group = None#
- 类型:
注意
此属性为实验性,可能随时更改。
- level = 'guide'#
- 类型:
指定绘制此渲染器的级别。
- major_label_orientation = 'horizontal'#
- 类型:
主标签文本的方向。如果提供数字,则文本的角度从水平方向测量。
- major_label_text_baseline = 'alphabetic'#
- 类型:
主要刻度标签的文本基线。
- major_tick_line_dash = []#
- 类型:
主要刻度线的线型。
- minor_tick_line_dash = []#
- 类型:
次要刻度线的线型。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称很有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
不保证提供的任何名称的唯一性或其他条件,并且 Bokeh 不会直接出于任何原因使用该名称。
- stylesheets = []#
- 类型:
要用于底层 DOM 元素的额外样式表。
请注意,所有 Bokeh 组件都使用阴影 DOM,因此任何包含的样式表都必须反映这一点,例如使用
:host
CSS 伪选择器来访问根 DOM 元素。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False
可能有助于在处理经常更新的对象时减少网络流量,这些对象的更新值我们不需要。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供值的列表,用于附加到此模型。
当查询文档以检索特定的 Bokeh 模型时,此数据可能会有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到模型的一种便捷方法,这些元数据可以通过
CustomJS
回调等访问。注意
不会对提供的任何标签实施唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。
- ticker = BasicTicker(id='p56482', ...)#
-
用于计算轴组件位置的刻度器。
该属性也可以传递一个浮点数序列作为创建和配置
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])
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些值将用于代替默认值,但不会覆盖应用程序设置的值。
传递的字典可以保留原样并与其他实例共享以节省内存(因此调用者或
HasProps
实例都不应该修改它)。- 参数:
property_values (dict) – 要代替默认值使用的主题值
- 返回:
None
-
classmethod descriptors() list[PropertyDescriptor[
- destroy() None #
清理对文档和属性的引用
- equals(other: HasProps) bool #
模型的结构相等。
- 参数:
other (HasProps) – 要比较的另一个实例
- 返回:
True,如果属性在结构上相等,否则为 False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
使用 JavaScript 链接两个 Bokeh 模型属性。
这是一种简化方法,它简化了添加
CustomJS
回调以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。- 参数:
在版本 1.1 中添加
- 引发:
示例
使用
js_link
的此代码select.js_link('value', plot, 'sizing_mode')
等效于以下内容
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
此外,要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
这等效于
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
- js_on_change(event: str, *callbacks: JSChangeCallback) None #
将
CustomJS
回调附加到任意 BokehJS 模型事件。在 BokehJS 端,模型属性的更改事件格式为
"change:property_name"
。为了方便起见,如果传递给此方法的事件名称也是模型上属性的名称,则它将自动以"change:"
为前缀# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
但是,除了属性更改事件外,还有其他一些事件可能对响应有用。例如,要运行一个回调,以便每当数据流到
ColumnDataSource
时运行,请在源上使用"stream"
事件source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
在类中查找 Bokeh 属性的
PropertyDescriptor
,给出属性名称。- 参数:
- 返回:
名为
name
的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None #
在该对象上添加一个回调,以触发
attr
更改时。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
当该模型上发生指定的事件时运行回调。
并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息,请参阅 bokeh.events 中的特定事件。
- classmethod parameters() list[Parameter] #
生成适合从 glyph 派生的函数的 Python
Parameter
值。- 返回:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
收集此类上属性的名称。
警告
在 Bokeh 的未来版本中,此方法将返回一个字典,将属性名称映射到属性对象。为了使当前对此方法的用法面向未来,请将返回值包装在
list
中。- 返回:
属性名称
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集一个字典,将属性名称映射到它们的值。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
不可序列化的属性被跳过,属性值采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[Model] #
查询此对象及其所有引用以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用以查找与给定选择器匹配的对象。如果找到多个对象,则会引发错误。返回单个匹配对象,如果没有找到,则返回 None :param selector: :type selector: JSON-like
- 返回:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象的属性值。
- 参数:
name – (str) : 要设置的属性的名称
json – (JSON-value) : 要设置为属性的值
models (dict or None, optional) –
模型 ID 到模型的映射(默认值:None)
这在要更新的属性的值也包含引用的情况下是必要的。
setter (ClientSession or ServerSession or None, optional) –
这用于防止“回旋镖”更新到 Bokeh 应用程序。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与自身进行比较,并抑制来自自身的任何更新。
- 返回:
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 #
- class LogAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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, "bounds": "auto", "context_menu": null, "coordinates": null, "css_classes": [], "css_variables": { "type": "map" }, "dimension": "auto", "face": "auto", "fixed_location": null, "formatter": { "id": "p56497", "name": "LogTickFormatter", "type": "object" }, "group": null, "id": "p56495", "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": "p56498", "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": "p56496", "name": "LogTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label_orientation = 'parallel'#
- 类型:
轴标签文本的方向。如果提供一个数字,则文本的角度从水平方向测量。
- axis_label_text_baseline = 'bottom'#
- 类型:
轴标签的文本基线。
- axis_line_dash = []#
- 类型:
轴线虚线。
- bounds = 'auto'#
-
渲染轴的边界。如果未设置,则轴将跨越给定维度上的整个绘图。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如,这可用于在画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。
此处定义的变量等效于在 CSS 样式表中
:host { ... }
下设置相同的变量。注意
此属性为实验性,可能随时更改。
- fixed_location = None#
-
设置为指定绘制轴的固定坐标位置。刻度和主标签的方向由轴所属的侧面板决定。
注意
当轴位于中央绘图区域内的固定位置时,轴标签将被抑制。
- formatter = LogTickFormatter(id='p56619', ...)#
- 类型:
用于格式化刻度视觉外观的
TickFormatter
。
- group = None#
- 类型:
注意
此属性为实验性,可能随时更改。
- level = 'guide'#
- 类型:
指定绘制此渲染器的级别。
- major_label_orientation = 'horizontal'#
- 类型:
主标签文本的方向。如果提供数字,则文本的角度从水平方向测量。
- major_label_text_baseline = 'alphabetic'#
- 类型:
主要刻度标签的文本基线。
- major_tick_line_dash = []#
- 类型:
主要刻度线的线型。
- minor_tick_line_dash = []#
- 类型:
次要刻度线的线型。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称很有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
不保证提供的任何名称的唯一性或其他条件,并且 Bokeh 不会直接出于任何原因使用该名称。
- stylesheets = []#
- 类型:
要用于底层 DOM 元素的额外样式表。
请注意,所有 Bokeh 组件都使用阴影 DOM,因此任何包含的样式表都必须反映这一点,例如使用
:host
CSS 伪选择器来访问根 DOM 元素。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False
可能有助于在处理经常更新的对象时减少网络流量,这些对象的更新值我们不需要。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供值的列表,用于附加到此模型。
当查询文档以检索特定的 Bokeh 模型时,此数据可能会有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到模型的一种便捷方法,这些元数据可以通过
CustomJS
回调等访问。注意
不会对提供的任何标签实施唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。
- ticker = LogTicker(id='p56781', ...)#
-
用于计算轴组件位置的刻度器。
该属性也可以传递一个浮点数序列作为创建和配置
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])
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些值将用于代替默认值,但不会覆盖应用程序设置的值。
传递的字典可以保留原样并与其他实例共享以节省内存(因此调用者或
HasProps
实例都不应该修改它)。- 参数:
property_values (dict) – 要代替默认值使用的主题值
- 返回:
None
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序排列的属性描述符列表。
- equals(other: HasProps) bool #
模型的结构相等。
- 参数:
other (HasProps) – 要比较的另一个实例
- 返回:
True,如果属性在结构上相等,否则为 False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
使用 JavaScript 链接两个 Bokeh 模型属性。
这是一种简化方法,它简化了添加
CustomJS
回调以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。- 参数:
在版本 1.1 中添加
- 引发:
示例
使用
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,
CustomJS
回调附加到任意 BokehJS 模型事件。在 BokehJS 端,模型属性的更改事件格式为
"change:property_name"
。为了方便起见,如果传递给此方法的事件名称也是模型上属性的名称,则它将自动以"change:"
为前缀# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
但是,除了属性更改事件外,还有其他一些事件可能对响应有用。例如,要运行一个回调,以便每当数据流到
ColumnDataSource
时运行,请在源上使用"stream"
事件source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
在类中查找 Bokeh 属性的
PropertyDescriptor
,给出属性名称。- 参数:
- 返回:
名为
name
的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None #
在该对象上添加一个回调,以触发
attr
更改时。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
当该模型上发生指定的事件时运行回调。
并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息,请参阅 bokeh.events 中的特定事件。
- classmethod 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]] #
收集此类上所有具有引用的属性的名称。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集一个字典,将属性名称映射到它们的值。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
不可序列化的属性被跳过,属性值采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False)
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[Model] #
查询此对象及其所有引用以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用以查找与给定选择器匹配的对象。如果找到多个对象,则会引发错误。返回单个匹配对象,如果没有找到,则返回 None :param selector: :type selector: JSON-like
- 返回:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象的属性值。
- 参数:
name – (str) : 要设置的属性的名称
json – (JSON-value) : 要设置为属性的值
models (dict or None, optional) –
模型 ID 到模型的映射(默认值:None)
这在要更新的属性的值也包含引用的情况下是必要的。
setter (ClientSession or ServerSession or None, optional) –
这用于防止“回旋镖”更新到 Bokeh 应用程序。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与自身进行比较,并抑制来自自身的任何更新。
- 返回:
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 #
- 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)
- class MercatorAxis(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
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, "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": "p56796", "name": "MercatorTickFormatter", "type": "object" }, "group": null, "id": "p56794", "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": "p56797", "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": "p56795", "name": "MercatorTicker", "type": "object" }, "visible": true, "x_range_name": "default", "y_range_name": "default" }
- axis_label_orientation = 'parallel'#
- 类型:
轴标签文本的方向。如果提供一个数字,则文本的角度从水平方向测量。
- axis_label_text_baseline = 'bottom'#
- 类型:
轴标签的文本基线。
- axis_line_dash = []#
- 类型:
轴线虚线。
- bounds = 'auto'#
-
渲染轴的边界。如果未设置,则轴将跨越给定维度上的整个绘图。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如,这可用于在画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。
此处定义的变量等效于在 CSS 样式表中
:host { ... }
下设置相同的变量。注意
此属性为实验性,可能随时更改。
- fixed_location = None#
-
设置为指定绘制轴的固定坐标位置。刻度和主标签的方向由轴所属的侧面板决定。
注意
当轴位于中央绘图区域内的固定位置时,轴标签将被抑制。
- formatter = MercatorTickFormatter(id='p56918', ...)#
- 类型:
用于格式化刻度视觉外观的
TickFormatter
。
- group = None#
- 类型:
注意
此属性为实验性,可能随时更改。
- level = 'guide'#
- 类型:
指定绘制此渲染器的级别。
- major_label_orientation = 'horizontal'#
- 类型:
主标签文本的方向。如果提供数字,则文本的角度从水平方向测量。
- major_label_text_baseline = 'alphabetic'#
- 类型:
主要刻度标签的文本基线。
- major_tick_line_dash = []#
- 类型:
主要刻度线的线型。
主要刻度线的线连接。
- minor_tick_line_dash = []#
- 类型:
次要刻度线的线型。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定的 Bokeh 模型时,此名称很有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
不保证提供的任何名称的唯一性或其他条件,并且 Bokeh 不会直接出于任何原因使用该名称。
- stylesheets = []#
- 类型:
要用于底层 DOM 元素的额外样式表。
请注意,所有 Bokeh 组件都使用阴影 DOM,因此任何包含的样式表都必须反映这一点,例如使用
:host
CSS 伪选择器来访问根 DOM 元素。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False
可能有助于在处理经常更新的对象时减少网络流量,这些对象的更新值我们不需要。注意
将此属性设置为
False
将阻止此对象上的任何on_change()
回调触发。但是,任何 JS 端回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供值的列表,用于附加到此模型。
当查询文档以检索特定的 Bokeh 模型时,此数据可能会有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者只是将任何必要的元数据附加到模型的一种便捷方法,这些元数据可以通过
CustomJS
回调等访问。注意
不会对提供的任何标签实施唯一性保证或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。
- ticker = MercatorTicker(id='p57080', ...)#
-
用于计算轴组件位置的刻度器。
该属性也可以传递一个浮点数序列作为创建和配置
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])
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些值将用于代替默认值,但不会覆盖应用程序设置的值。
传递的字典可以保留原样并与其他实例共享以节省内存(因此调用者或
HasProps
实例都不应该修改它)。- 参数:
property_values (dict) – 要代替默认值使用的主题值
- 返回:
None
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序排列的属性描述符列表。
- equals(other: HasProps) bool #
模型的结构相等。
- 参数:
other (HasProps) – 要比较的另一个实例
- 返回:
True,如果属性在结构上相等,否则为 False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None #
使用 JavaScript 链接两个 Bokeh 模型属性。
这是一种简化方法,它简化了添加
CustomJS
回调以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。- 参数:
在版本 1.1 中添加
- 引发:
示例
使用
js_link
的此代码select.js_link('value', plot, 'sizing_mode')
等效于以下内容
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
此外,要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
这等效于
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
- js_on_change(event: str, *callbacks: JSChangeCallback) None #
将
CustomJS
回调附加到任意 BokehJS 模型事件。在 BokehJS 端,模型属性的更改事件格式为
"change:property_name"
。为了方便起见,如果传递给此方法的事件名称也是模型上属性的名称,则它将自动以"change:"
为前缀# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
但是,除了属性更改事件外,还有其他一些事件可能对响应有用。例如,要运行一个回调,以便每当数据流到
ColumnDataSource
时运行,请在源上使用"stream"
事件source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None #
在类中查找 Bokeh 属性的
PropertyDescriptor
,给出属性名称。- 参数:
- 返回:
名为
name
的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None #
在该对象上添加一个回调,以触发
attr
更改时。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
当该模型上发生指定的事件时运行回调。
并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息,请参阅 bokeh.events 中的特定事件。
- classmethod 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]] #
收集此类上所有具有引用的属性的名称。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集一个字典,将属性名称映射到它们的值。
此方法始终遍历类层次结构,并包含在任何父类中定义的属性。
不可序列化的属性被跳过,属性值采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- select(selector: SelectorType) Iterable[Model] #
查询此对象及其所有引用以查找与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
- 返回:
seq[Model]
- select_one(selector: SelectorType) Model | None #
查询此对象及其所有引用以查找与给定选择器匹配的对象。如果找到多个对象,则会引发错误。返回单个匹配对象,如果没有找到,则返回 None :param selector: :type selector: JSON-like
- 返回:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None #
从 JSON 设置此对象的属性值。
- 参数:
name – (str) : 要设置的属性的名称
json – (JSON-value) : 要设置为属性的值
models (dict or None, optional) –
模型 ID 到模型的映射(默认值:None)
这在要更新的属性的值也包含引用的情况下是必要的。
setter (ClientSession or ServerSession or None, optional) –
这用于防止“回旋镖”更新到 Bokeh 应用程序。
在 Bokeh 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与自身进行比较,并抑制来自自身的任何更新。
- 返回:
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 #