bokeh.models.axes

可添加到Bokeh图的各种轴的引导渲染器

class Axis(*args, **kwargs)[源代码]

基类:bokeh.models.renderers.GuideRenderer

定义所有轴类型的公共属性的基类。

注解

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

axis_label

属性类型: String

轴的文本标签,与轴规则平行显示。

注解

当前不支持LaTeX标记;请参阅 #647 跟踪进展或贡献。

axis_label_standoff

属性类型: Int

轴标签应偏移刻度标签的距离(以像素为单位)。

axis_label_text_align

属性类型: EnumTextAlign

轴标签的文本对齐。

axis_label_text_alpha

属性类型: Percent

轴标签的文本alpha。

axis_label_text_baseline

属性类型: EnumTextBaseline

轴标签的文本基线。

axis_label_text_color

属性类型: Color

轴标签的文本颜色。

axis_label_text_font

属性类型: String

轴标签的文本字体。

axis_label_text_font_size

属性类型: FontSize

轴标签的文本字体大小。

axis_label_text_font_style

属性类型: EnumFontStyle

轴标签的文本字体样式。

axis_label_text_line_height

属性类型: Float

轴标签的文本行高度。

axis_line_alpha

属性类型: Percent

轴线的alpha线。

axis_line_cap

属性类型: EnumLineCap

轴线的线帽。

axis_line_color

属性类型: Color

轴线的线条颜色。

axis_line_dash

属性类型: DashPattern

轴线的虚线。

axis_line_dash_offset

属性类型: Int

轴线的直线短划线偏移。

axis_line_join

属性类型: EnumLineJoin

轴线的连线。

axis_line_width

属性类型: Float

轴线的线宽。

bounds

属性类型: EitherAutoTupleFloatFloatTupleDatetimeDatetime ) )

渲染轴的边界。如果未设置,轴将跨越给定尺寸的整个绘图。

fixed_location

属性类型: EitherFloatStringTupleStringStringTupleStringStringString ) )

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

注解

当轴定位在中心打印区域内的固定位置时,轴标签将被抑制。

formatter

属性类型: InstanceTickFormatter

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

js_event_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

事件名称到列表的映射 CustomJS 回调。

通常,应该使用 Model.js_on_event 方法:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

属性名到列表的映射 CustomJS 回调,在创建文档时在BokehJS侧设置。

通常,应该使用 Model.js_on_change 方法:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
level

属性类型: EnumRenderLevel

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

major_label_orientation

属性类型: EitherEnum (枚举(水平、垂直)), Float

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

major_label_overrides

属性类型: DictEitherFloatStringString

为提供特定格式的常规位置的刻度标签。

major_label_standoff

属性类型: Int

主刻度标签应与关联刻度偏移的距离(以像素为单位)。

major_label_text_align

属性类型: EnumTextAlign

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

major_label_text_alpha

属性类型: Percent

主要刻度标签的文本alpha。

major_label_text_baseline

属性类型: EnumTextBaseline

主要刻度标签的文本基线。

major_label_text_color

属性类型: Color

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

major_label_text_font

属性类型: String

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

major_label_text_font_size

属性类型: FontSize

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

major_label_text_font_style

属性类型: EnumFontStyle

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

major_label_text_line_height

属性类型: Float

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

major_tick_in

属性类型: Int

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

major_tick_line_alpha

属性类型: Percent

主要刻度线的α线。

major_tick_line_cap

属性类型: EnumLineCap

主要刻度的线帽。

major_tick_line_color

属性类型: Color

主要刻度的线颜色。

major_tick_line_dash

属性类型: DashPattern

主要刻度线的破折号。

major_tick_line_dash_offset

属性类型: Int

主要刻度的线划线偏移量。

major_tick_line_join

属性类型: EnumLineJoin

主要刻度的线连接。

major_tick_line_width

属性类型: Float

主要刻度的线宽。

major_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

minor_tick_in

属性类型: Int

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

minor_tick_line_alpha

属性类型: Percent

小号记号的alpha线。

minor_tick_line_cap

属性类型: EnumLineCap

小号记号的行首。

minor_tick_line_color

属性类型: Color

次要刻度的线颜色。

minor_tick_line_dash

属性类型: DashPattern

小号记号的破折号。

minor_tick_line_dash_offset

属性类型: Int

次要记号的线短划线偏移。

minor_tick_line_join

属性类型: EnumLineJoin

次要记号的行连接。

minor_tick_line_width

属性类型: Float

次要刻度的线宽。

minor_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

name

属性类型: String

用户为此模型提供的任意名称。

当查询文档以检索特定的Bokeh模型时,这个名称非常有用。

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

注解

对于提供的任何名称,不提供唯一性保证或其他条件,Bokeh也不以任何理由直接使用该名称。

subscribed_events

属性类型: ListString

Python回调订阅的事件列表。对于这个模型,这是一组将从BokehJS传递回Python的事件。

tags

属性类型: ListAny

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

当查询文档以检索特定的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

属性类型: InstanceTicker

一种用于计算轴组件位置的记分器。

属性也可以传递一系列浮点数,作为创建和配置 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

属性类型: Bool

渲染器是否可见。

x_range_name

属性类型: String

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

y_range_name

属性类型: String

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

apply_theme(property_values)

应用一组主题值,这些值将被使用而不是默认值,但不会覆盖应用程序集值。

传入的字典可以保持原样,并与其他实例共享以节省内存(因此无论是调用方还是 HasProps 实例应该修改它)。

参数

property_values (dict) -- 主题值用于替代默认值

返回

没有

classmethod dataspecs()

收集所有人的名字 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称 DataSpec 性质

返回类型

set[str]

classmethod dataspecs_with_props()

收集一张记录所有人姓名的字典 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称和 DataSpec 性质

返回类型

dict[str, DataSpec]

equals(other)

模型的结构相等。

参数

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

返回

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

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

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

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

  • other (Model) -- 要链接到的Bokeh模型自我属性

  • other_attr (str) -- 上的财产 other 连接在一起

  • attr_selector (Union[int, str]) -- 链接可订阅项中的项的索引 attr

在版本1.1中添加

引发

ValueError --

实际案例

此代码与 js_link

select.js_link('value', plot, 'sizing_mode')

相当于:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外,要使用属性选择器将范围滑块的左侧附加到绘图的x_范围:

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, *callbacks)

附A 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)
layout(side, plot)
classmethod lookup(name)

找到 PropertyDescriptor 对于类上的Bokeh属性,给定属性名。

参数

name (str) -- 要搜索的属性的名称

返回

名为的属性的描述符 name

返回类型

PropertyDescriptor

on_change(attr, *callbacks)

在此对象上添加回调以在 attr 变化。

参数
  • attr (str) -- 此对象的属性名

  • *callbacks (callable) -- 要注册的回调函数

返回

没有

例子:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

收集此类的属性名称。

这种方法 任选地 遍历类层次结构并包含在任何父类上定义的属性。

参数

with_bases (bool, optional) -- 是否在结果中包含在父类上定义的属性。(默认值:True)

返回

属性名称

返回类型

set[str]

classmethod properties_containers()

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

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

容器属性名称

返回类型

set[str]

classmethod properties_with_refs()

收集该类上也有引用的所有属性的名称。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

具有引用的属性的名称

返回类型

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

收集将属性名称映射到其值的dict。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

跳过不可序列化的属性,属性值采用“序列化”格式,这可能与通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。

参数

include_defaults (bool, optional) -- 是否包含自创建对象后尚未显式设置的属性。(默认值:True)

返回

从属性名到属性值的映射

返回类型

dict

query_properties_with_values(query, include_defaults=True)

查询的属性值 HasProps 带有谓词的实例。

参数
  • query (callable) -- 接受属性描述符并返回True或False的可调用文件

  • include_defaults (bool, optional) -- 是否包含尚未由用户显式设置的属性(默认值:True)

返回

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

返回类型

dict

references()

返回全部 Models 此对象引用的。

remove_on_change(attr, *callbacks)

从此对象中删除回调

select(selector)

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

参数

selector (JSON-like) --

返回

SEQ [模型]

select_one(selector)

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

返回

模型

set_from_json(name, json, models=None, setter=None)

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

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

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

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

set_select(selector, updates)

更新与具有指定属性/值的给定选择器匹配的对象将更新。

参数
  • selector (JSON-like) --

  • updates (dict) --

返回

没有

themed_values()

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

结果以dict形式从属性名返回到值,或者 None 如果没有主题覆盖此实例的任何值。

返回

不记名

to_json(include_defaults)

返回此对象属性的字典,只包含“JSON类型”(string、number、boolean、none、dict、list)。

对其他对象的引用被序列化为“refs”(只是对象ID和类型信息),因此反序列化程序需要单独拥有这些其他对象的完整属性。

没有对应的 from_json() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

to_json_string(include_defaults)

返回编码此对象属性的JSON字符串。

对其他对象的引用被序列化为引用(仅对象ID和类型信息),因此反序列化程序将需要单独拥有这些其他对象的完整属性。

没有对应的 from_json_string() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

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

返回

没有

update(**kwargs)

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

返回

没有

实际案例

以下是等效的:

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)
update_from_json(json_attributes, models=None, setter=None)

对象的属性从字典中更新。

参数
  • json_attributes -- (JSON dict):要更新的属性和值

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

property document

这个 Document 此模型附加到(可以是 None

property struct

此模型的Bokeh协议“结构”,即以下形式的dict:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

此外,可能还有 subtype 字段(如果此模型是子类型)。

JSON Prototype
{
  "axis_label": "",
  "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_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,
  "bounds": "auto",
  "fixed_location": null,
  "formatter": null,
  "id": "1570",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "guide",
  "major_label_orientation": "horizontal",
  "major_label_overrides": {},
  "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_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,
  "subscribed_events": [],
  "tags": [],
  "ticker": null,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}
class CategoricalAxis(*args, **kwargs)[源代码]

基类:bokeh.models.axes.Axis

显示分类范围的刻度和标签的轴。

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

axis_label

属性类型: String

轴的文本标签,与轴规则平行显示。

注解

当前不支持LaTeX标记;请参阅 #647 跟踪进展或贡献。

axis_label_standoff

属性类型: Int

轴标签应偏移刻度标签的距离(以像素为单位)。

axis_label_text_align

属性类型: EnumTextAlign

轴标签的文本对齐。

axis_label_text_alpha

属性类型: Percent

轴标签的文本alpha。

axis_label_text_baseline

属性类型: EnumTextBaseline

轴标签的文本基线。

axis_label_text_color

属性类型: Color

轴标签的文本颜色。

axis_label_text_font

属性类型: String

轴标签的文本字体。

axis_label_text_font_size

属性类型: FontSize

轴标签的文本字体大小。

axis_label_text_font_style

属性类型: EnumFontStyle

轴标签的文本字体样式。

axis_label_text_line_height

属性类型: Float

轴标签的文本行高度。

axis_line_alpha

属性类型: Percent

轴线的alpha线。

axis_line_cap

属性类型: EnumLineCap

轴线的线帽。

axis_line_color

属性类型: Color

轴线的线条颜色。

axis_line_dash

属性类型: DashPattern

轴线的虚线。

axis_line_dash_offset

属性类型: Int

轴线的直线短划线偏移。

axis_line_join

属性类型: EnumLineJoin

轴线的连线。

axis_line_width

属性类型: Float

轴线的线宽。

bounds

属性类型: EitherAutoTupleFloatFloatTupleDatetimeDatetime ) )

渲染轴的边界。如果未设置,轴将跨越给定尺寸的整个绘图。

fixed_location

属性类型: EitherFloatStringTupleStringStringTupleStringStringString ) )

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

注解

当轴定位在中心打印区域内的固定位置时,轴标签将被抑制。

formatter

属性类型: InstanceTickFormatter

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

group_label_orientation

属性类型: EitherEnumTickLabelOrientationFloat

组标签文本的方向。

如果提供了数字,则文本的角度将从水平测量。

此属性始终适用于嵌套最外层的因子。如果分类因子列表是平坦的(即没有嵌套),那么这个属性就没有效果。

group_text_align

属性类型: EnumTextAlign

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

此属性始终适用于嵌套最外层的因子。如果分类因子列表是平坦的(即没有嵌套),那么这个属性就没有效果。

group_text_alpha

属性类型: Percent

组分类标签的文本alpha。

此属性始终适用于嵌套最外层的因子。如果分类因子列表是平坦的(即没有嵌套),那么这个属性就没有效果。

group_text_baseline

属性类型: EnumTextBaseline

组分类标签的文本基线。

此属性始终适用于嵌套最外层的因子。如果分类因子列表是平坦的(即没有嵌套),那么这个属性就没有效果。

group_text_color

属性类型: Color

组分类标签的文本颜色。

此属性始终适用于嵌套最外层的因子。如果分类因子列表是平坦的(即没有嵌套),那么这个属性就没有效果。

group_text_font

属性类型: String

组分类标签的文本字体。

此属性始终适用于嵌套最外层的因子。如果分类因子列表是平坦的(即没有嵌套),那么这个属性就没有效果。

group_text_font_size

属性类型: FontSize

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

此属性始终适用于嵌套最外层的因子。如果分类因子列表是平坦的(即没有嵌套),那么这个属性就没有效果。

group_text_font_style

属性类型: EnumFontStyle

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

此属性始终适用于嵌套最外层的因子。如果分类因子列表是平坦的(即没有嵌套),那么这个属性就没有效果。

group_text_line_height

属性类型: Float

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

此属性始终适用于嵌套最外层的因子。如果分类因子列表是平坦的(即没有嵌套),那么这个属性就没有效果。

js_event_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

事件名称到列表的映射 CustomJS 回调。

通常,应该使用 Model.js_on_event 方法:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

属性名到列表的映射 CustomJS 回调,在创建文档时在BokehJS侧设置。

通常,应该使用 Model.js_on_change 方法:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
level

属性类型: EnumRenderLevel

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

major_label_orientation

属性类型: EitherEnum (枚举(水平、垂直)), Float

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

major_label_overrides

属性类型: DictEitherFloatStringString

为提供特定格式的常规位置的刻度标签。

major_label_standoff

属性类型: Int

主刻度标签应与关联刻度偏移的距离(以像素为单位)。

major_label_text_align

属性类型: EnumTextAlign

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

major_label_text_alpha

属性类型: Percent

主要刻度标签的文本alpha。

major_label_text_baseline

属性类型: EnumTextBaseline

主要刻度标签的文本基线。

major_label_text_color

属性类型: Color

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

major_label_text_font

属性类型: String

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

major_label_text_font_size

属性类型: FontSize

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

major_label_text_font_style

属性类型: EnumFontStyle

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

major_label_text_line_height

属性类型: Float

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

major_tick_in

属性类型: Int

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

major_tick_line_alpha

属性类型: Percent

主要刻度线的α线。

major_tick_line_cap

属性类型: EnumLineCap

主要刻度的线帽。

major_tick_line_color

属性类型: Color

主要刻度的线颜色。

major_tick_line_dash

属性类型: DashPattern

主要刻度线的破折号。

major_tick_line_dash_offset

属性类型: Int

主要刻度的线划线偏移量。

major_tick_line_join

属性类型: EnumLineJoin

主要刻度的线连接。

major_tick_line_width

属性类型: Float

主要刻度的线宽。

major_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

minor_tick_in

属性类型: Int

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

minor_tick_line_alpha

属性类型: Percent

小号记号的alpha线。

minor_tick_line_cap

属性类型: EnumLineCap

小号记号的行首。

minor_tick_line_color

属性类型: Color

次要刻度的线颜色。

minor_tick_line_dash

属性类型: DashPattern

小号记号的破折号。

minor_tick_line_dash_offset

属性类型: Int

次要记号的线短划线偏移。

minor_tick_line_join

属性类型: EnumLineJoin

次要记号的行连接。

minor_tick_line_width

属性类型: Float

次要刻度的线宽。

minor_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

name

属性类型: String

用户为此模型提供的任意名称。

当查询文档以检索特定的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_alpha

属性类型: Percent

顶级分类组之间分隔线的alpha线。

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

separator_line_cap

属性类型: EnumLineCap

顶级分类组之间分隔线的行首。

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

separator_line_color

属性类型: Color

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

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

separator_line_dash

属性类型: DashPattern

顶级分类组之间分隔线的破折号。

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

separator_line_dash_offset

属性类型: Int

顶级分类组之间分隔线的线划线偏移。

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

separator_line_join

属性类型: EnumLineJoin

顶级分类组之间分隔线的行连接。

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

separator_line_width

属性类型: Float

顶级类别组之间分隔线的线宽。

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

subgroup_label_orientation

属性类型: EitherEnumTickLabelOrientationFloat

子组标签文本的方向。

如果提供了数字,则文本的角度将从水平测量。

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

subgroup_text_align

属性类型: EnumTextAlign

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

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

subgroup_text_alpha

属性类型: Percent

子组分类标签的文本alpha。

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

subgroup_text_baseline

属性类型: EnumTextBaseline

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

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

subgroup_text_color

属性类型: Color

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

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

subgroup_text_font

属性类型: String

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

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

subgroup_text_font_size

属性类型: FontSize

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

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

subgroup_text_font_style

属性类型: EnumFontStyle

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

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

subgroup_text_line_height

属性类型: Float

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

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

subscribed_events

属性类型: ListString

Python回调订阅的事件列表。对于这个模型,这是一组将从BokehJS传递回Python的事件。

tags

属性类型: ListAny

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

当查询文档以检索特定的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

属性类型: InstanceTicker

一种用于计算轴组件位置的记分器。

属性也可以传递一系列浮点数,作为创建和配置 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

属性类型: Bool

渲染器是否可见。

x_range_name

属性类型: String

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

y_range_name

属性类型: String

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

apply_theme(property_values)

应用一组主题值,这些值将被使用而不是默认值,但不会覆盖应用程序集值。

传入的字典可以保持原样,并与其他实例共享以节省内存(因此无论是调用方还是 HasProps 实例应该修改它)。

参数

property_values (dict) -- 主题值用于替代默认值

返回

没有

classmethod dataspecs()

收集所有人的名字 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称 DataSpec 性质

返回类型

set[str]

classmethod dataspecs_with_props()

收集一张记录所有人姓名的字典 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称和 DataSpec 性质

返回类型

dict[str, DataSpec]

equals(other)

模型的结构相等。

参数

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

返回

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

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

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

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

  • other (Model) -- 要链接到的Bokeh模型自我属性

  • other_attr (str) -- 上的财产 other 连接在一起

  • attr_selector (Union[int, str]) -- 链接可订阅项中的项的索引 attr

在版本1.1中添加

引发

ValueError --

实际案例

此代码与 js_link

select.js_link('value', plot, 'sizing_mode')

相当于:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外,要使用属性选择器将范围滑块的左侧附加到绘图的x_范围:

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, *callbacks)

附A 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)
layout(side, plot)
classmethod lookup(name)

找到 PropertyDescriptor 对于类上的Bokeh属性,给定属性名。

参数

name (str) -- 要搜索的属性的名称

返回

名为的属性的描述符 name

返回类型

PropertyDescriptor

on_change(attr, *callbacks)

在此对象上添加回调以在 attr 变化。

参数
  • attr (str) -- 此对象的属性名

  • *callbacks (callable) -- 要注册的回调函数

返回

没有

例子:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

收集此类的属性名称。

这种方法 任选地 遍历类层次结构并包含在任何父类上定义的属性。

参数

with_bases (bool, optional) -- 是否在结果中包含在父类上定义的属性。(默认值:True)

返回

属性名称

返回类型

set[str]

classmethod properties_containers()

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

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

容器属性名称

返回类型

set[str]

classmethod properties_with_refs()

收集该类上也有引用的所有属性的名称。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

具有引用的属性的名称

返回类型

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

收集将属性名称映射到其值的dict。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

跳过不可序列化的属性,属性值采用“序列化”格式,这可能与通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。

参数

include_defaults (bool, optional) -- 是否包含自创建对象后尚未显式设置的属性。(默认值:True)

返回

从属性名到属性值的映射

返回类型

dict

query_properties_with_values(query, include_defaults=True)

查询的属性值 HasProps 带有谓词的实例。

参数
  • query (callable) -- 接受属性描述符并返回True或False的可调用文件

  • include_defaults (bool, optional) -- 是否包含尚未由用户显式设置的属性(默认值:True)

返回

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

返回类型

dict

references()

返回全部 Models 此对象引用的。

remove_on_change(attr, *callbacks)

从此对象中删除回调

select(selector)

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

参数

selector (JSON-like) --

返回

SEQ [模型]

select_one(selector)

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

返回

模型

set_from_json(name, json, models=None, setter=None)

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

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

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

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

set_select(selector, updates)

更新与具有指定属性/值的给定选择器匹配的对象将更新。

参数
  • selector (JSON-like) --

  • updates (dict) --

返回

没有

themed_values()

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

结果以dict形式从属性名返回到值,或者 None 如果没有主题覆盖此实例的任何值。

返回

不记名

to_json(include_defaults)

返回此对象属性的字典,只包含“JSON类型”(string、number、boolean、none、dict、list)。

对其他对象的引用被序列化为“refs”(只是对象ID和类型信息),因此反序列化程序需要单独拥有这些其他对象的完整属性。

没有对应的 from_json() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

to_json_string(include_defaults)

返回编码此对象属性的JSON字符串。

对其他对象的引用被序列化为引用(仅对象ID和类型信息),因此反序列化程序将需要单独拥有这些其他对象的完整属性。

没有对应的 from_json_string() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

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

返回

没有

update(**kwargs)

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

返回

没有

实际案例

以下是等效的:

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)
update_from_json(json_attributes, models=None, setter=None)

对象的属性从字典中更新。

参数
  • json_attributes -- (JSON dict):要更新的属性和值

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

property document

这个 Document 此模型附加到(可以是 None

property struct

此模型的Bokeh协议“结构”,即以下形式的dict:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

此外,可能还有 subtype 字段(如果此模型是子类型)。

JSON Prototype
{
  "axis_label": "",
  "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_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,
  "bounds": "auto",
  "fixed_location": null,
  "formatter": {
    "id": "1632"
  },
  "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,
  "id": "1630",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "guide",
  "major_label_orientation": "horizontal",
  "major_label_overrides": {},
  "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_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,
  "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,
  "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,
  "subscribed_events": [],
  "tags": [],
  "ticker": {
    "id": "1631"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}
class ContinuousAxis(*args, **kwargs)[源代码]

基类:bokeh.models.axes.Axis

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

注解

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

axis_label

属性类型: String

轴的文本标签,与轴规则平行显示。

注解

当前不支持LaTeX标记;请参阅 #647 跟踪进展或贡献。

axis_label_standoff

属性类型: Int

轴标签应偏移刻度标签的距离(以像素为单位)。

axis_label_text_align

属性类型: EnumTextAlign

轴标签的文本对齐。

axis_label_text_alpha

属性类型: Percent

轴标签的文本alpha。

axis_label_text_baseline

属性类型: EnumTextBaseline

轴标签的文本基线。

axis_label_text_color

属性类型: Color

轴标签的文本颜色。

axis_label_text_font

属性类型: String

轴标签的文本字体。

axis_label_text_font_size

属性类型: FontSize

轴标签的文本字体大小。

axis_label_text_font_style

属性类型: EnumFontStyle

轴标签的文本字体样式。

axis_label_text_line_height

属性类型: Float

轴标签的文本行高度。

axis_line_alpha

属性类型: Percent

轴线的alpha线。

axis_line_cap

属性类型: EnumLineCap

轴线的线帽。

axis_line_color

属性类型: Color

轴线的线条颜色。

axis_line_dash

属性类型: DashPattern

轴线的虚线。

axis_line_dash_offset

属性类型: Int

轴线的直线短划线偏移。

axis_line_join

属性类型: EnumLineJoin

轴线的连线。

axis_line_width

属性类型: Float

轴线的线宽。

bounds

属性类型: EitherAutoTupleFloatFloatTupleDatetimeDatetime ) )

渲染轴的边界。如果未设置,轴将跨越给定尺寸的整个绘图。

fixed_location

属性类型: EitherFloatStringTupleStringStringTupleStringStringString ) )

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

注解

当轴定位在中心打印区域内的固定位置时,轴标签将被抑制。

formatter

属性类型: InstanceTickFormatter

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

js_event_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

事件名称到列表的映射 CustomJS 回调。

通常,应该使用 Model.js_on_event 方法:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

属性名到列表的映射 CustomJS 回调,在创建文档时在BokehJS侧设置。

通常,应该使用 Model.js_on_change 方法:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
level

属性类型: EnumRenderLevel

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

major_label_orientation

属性类型: EitherEnum (枚举(水平、垂直)), Float

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

major_label_overrides

属性类型: DictEitherFloatStringString

为提供特定格式的常规位置的刻度标签。

major_label_standoff

属性类型: Int

主刻度标签应与关联刻度偏移的距离(以像素为单位)。

major_label_text_align

属性类型: EnumTextAlign

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

major_label_text_alpha

属性类型: Percent

主要刻度标签的文本alpha。

major_label_text_baseline

属性类型: EnumTextBaseline

主要刻度标签的文本基线。

major_label_text_color

属性类型: Color

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

major_label_text_font

属性类型: String

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

major_label_text_font_size

属性类型: FontSize

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

major_label_text_font_style

属性类型: EnumFontStyle

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

major_label_text_line_height

属性类型: Float

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

major_tick_in

属性类型: Int

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

major_tick_line_alpha

属性类型: Percent

主要刻度线的α线。

major_tick_line_cap

属性类型: EnumLineCap

主要刻度的线帽。

major_tick_line_color

属性类型: Color

主要刻度的线颜色。

major_tick_line_dash

属性类型: DashPattern

主要刻度线的破折号。

major_tick_line_dash_offset

属性类型: Int

主要刻度的线划线偏移量。

major_tick_line_join

属性类型: EnumLineJoin

主要刻度的线连接。

major_tick_line_width

属性类型: Float

主要刻度的线宽。

major_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

minor_tick_in

属性类型: Int

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

minor_tick_line_alpha

属性类型: Percent

小号记号的alpha线。

minor_tick_line_cap

属性类型: EnumLineCap

小号记号的行首。

minor_tick_line_color

属性类型: Color

次要刻度的线颜色。

minor_tick_line_dash

属性类型: DashPattern

小号记号的破折号。

minor_tick_line_dash_offset

属性类型: Int

次要记号的线短划线偏移。

minor_tick_line_join

属性类型: EnumLineJoin

次要记号的行连接。

minor_tick_line_width

属性类型: Float

次要刻度的线宽。

minor_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

name

属性类型: String

用户为此模型提供的任意名称。

当查询文档以检索特定的Bokeh模型时,这个名称非常有用。

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

注解

对于提供的任何名称,不提供唯一性保证或其他条件,Bokeh也不以任何理由直接使用该名称。

subscribed_events

属性类型: ListString

Python回调订阅的事件列表。对于这个模型,这是一组将从BokehJS传递回Python的事件。

tags

属性类型: ListAny

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

当查询文档以检索特定的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

属性类型: InstanceTicker

一种用于计算轴组件位置的记分器。

属性也可以传递一系列浮点数,作为创建和配置 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

属性类型: Bool

渲染器是否可见。

x_range_name

属性类型: String

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

y_range_name

属性类型: String

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

apply_theme(property_values)

应用一组主题值,这些值将被使用而不是默认值,但不会覆盖应用程序集值。

传入的字典可以保持原样,并与其他实例共享以节省内存(因此无论是调用方还是 HasProps 实例应该修改它)。

参数

property_values (dict) -- 主题值用于替代默认值

返回

没有

classmethod dataspecs()

收集所有人的名字 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称 DataSpec 性质

返回类型

set[str]

classmethod dataspecs_with_props()

收集一张记录所有人姓名的字典 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称和 DataSpec 性质

返回类型

dict[str, DataSpec]

equals(other)

模型的结构相等。

参数

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

返回

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

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

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

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

  • other (Model) -- 要链接到的Bokeh模型自我属性

  • other_attr (str) -- 上的财产 other 连接在一起

  • attr_selector (Union[int, str]) -- 链接可订阅项中的项的索引 attr

在版本1.1中添加

引发

ValueError --

实际案例

此代码与 js_link

select.js_link('value', plot, 'sizing_mode')

相当于:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外,要使用属性选择器将范围滑块的左侧附加到绘图的x_范围:

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, *callbacks)

附A 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)
layout(side, plot)
classmethod lookup(name)

找到 PropertyDescriptor 对于类上的Bokeh属性,给定属性名。

参数

name (str) -- 要搜索的属性的名称

返回

名为的属性的描述符 name

返回类型

PropertyDescriptor

on_change(attr, *callbacks)

在此对象上添加回调以在 attr 变化。

参数
  • attr (str) -- 此对象的属性名

  • *callbacks (callable) -- 要注册的回调函数

返回

没有

例子:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

收集此类的属性名称。

这种方法 任选地 遍历类层次结构并包含在任何父类上定义的属性。

参数

with_bases (bool, optional) -- 是否在结果中包含在父类上定义的属性。(默认值:True)

返回

属性名称

返回类型

set[str]

classmethod properties_containers()

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

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

容器属性名称

返回类型

set[str]

classmethod properties_with_refs()

收集该类上也有引用的所有属性的名称。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

具有引用的属性的名称

返回类型

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

收集将属性名称映射到其值的dict。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

跳过不可序列化的属性,属性值采用“序列化”格式,这可能与通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。

参数

include_defaults (bool, optional) -- 是否包含自创建对象后尚未显式设置的属性。(默认值:True)

返回

从属性名到属性值的映射

返回类型

dict

query_properties_with_values(query, include_defaults=True)

查询的属性值 HasProps 带有谓词的实例。

参数
  • query (callable) -- 接受属性描述符并返回True或False的可调用文件

  • include_defaults (bool, optional) -- 是否包含尚未由用户显式设置的属性(默认值:True)

返回

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

返回类型

dict

references()

返回全部 Models 此对象引用的。

remove_on_change(attr, *callbacks)

从此对象中删除回调

select(selector)

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

参数

selector (JSON-like) --

返回

SEQ [模型]

select_one(selector)

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

返回

模型

set_from_json(name, json, models=None, setter=None)

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

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

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

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

set_select(selector, updates)

更新与具有指定属性/值的给定选择器匹配的对象将更新。

参数
  • selector (JSON-like) --

  • updates (dict) --

返回

没有

themed_values()

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

结果以dict形式从属性名返回到值,或者 None 如果没有主题覆盖此实例的任何值。

返回

不记名

to_json(include_defaults)

返回此对象属性的字典,只包含“JSON类型”(string、number、boolean、none、dict、list)。

对其他对象的引用被序列化为“refs”(只是对象ID和类型信息),因此反序列化程序需要单独拥有这些其他对象的完整属性。

没有对应的 from_json() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

to_json_string(include_defaults)

返回编码此对象属性的JSON字符串。

对其他对象的引用被序列化为引用(仅对象ID和类型信息),因此反序列化程序将需要单独拥有这些其他对象的完整属性。

没有对应的 from_json_string() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

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

返回

没有

update(**kwargs)

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

返回

没有

实际案例

以下是等效的:

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)
update_from_json(json_attributes, models=None, setter=None)

对象的属性从字典中更新。

参数
  • json_attributes -- (JSON dict):要更新的属性和值

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

property document

这个 Document 此模型附加到(可以是 None

property struct

此模型的Bokeh协议“结构”,即以下形式的dict:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

此外,可能还有 subtype 字段(如果此模型是子类型)。

JSON Prototype
{
  "axis_label": "",
  "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_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,
  "bounds": "auto",
  "fixed_location": null,
  "formatter": null,
  "id": "1717",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "guide",
  "major_label_orientation": "horizontal",
  "major_label_overrides": {},
  "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_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,
  "subscribed_events": [],
  "tags": [],
  "ticker": null,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}
class DatetimeAxis(*args, **kwargs)[源代码]

基类:bokeh.models.axes.LinearAxis

A LinearAxis 它在日期时间尺度上为滴答位置选择了合适的数字。配置有 DatetimeTickFormatter 默认情况下。

axis_label

属性类型: String

轴的文本标签,与轴规则平行显示。

注解

当前不支持LaTeX标记;请参阅 #647 跟踪进展或贡献。

axis_label_standoff

属性类型: Int

轴标签应偏移刻度标签的距离(以像素为单位)。

axis_label_text_align

属性类型: EnumTextAlign

轴标签的文本对齐。

axis_label_text_alpha

属性类型: Percent

轴标签的文本alpha。

axis_label_text_baseline

属性类型: EnumTextBaseline

轴标签的文本基线。

axis_label_text_color

属性类型: Color

轴标签的文本颜色。

axis_label_text_font

属性类型: String

轴标签的文本字体。

axis_label_text_font_size

属性类型: FontSize

轴标签的文本字体大小。

axis_label_text_font_style

属性类型: EnumFontStyle

轴标签的文本字体样式。

axis_label_text_line_height

属性类型: Float

轴标签的文本行高度。

axis_line_alpha

属性类型: Percent

轴线的alpha线。

axis_line_cap

属性类型: EnumLineCap

轴线的线帽。

axis_line_color

属性类型: Color

轴线的线条颜色。

axis_line_dash

属性类型: DashPattern

轴线的虚线。

axis_line_dash_offset

属性类型: Int

轴线的直线短划线偏移。

axis_line_join

属性类型: EnumLineJoin

轴线的连线。

axis_line_width

属性类型: Float

轴线的线宽。

bounds

属性类型: EitherAutoTupleFloatFloatTupleDatetimeDatetime ) )

渲染轴的边界。如果未设置,轴将跨越给定尺寸的整个绘图。

fixed_location

属性类型: EitherFloatStringTupleStringStringTupleStringStringString ) )

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

注解

当轴定位在中心打印区域内的固定位置时,轴标签将被抑制。

formatter

属性类型: InstanceTickFormatter

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

js_event_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

事件名称到列表的映射 CustomJS 回调。

通常,应该使用 Model.js_on_event 方法:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

属性名到列表的映射 CustomJS 回调,在创建文档时在BokehJS侧设置。

通常,应该使用 Model.js_on_change 方法:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
level

属性类型: EnumRenderLevel

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

major_label_orientation

属性类型: EitherEnum (枚举(水平、垂直)), Float

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

major_label_overrides

属性类型: DictEitherFloatStringString

为提供特定格式的常规位置的刻度标签。

major_label_standoff

属性类型: Int

主刻度标签应与关联刻度偏移的距离(以像素为单位)。

major_label_text_align

属性类型: EnumTextAlign

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

major_label_text_alpha

属性类型: Percent

主要刻度标签的文本alpha。

major_label_text_baseline

属性类型: EnumTextBaseline

主要刻度标签的文本基线。

major_label_text_color

属性类型: Color

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

major_label_text_font

属性类型: String

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

major_label_text_font_size

属性类型: FontSize

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

major_label_text_font_style

属性类型: EnumFontStyle

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

major_label_text_line_height

属性类型: Float

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

major_tick_in

属性类型: Int

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

major_tick_line_alpha

属性类型: Percent

主要刻度线的α线。

major_tick_line_cap

属性类型: EnumLineCap

主要刻度的线帽。

major_tick_line_color

属性类型: Color

主要刻度的线颜色。

major_tick_line_dash

属性类型: DashPattern

主要刻度线的破折号。

major_tick_line_dash_offset

属性类型: Int

主要刻度的线划线偏移量。

major_tick_line_join

属性类型: EnumLineJoin

主要刻度的线连接。

major_tick_line_width

属性类型: Float

主要刻度的线宽。

major_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

minor_tick_in

属性类型: Int

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

minor_tick_line_alpha

属性类型: Percent

小号记号的alpha线。

minor_tick_line_cap

属性类型: EnumLineCap

小号记号的行首。

minor_tick_line_color

属性类型: Color

次要刻度的线颜色。

minor_tick_line_dash

属性类型: DashPattern

小号记号的破折号。

minor_tick_line_dash_offset

属性类型: Int

次要记号的线短划线偏移。

minor_tick_line_join

属性类型: EnumLineJoin

次要记号的行连接。

minor_tick_line_width

属性类型: Float

次要刻度的线宽。

minor_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

name

属性类型: String

用户为此模型提供的任意名称。

当查询文档以检索特定的Bokeh模型时,这个名称非常有用。

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

注解

对于提供的任何名称,不提供唯一性保证或其他条件,Bokeh也不以任何理由直接使用该名称。

subscribed_events

属性类型: ListString

Python回调订阅的事件列表。对于这个模型,这是一组将从BokehJS传递回Python的事件。

tags

属性类型: ListAny

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

当查询文档以检索特定的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

属性类型: InstanceTicker

一种用于计算轴组件位置的记分器。

属性也可以传递一系列浮点数,作为创建和配置 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

属性类型: Bool

渲染器是否可见。

x_range_name

属性类型: String

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

y_range_name

属性类型: String

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

apply_theme(property_values)

应用一组主题值,这些值将被使用而不是默认值,但不会覆盖应用程序集值。

传入的字典可以保持原样,并与其他实例共享以节省内存(因此无论是调用方还是 HasProps 实例应该修改它)。

参数

property_values (dict) -- 主题值用于替代默认值

返回

没有

classmethod dataspecs()

收集所有人的名字 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称 DataSpec 性质

返回类型

set[str]

classmethod dataspecs_with_props()

收集一张记录所有人姓名的字典 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称和 DataSpec 性质

返回类型

dict[str, DataSpec]

equals(other)

模型的结构相等。

参数

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

返回

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

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

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

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

  • other (Model) -- 要链接到的Bokeh模型自我属性

  • other_attr (str) -- 上的财产 other 连接在一起

  • attr_selector (Union[int, str]) -- 链接可订阅项中的项的索引 attr

在版本1.1中添加

引发

ValueError --

实际案例

此代码与 js_link

select.js_link('value', plot, 'sizing_mode')

相当于:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外,要使用属性选择器将范围滑块的左侧附加到绘图的x_范围:

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, *callbacks)

附A 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)
layout(side, plot)
classmethod lookup(name)

找到 PropertyDescriptor 对于类上的Bokeh属性,给定属性名。

参数

name (str) -- 要搜索的属性的名称

返回

名为的属性的描述符 name

返回类型

PropertyDescriptor

on_change(attr, *callbacks)

在此对象上添加回调以在 attr 变化。

参数
  • attr (str) -- 此对象的属性名

  • *callbacks (callable) -- 要注册的回调函数

返回

没有

例子:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

收集此类的属性名称。

这种方法 任选地 遍历类层次结构并包含在任何父类上定义的属性。

参数

with_bases (bool, optional) -- 是否在结果中包含在父类上定义的属性。(默认值:True)

返回

属性名称

返回类型

set[str]

classmethod properties_containers()

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

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

容器属性名称

返回类型

set[str]

classmethod properties_with_refs()

收集该类上也有引用的所有属性的名称。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

具有引用的属性的名称

返回类型

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

收集将属性名称映射到其值的dict。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

跳过不可序列化的属性,属性值采用“序列化”格式,这可能与通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。

参数

include_defaults (bool, optional) -- 是否包含自创建对象后尚未显式设置的属性。(默认值:True)

返回

从属性名到属性值的映射

返回类型

dict

query_properties_with_values(query, include_defaults=True)

查询的属性值 HasProps 带有谓词的实例。

参数
  • query (callable) -- 接受属性描述符并返回True或False的可调用文件

  • include_defaults (bool, optional) -- 是否包含尚未由用户显式设置的属性(默认值:True)

返回

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

返回类型

dict

references()

返回全部 Models 此对象引用的。

remove_on_change(attr, *callbacks)

从此对象中删除回调

select(selector)

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

参数

selector (JSON-like) --

返回

SEQ [模型]

select_one(selector)

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

返回

模型

set_from_json(name, json, models=None, setter=None)

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

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

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

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

set_select(selector, updates)

更新与具有指定属性/值的给定选择器匹配的对象将更新。

参数
  • selector (JSON-like) --

  • updates (dict) --

返回

没有

themed_values()

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

结果以dict形式从属性名返回到值,或者 None 如果没有主题覆盖此实例的任何值。

返回

不记名

to_json(include_defaults)

返回此对象属性的字典,只包含“JSON类型”(string、number、boolean、none、dict、list)。

对其他对象的引用被序列化为“refs”(只是对象ID和类型信息),因此反序列化程序需要单独拥有这些其他对象的完整属性。

没有对应的 from_json() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

to_json_string(include_defaults)

返回编码此对象属性的JSON字符串。

对其他对象的引用被序列化为引用(仅对象ID和类型信息),因此反序列化程序将需要单独拥有这些其他对象的完整属性。

没有对应的 from_json_string() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

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

返回

没有

update(**kwargs)

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

返回

没有

实际案例

以下是等效的:

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)
update_from_json(json_attributes, models=None, setter=None)

对象的属性从字典中更新。

参数
  • json_attributes -- (JSON dict):要更新的属性和值

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

property document

这个 Document 此模型附加到(可以是 None

property struct

此模型的Bokeh协议“结构”,即以下形式的dict:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

此外,可能还有 subtype 字段(如果此模型是子类型)。

JSON Prototype
{
  "axis_label": "",
  "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_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,
  "bounds": "auto",
  "fixed_location": null,
  "formatter": {
    "id": "1779"
  },
  "id": "1777",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "guide",
  "major_label_orientation": "horizontal",
  "major_label_overrides": {},
  "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_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,
  "subscribed_events": [],
  "tags": [],
  "ticker": {
    "id": "1778"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}
class LinearAxis(*args, **kwargs)[源代码]

基类:bokeh.models.axes.ContinuousAxis

在线性刻度上为刻度位置选取合适数字的轴。配置有 BasicTickFormatter 默认情况下。

axis_label

属性类型: String

轴的文本标签,与轴规则平行显示。

注解

当前不支持LaTeX标记;请参阅 #647 跟踪进展或贡献。

axis_label_standoff

属性类型: Int

轴标签应偏移刻度标签的距离(以像素为单位)。

axis_label_text_align

属性类型: EnumTextAlign

轴标签的文本对齐。

axis_label_text_alpha

属性类型: Percent

轴标签的文本alpha。

axis_label_text_baseline

属性类型: EnumTextBaseline

轴标签的文本基线。

axis_label_text_color

属性类型: Color

轴标签的文本颜色。

axis_label_text_font

属性类型: String

轴标签的文本字体。

axis_label_text_font_size

属性类型: FontSize

轴标签的文本字体大小。

axis_label_text_font_style

属性类型: EnumFontStyle

轴标签的文本字体样式。

axis_label_text_line_height

属性类型: Float

轴标签的文本行高度。

axis_line_alpha

属性类型: Percent

轴线的alpha线。

axis_line_cap

属性类型: EnumLineCap

轴线的线帽。

axis_line_color

属性类型: Color

轴线的线条颜色。

axis_line_dash

属性类型: DashPattern

轴线的虚线。

axis_line_dash_offset

属性类型: Int

轴线的直线短划线偏移。

axis_line_join

属性类型: EnumLineJoin

轴线的连线。

axis_line_width

属性类型: Float

轴线的线宽。

bounds

属性类型: EitherAutoTupleFloatFloatTupleDatetimeDatetime ) )

渲染轴的边界。如果未设置,轴将跨越给定尺寸的整个绘图。

fixed_location

属性类型: EitherFloatStringTupleStringStringTupleStringStringString ) )

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

注解

当轴定位在中心打印区域内的固定位置时,轴标签将被抑制。

formatter

属性类型: InstanceTickFormatter

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

js_event_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

事件名称到列表的映射 CustomJS 回调。

通常,应该使用 Model.js_on_event 方法:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

属性名到列表的映射 CustomJS 回调,在创建文档时在BokehJS侧设置。

通常,应该使用 Model.js_on_change 方法:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
level

属性类型: EnumRenderLevel

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

major_label_orientation

属性类型: EitherEnum (枚举(水平、垂直)), Float

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

major_label_overrides

属性类型: DictEitherFloatStringString

为提供特定格式的常规位置的刻度标签。

major_label_standoff

属性类型: Int

主刻度标签应与关联刻度偏移的距离(以像素为单位)。

major_label_text_align

属性类型: EnumTextAlign

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

major_label_text_alpha

属性类型: Percent

主要刻度标签的文本alpha。

major_label_text_baseline

属性类型: EnumTextBaseline

主要刻度标签的文本基线。

major_label_text_color

属性类型: Color

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

major_label_text_font

属性类型: String

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

major_label_text_font_size

属性类型: FontSize

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

major_label_text_font_style

属性类型: EnumFontStyle

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

major_label_text_line_height

属性类型: Float

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

major_tick_in

属性类型: Int

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

major_tick_line_alpha

属性类型: Percent

主要刻度线的α线。

major_tick_line_cap

属性类型: EnumLineCap

主要刻度的线帽。

major_tick_line_color

属性类型: Color

主要刻度的线颜色。

major_tick_line_dash

属性类型: DashPattern

主要刻度线的破折号。

major_tick_line_dash_offset

属性类型: Int

主要刻度的线划线偏移量。

major_tick_line_join

属性类型: EnumLineJoin

主要刻度的线连接。

major_tick_line_width

属性类型: Float

主要刻度的线宽。

major_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

minor_tick_in

属性类型: Int

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

minor_tick_line_alpha

属性类型: Percent

小号记号的alpha线。

minor_tick_line_cap

属性类型: EnumLineCap

小号记号的行首。

minor_tick_line_color

属性类型: Color

次要刻度的线颜色。

minor_tick_line_dash

属性类型: DashPattern

小号记号的破折号。

minor_tick_line_dash_offset

属性类型: Int

次要记号的线短划线偏移。

minor_tick_line_join

属性类型: EnumLineJoin

次要记号的行连接。

minor_tick_line_width

属性类型: Float

次要刻度的线宽。

minor_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

name

属性类型: String

用户为此模型提供的任意名称。

当查询文档以检索特定的Bokeh模型时,这个名称非常有用。

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

注解

对于提供的任何名称,不提供唯一性保证或其他条件,Bokeh也不以任何理由直接使用该名称。

subscribed_events

属性类型: ListString

Python回调订阅的事件列表。对于这个模型,这是一组将从BokehJS传递回Python的事件。

tags

属性类型: ListAny

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

当查询文档以检索特定的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

属性类型: InstanceTicker

一种用于计算轴组件位置的记分器。

属性也可以传递一系列浮点数,作为创建和配置 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

属性类型: Bool

渲染器是否可见。

x_range_name

属性类型: String

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

y_range_name

属性类型: String

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

apply_theme(property_values)

应用一组主题值,这些值将被使用而不是默认值,但不会覆盖应用程序集值。

传入的字典可以保持原样,并与其他实例共享以节省内存(因此无论是调用方还是 HasProps 实例应该修改它)。

参数

property_values (dict) -- 主题值用于替代默认值

返回

没有

classmethod dataspecs()

收集所有人的名字 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称 DataSpec 性质

返回类型

set[str]

classmethod dataspecs_with_props()

收集一张记录所有人姓名的字典 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称和 DataSpec 性质

返回类型

dict[str, DataSpec]

equals(other)

模型的结构相等。

参数

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

返回

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

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

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

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

  • other (Model) -- 要链接到的Bokeh模型自我属性

  • other_attr (str) -- 上的财产 other 连接在一起

  • attr_selector (Union[int, str]) -- 链接可订阅项中的项的索引 attr

在版本1.1中添加

引发

ValueError --

实际案例

此代码与 js_link

select.js_link('value', plot, 'sizing_mode')

相当于:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外,要使用属性选择器将范围滑块的左侧附加到绘图的x_范围:

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, *callbacks)

附A 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)
layout(side, plot)
classmethod lookup(name)

找到 PropertyDescriptor 对于类上的Bokeh属性,给定属性名。

参数

name (str) -- 要搜索的属性的名称

返回

名为的属性的描述符 name

返回类型

PropertyDescriptor

on_change(attr, *callbacks)

在此对象上添加回调以在 attr 变化。

参数
  • attr (str) -- 此对象的属性名

  • *callbacks (callable) -- 要注册的回调函数

返回

没有

例子:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

收集此类的属性名称。

这种方法 任选地 遍历类层次结构并包含在任何父类上定义的属性。

参数

with_bases (bool, optional) -- 是否在结果中包含在父类上定义的属性。(默认值:True)

返回

属性名称

返回类型

set[str]

classmethod properties_containers()

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

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

容器属性名称

返回类型

set[str]

classmethod properties_with_refs()

收集该类上也有引用的所有属性的名称。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

具有引用的属性的名称

返回类型

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

收集将属性名称映射到其值的dict。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

跳过不可序列化的属性,属性值采用“序列化”格式,这可能与通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。

参数

include_defaults (bool, optional) -- 是否包含自创建对象后尚未显式设置的属性。(默认值:True)

返回

从属性名到属性值的映射

返回类型

dict

query_properties_with_values(query, include_defaults=True)

查询的属性值 HasProps 带有谓词的实例。

参数
  • query (callable) -- 接受属性描述符并返回True或False的可调用文件

  • include_defaults (bool, optional) -- 是否包含尚未由用户显式设置的属性(默认值:True)

返回

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

返回类型

dict

references()

返回全部 Models 此对象引用的。

remove_on_change(attr, *callbacks)

从此对象中删除回调

select(selector)

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

参数

selector (JSON-like) --

返回

SEQ [模型]

select_one(selector)

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

返回

模型

set_from_json(name, json, models=None, setter=None)

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

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

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

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

set_select(selector, updates)

更新与具有指定属性/值的给定选择器匹配的对象将更新。

参数
  • selector (JSON-like) --

  • updates (dict) --

返回

没有

themed_values()

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

结果以dict形式从属性名返回到值,或者 None 如果没有主题覆盖此实例的任何值。

返回

不记名

to_json(include_defaults)

返回此对象属性的字典,只包含“JSON类型”(string、number、boolean、none、dict、list)。

对其他对象的引用被序列化为“refs”(只是对象ID和类型信息),因此反序列化程序需要单独拥有这些其他对象的完整属性。

没有对应的 from_json() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

to_json_string(include_defaults)

返回编码此对象属性的JSON字符串。

对其他对象的引用被序列化为引用(仅对象ID和类型信息),因此反序列化程序将需要单独拥有这些其他对象的完整属性。

没有对应的 from_json_string() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

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

返回

没有

update(**kwargs)

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

返回

没有

实际案例

以下是等效的:

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)
update_from_json(json_attributes, models=None, setter=None)

对象的属性从字典中更新。

参数
  • json_attributes -- (JSON dict):要更新的属性和值

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

property document

这个 Document 此模型附加到(可以是 None

property struct

此模型的Bokeh协议“结构”,即以下形式的dict:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

此外,可能还有 subtype 字段(如果此模型是子类型)。

JSON Prototype
{
  "axis_label": "",
  "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_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,
  "bounds": "auto",
  "fixed_location": null,
  "formatter": {
    "id": "1841"
  },
  "id": "1839",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "guide",
  "major_label_orientation": "horizontal",
  "major_label_overrides": {},
  "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_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,
  "subscribed_events": [],
  "tags": [],
  "ticker": {
    "id": "1840"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}
class LogAxis(*args, **kwargs)[源代码]

基类:bokeh.models.axes.ContinuousAxis

在对数刻度上为刻度位置选取合适数字的轴。配置有 LogTickFormatter 默认情况下。

axis_label

属性类型: String

轴的文本标签,与轴规则平行显示。

注解

当前不支持LaTeX标记;请参阅 #647 跟踪进展或贡献。

axis_label_standoff

属性类型: Int

轴标签应偏移刻度标签的距离(以像素为单位)。

axis_label_text_align

属性类型: EnumTextAlign

轴标签的文本对齐。

axis_label_text_alpha

属性类型: Percent

轴标签的文本alpha。

axis_label_text_baseline

属性类型: EnumTextBaseline

轴标签的文本基线。

axis_label_text_color

属性类型: Color

轴标签的文本颜色。

axis_label_text_font

属性类型: String

轴标签的文本字体。

axis_label_text_font_size

属性类型: FontSize

轴标签的文本字体大小。

axis_label_text_font_style

属性类型: EnumFontStyle

轴标签的文本字体样式。

axis_label_text_line_height

属性类型: Float

轴标签的文本行高度。

axis_line_alpha

属性类型: Percent

轴线的alpha线。

axis_line_cap

属性类型: EnumLineCap

轴线的线帽。

axis_line_color

属性类型: Color

轴线的线条颜色。

axis_line_dash

属性类型: DashPattern

轴线的虚线。

axis_line_dash_offset

属性类型: Int

轴线的直线短划线偏移。

axis_line_join

属性类型: EnumLineJoin

轴线的连线。

axis_line_width

属性类型: Float

轴线的线宽。

bounds

属性类型: EitherAutoTupleFloatFloatTupleDatetimeDatetime ) )

渲染轴的边界。如果未设置,轴将跨越给定尺寸的整个绘图。

fixed_location

属性类型: EitherFloatStringTupleStringStringTupleStringStringString ) )

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

注解

当轴定位在中心打印区域内的固定位置时,轴标签将被抑制。

formatter

属性类型: InstanceTickFormatter

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

js_event_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

事件名称到列表的映射 CustomJS 回调。

通常,应该使用 Model.js_on_event 方法:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

属性名到列表的映射 CustomJS 回调,在创建文档时在BokehJS侧设置。

通常,应该使用 Model.js_on_change 方法:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
level

属性类型: EnumRenderLevel

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

major_label_orientation

属性类型: EitherEnum (枚举(水平、垂直)), Float

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

major_label_overrides

属性类型: DictEitherFloatStringString

为提供特定格式的常规位置的刻度标签。

major_label_standoff

属性类型: Int

主刻度标签应与关联刻度偏移的距离(以像素为单位)。

major_label_text_align

属性类型: EnumTextAlign

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

major_label_text_alpha

属性类型: Percent

主要刻度标签的文本alpha。

major_label_text_baseline

属性类型: EnumTextBaseline

主要刻度标签的文本基线。

major_label_text_color

属性类型: Color

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

major_label_text_font

属性类型: String

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

major_label_text_font_size

属性类型: FontSize

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

major_label_text_font_style

属性类型: EnumFontStyle

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

major_label_text_line_height

属性类型: Float

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

major_tick_in

属性类型: Int

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

major_tick_line_alpha

属性类型: Percent

主要刻度线的α线。

major_tick_line_cap

属性类型: EnumLineCap

主要刻度的线帽。

major_tick_line_color

属性类型: Color

主要刻度的线颜色。

major_tick_line_dash

属性类型: DashPattern

主要刻度线的破折号。

major_tick_line_dash_offset

属性类型: Int

主要刻度的线划线偏移量。

major_tick_line_join

属性类型: EnumLineJoin

主要刻度的线连接。

major_tick_line_width

属性类型: Float

主要刻度的线宽。

major_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

minor_tick_in

属性类型: Int

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

minor_tick_line_alpha

属性类型: Percent

小号记号的alpha线。

minor_tick_line_cap

属性类型: EnumLineCap

小号记号的行首。

minor_tick_line_color

属性类型: Color

次要刻度的线颜色。

minor_tick_line_dash

属性类型: DashPattern

小号记号的破折号。

minor_tick_line_dash_offset

属性类型: Int

次要记号的线短划线偏移。

minor_tick_line_join

属性类型: EnumLineJoin

次要记号的行连接。

minor_tick_line_width

属性类型: Float

次要刻度的线宽。

minor_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

name

属性类型: String

用户为此模型提供的任意名称。

当查询文档以检索特定的Bokeh模型时,这个名称非常有用。

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

注解

对于提供的任何名称,不提供唯一性保证或其他条件,Bokeh也不以任何理由直接使用该名称。

subscribed_events

属性类型: ListString

Python回调订阅的事件列表。对于这个模型,这是一组将从BokehJS传递回Python的事件。

tags

属性类型: ListAny

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

当查询文档以检索特定的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

属性类型: InstanceTicker

一种用于计算轴组件位置的记分器。

属性也可以传递一系列浮点数,作为创建和配置 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

属性类型: Bool

渲染器是否可见。

x_range_name

属性类型: String

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

y_range_name

属性类型: String

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

apply_theme(property_values)

应用一组主题值,这些值将被使用而不是默认值,但不会覆盖应用程序集值。

传入的字典可以保持原样,并与其他实例共享以节省内存(因此无论是调用方还是 HasProps 实例应该修改它)。

参数

property_values (dict) -- 主题值用于替代默认值

返回

没有

classmethod dataspecs()

收集所有人的名字 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称 DataSpec 性质

返回类型

set[str]

classmethod dataspecs_with_props()

收集一张记录所有人姓名的字典 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称和 DataSpec 性质

返回类型

dict[str, DataSpec]

equals(other)

模型的结构相等。

参数

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

返回

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

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

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

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

  • other (Model) -- 要链接到的Bokeh模型自我属性

  • other_attr (str) -- 上的财产 other 连接在一起

  • attr_selector (Union[int, str]) -- 链接可订阅项中的项的索引 attr

在版本1.1中添加

引发

ValueError --

实际案例

此代码与 js_link

select.js_link('value', plot, 'sizing_mode')

相当于:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外,要使用属性选择器将范围滑块的左侧附加到绘图的x_范围:

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, *callbacks)

附A 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)
layout(side, plot)
classmethod lookup(name)

找到 PropertyDescriptor 对于类上的Bokeh属性,给定属性名。

参数

name (str) -- 要搜索的属性的名称

返回

名为的属性的描述符 name

返回类型

PropertyDescriptor

on_change(attr, *callbacks)

在此对象上添加回调以在 attr 变化。

参数
  • attr (str) -- 此对象的属性名

  • *callbacks (callable) -- 要注册的回调函数

返回

没有

例子:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

收集此类的属性名称。

这种方法 任选地 遍历类层次结构并包含在任何父类上定义的属性。

参数

with_bases (bool, optional) -- 是否在结果中包含在父类上定义的属性。(默认值:True)

返回

属性名称

返回类型

set[str]

classmethod properties_containers()

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

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

容器属性名称

返回类型

set[str]

classmethod properties_with_refs()

收集该类上也有引用的所有属性的名称。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

具有引用的属性的名称

返回类型

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

收集将属性名称映射到其值的dict。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

跳过不可序列化的属性,属性值采用“序列化”格式,这可能与通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。

参数

include_defaults (bool, optional) -- 是否包含自创建对象后尚未显式设置的属性。(默认值:True)

返回

从属性名到属性值的映射

返回类型

dict

query_properties_with_values(query, include_defaults=True)

查询的属性值 HasProps 带有谓词的实例。

参数
  • query (callable) -- 接受属性描述符并返回True或False的可调用文件

  • include_defaults (bool, optional) -- 是否包含尚未由用户显式设置的属性(默认值:True)

返回

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

返回类型

dict

references()

返回全部 Models 此对象引用的。

remove_on_change(attr, *callbacks)

从此对象中删除回调

select(selector)

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

参数

selector (JSON-like) --

返回

SEQ [模型]

select_one(selector)

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

返回

模型

set_from_json(name, json, models=None, setter=None)

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

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

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

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

set_select(selector, updates)

更新与具有指定属性/值的给定选择器匹配的对象将更新。

参数
  • selector (JSON-like) --

  • updates (dict) --

返回

没有

themed_values()

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

结果以dict形式从属性名返回到值,或者 None 如果没有主题覆盖此实例的任何值。

返回

不记名

to_json(include_defaults)

返回此对象属性的字典,只包含“JSON类型”(string、number、boolean、none、dict、list)。

对其他对象的引用被序列化为“refs”(只是对象ID和类型信息),因此反序列化程序需要单独拥有这些其他对象的完整属性。

没有对应的 from_json() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

to_json_string(include_defaults)

返回编码此对象属性的JSON字符串。

对其他对象的引用被序列化为引用(仅对象ID和类型信息),因此反序列化程序将需要单独拥有这些其他对象的完整属性。

没有对应的 from_json_string() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

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

返回

没有

update(**kwargs)

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

返回

没有

实际案例

以下是等效的:

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)
update_from_json(json_attributes, models=None, setter=None)

对象的属性从字典中更新。

参数
  • json_attributes -- (JSON dict):要更新的属性和值

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

property document

这个 Document 此模型附加到(可以是 None

property struct

此模型的Bokeh协议“结构”,即以下形式的dict:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

此外,可能还有 subtype 字段(如果此模型是子类型)。

JSON Prototype
{
  "axis_label": "",
  "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_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,
  "bounds": "auto",
  "fixed_location": null,
  "formatter": {
    "id": "1903"
  },
  "id": "1901",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "guide",
  "major_label_orientation": "horizontal",
  "major_label_overrides": {},
  "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_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,
  "subscribed_events": [],
  "tags": [],
  "ticker": {
    "id": "1902"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}
class MercatorAxis(*args, **kwargs)[源代码]

基类:bokeh.models.axes.LinearAxis

在墨卡托刻度上为刻度位置选取合适数字的轴。配置有 MercatorTickFormatter 默认情况下。

参数

dimension ('lat' or 'lon', optional) -- 此轴将显示纬度值还是经度值。(默认值:“lat”)

axis_label

属性类型: String

轴的文本标签,与轴规则平行显示。

注解

当前不支持LaTeX标记;请参阅 #647 跟踪进展或贡献。

axis_label_standoff

属性类型: Int

轴标签应偏移刻度标签的距离(以像素为单位)。

axis_label_text_align

属性类型: EnumTextAlign

轴标签的文本对齐。

axis_label_text_alpha

属性类型: Percent

轴标签的文本alpha。

axis_label_text_baseline

属性类型: EnumTextBaseline

轴标签的文本基线。

axis_label_text_color

属性类型: Color

轴标签的文本颜色。

axis_label_text_font

属性类型: String

轴标签的文本字体。

axis_label_text_font_size

属性类型: FontSize

轴标签的文本字体大小。

axis_label_text_font_style

属性类型: EnumFontStyle

轴标签的文本字体样式。

axis_label_text_line_height

属性类型: Float

轴标签的文本行高度。

axis_line_alpha

属性类型: Percent

轴线的alpha线。

axis_line_cap

属性类型: EnumLineCap

轴线的线帽。

axis_line_color

属性类型: Color

轴线的线条颜色。

axis_line_dash

属性类型: DashPattern

轴线的虚线。

axis_line_dash_offset

属性类型: Int

轴线的直线短划线偏移。

axis_line_join

属性类型: EnumLineJoin

轴线的连线。

axis_line_width

属性类型: Float

轴线的线宽。

bounds

属性类型: EitherAutoTupleFloatFloatTupleDatetimeDatetime ) )

渲染轴的边界。如果未设置,轴将跨越给定尺寸的整个绘图。

fixed_location

属性类型: EitherFloatStringTupleStringStringTupleStringStringString ) )

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

注解

当轴定位在中心打印区域内的固定位置时,轴标签将被抑制。

formatter

属性类型: InstanceTickFormatter

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

js_event_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

事件名称到列表的映射 CustomJS 回调。

通常,应该使用 Model.js_on_event 方法:

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

属性类型: DictStringListInstanceCustomJS ) ) )

属性名到列表的映射 CustomJS 回调,在创建文档时在BokehJS侧设置。

通常,应该使用 Model.js_on_change 方法:

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
level

属性类型: EnumRenderLevel

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

major_label_orientation

属性类型: EitherEnum (枚举(水平、垂直)), Float

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

major_label_overrides

属性类型: DictEitherFloatStringString

为提供特定格式的常规位置的刻度标签。

major_label_standoff

属性类型: Int

主刻度标签应与关联刻度偏移的距离(以像素为单位)。

major_label_text_align

属性类型: EnumTextAlign

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

major_label_text_alpha

属性类型: Percent

主要刻度标签的文本alpha。

major_label_text_baseline

属性类型: EnumTextBaseline

主要刻度标签的文本基线。

major_label_text_color

属性类型: Color

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

major_label_text_font

属性类型: String

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

major_label_text_font_size

属性类型: FontSize

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

major_label_text_font_style

属性类型: EnumFontStyle

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

major_label_text_line_height

属性类型: Float

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

major_tick_in

属性类型: Int

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

major_tick_line_alpha

属性类型: Percent

主要刻度线的α线。

major_tick_line_cap

属性类型: EnumLineCap

主要刻度的线帽。

major_tick_line_color

属性类型: Color

主要刻度的线颜色。

major_tick_line_dash

属性类型: DashPattern

主要刻度线的破折号。

major_tick_line_dash_offset

属性类型: Int

主要刻度的线划线偏移量。

major_tick_line_join

属性类型: EnumLineJoin

主要刻度的线连接。

major_tick_line_width

属性类型: Float

主要刻度的线宽。

major_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

minor_tick_in

属性类型: Int

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

minor_tick_line_alpha

属性类型: Percent

小号记号的alpha线。

minor_tick_line_cap

属性类型: EnumLineCap

小号记号的行首。

minor_tick_line_color

属性类型: Color

次要刻度的线颜色。

minor_tick_line_dash

属性类型: DashPattern

小号记号的破折号。

minor_tick_line_dash_offset

属性类型: Int

次要记号的线短划线偏移。

minor_tick_line_join

属性类型: EnumLineJoin

次要记号的行连接。

minor_tick_line_width

属性类型: Float

次要刻度的线宽。

minor_tick_out

属性类型: Int

主刻度应该延伸到主绘图区域之外的距离(以像素为单位)。

name

属性类型: String

用户为此模型提供的任意名称。

当查询文档以检索特定的Bokeh模型时,这个名称非常有用。

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

注解

对于提供的任何名称,不提供唯一性保证或其他条件,Bokeh也不以任何理由直接使用该名称。

subscribed_events

属性类型: ListString

Python回调订阅的事件列表。对于这个模型,这是一组将从BokehJS传递回Python的事件。

tags

属性类型: ListAny

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

当查询文档以检索特定的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

属性类型: InstanceTicker

一种用于计算轴组件位置的记分器。

属性也可以传递一系列浮点数,作为创建和配置 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

属性类型: Bool

渲染器是否可见。

x_range_name

属性类型: String

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

y_range_name

属性类型: String

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

apply_theme(property_values)

应用一组主题值,这些值将被使用而不是默认值,但不会覆盖应用程序集值。

传入的字典可以保持原样,并与其他实例共享以节省内存(因此无论是调用方还是 HasProps 实例应该修改它)。

参数

property_values (dict) -- 主题值用于替代默认值

返回

没有

classmethod dataspecs()

收集所有人的名字 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称 DataSpec 性质

返回类型

set[str]

classmethod dataspecs_with_props()

收集一张记录所有人姓名的字典 DataSpec 类的属性。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

名称和 DataSpec 性质

返回类型

dict[str, DataSpec]

equals(other)

模型的结构相等。

参数

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

返回

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

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

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

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

  • other (Model) -- 要链接到的Bokeh模型自我属性

  • other_attr (str) -- 上的财产 other 连接在一起

  • attr_selector (Union[int, str]) -- 链接可订阅项中的项的索引 attr

在版本1.1中添加

引发

ValueError --

实际案例

此代码与 js_link

select.js_link('value', plot, 'sizing_mode')

相当于:

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外,要使用属性选择器将范围滑块的左侧附加到绘图的x_范围:

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, *callbacks)

附A 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)
layout(side, plot)
classmethod lookup(name)

找到 PropertyDescriptor 对于类上的Bokeh属性,给定属性名。

参数

name (str) -- 要搜索的属性的名称

返回

名为的属性的描述符 name

返回类型

PropertyDescriptor

on_change(attr, *callbacks)

在此对象上添加回调以在 attr 变化。

参数
  • attr (str) -- 此对象的属性名

  • *callbacks (callable) -- 要注册的回调函数

返回

没有

例子:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

收集此类的属性名称。

这种方法 任选地 遍历类层次结构并包含在任何父类上定义的属性。

参数

with_bases (bool, optional) -- 是否在结果中包含在父类上定义的属性。(默认值:True)

返回

属性名称

返回类型

set[str]

classmethod properties_containers()

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

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

容器属性名称

返回类型

set[str]

classmethod properties_with_refs()

收集该类上也有引用的所有属性的名称。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

返回

具有引用的属性的名称

返回类型

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

收集将属性名称映射到其值的dict。

这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。

跳过不可序列化的属性,属性值采用“序列化”格式,这可能与通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。

参数

include_defaults (bool, optional) -- 是否包含自创建对象后尚未显式设置的属性。(默认值:True)

返回

从属性名到属性值的映射

返回类型

dict

query_properties_with_values(query, include_defaults=True)

查询的属性值 HasProps 带有谓词的实例。

参数
  • query (callable) -- 接受属性描述符并返回True或False的可调用文件

  • include_defaults (bool, optional) -- 是否包含尚未由用户显式设置的属性(默认值:True)

返回

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

返回类型

dict

references()

返回全部 Models 此对象引用的。

remove_on_change(attr, *callbacks)

从此对象中删除回调

select(selector)

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

参数

selector (JSON-like) --

返回

SEQ [模型]

select_one(selector)

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

返回

模型

set_from_json(name, json, models=None, setter=None)

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

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

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

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

set_select(selector, updates)

更新与具有指定属性/值的给定选择器匹配的对象将更新。

参数
  • selector (JSON-like) --

  • updates (dict) --

返回

没有

themed_values()

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

结果以dict形式从属性名返回到值,或者 None 如果没有主题覆盖此实例的任何值。

返回

不记名

to_json(include_defaults)

返回此对象属性的字典,只包含“JSON类型”(string、number、boolean、none、dict、list)。

对其他对象的引用被序列化为“refs”(只是对象ID和类型信息),因此反序列化程序需要单独拥有这些其他对象的完整属性。

没有对应的 from_json() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

to_json_string(include_defaults)

返回编码此对象属性的JSON字符串。

对其他对象的引用被序列化为引用(仅对象ID和类型信息),因此反序列化程序将需要单独拥有这些其他对象的完整属性。

没有对应的 from_json_string() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。

在大多数情况下,最好序列化和反序列化整个文档。

参数

include_defaults (bool) -- 是否包含未从默认值更改的属性

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

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

返回

没有

update(**kwargs)

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

返回

没有

实际案例

以下是等效的:

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)
update_from_json(json_attributes, models=None, setter=None)

对象的属性从字典中更新。

参数
  • json_attributes -- (JSON dict):要更新的属性和值

  • models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。

  • setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。

返回

没有

property document

这个 Document 此模型附加到(可以是 None

property struct

此模型的Bokeh协议“结构”,即以下形式的dict:

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

此外,可能还有 subtype 字段(如果此模型是子类型)。

JSON Prototype
{
  "axis_label": "",
  "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_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,
  "bounds": "auto",
  "fixed_location": null,
  "formatter": {
    "id": "1966"
  },
  "id": "1963",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "guide",
  "major_label_orientation": "horizontal",
  "major_label_overrides": {},
  "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_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,
  "subscribed_events": [],
  "tags": [],
  "ticker": {
    "id": "1964"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}