bokeh.models.widgets.tables<a class="headerlink" href="#bokeh-models-widgets-tables" title="永久链接至标题">¶

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 字段（如果此模型是子类型）。

{
  "field_": "",
  "id": "9790",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.models.widgets.tables.CellFormatter

布尔（复选标记）单元格格式设置程序。

icon¶

属性类型： Enum （枚举（check，check circle，check-circle-o，check-square，check-square-o））

显示复选标记的图标。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "icon": "check",
  "id": "9797",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.model.Model

数据表单元格编辑器的抽象基类。

注解

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

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "9804",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.model.Model

数据表单元格格式设置程序的抽象基类。

注解

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

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "9810",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

布尔值单元格编辑器。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "9816",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.models.widgets.tables.DataTable

具有可折叠组、总计和小计的专用数据表。

align¶

属性类型： Either （ Enum （ Align ） Tuple （ Enum （ Align ） Enum （ Align ) ) )

父容器中的对齐点。

如果布局是这个元素的一个子元素，那么这个布局是有用的。自对齐可以被父容器覆盖（例如网格跟踪对齐）。

aspect_ratio¶

属性类型： Either （ Enum （枚举（自动））， Float ）

描述组件的宽度和高度之间的比例关系。

如果任何一个组件的尺寸在尺寸上是灵活的，这就可以了。如果设置为数字， width / height = aspect_ratio 关系将得到维持。否则，如果设置为 "auto" ，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不保留纵横比）。

auto_edit¶

属性类型： Bool

启用时编辑模式在单击表格单元格后启用。

autosize_mode¶

属性类型： Enum （ AutosizeMode ）

使用以下选项之一描述列自动调整大小模式：

"fit_columns": 根据单元格内容计算列宽，但要确保表格适合可用的视口。这会导致没有水平滚动条显示，但是如果没有足够的可用空间，数据可能无法读取。
"fit_viewport": 根据单元格内容计算列宽后调整视口大小。
"force_fit": 将列调整到可用空间中，将表宽度平均分配到各个列上（相当于 fit_columns=True ). 这会导致没有水平滚动条显示，但是如果没有足够的可用空间，数据可能无法读取。
"none": 不要自动计算列宽。

background¶

属性类型： Color

组件的背景色。

columns¶

属性类型： List （ Instance （ TableColumn ) )

子列小部件的列表。

css_classes¶

属性类型： List （ String ）

要添加到此DOM元素的CSS类名的列表。注意：类名只是按原样添加，不提供其他保证。

也允许从元组赋值，但是这些元组是经过调整的——属性将始终包含一个列表。

default_size¶

属性类型： Int

主维度中的默认大小（宽度或高度）。

主导维度由控件方向决定。

disabled¶

属性类型： Bool

小部件在呈现时是否被禁用。

如果 True ，小部件将变灰，并且不会响应UI事件。

editable¶

属性类型： Bool

允许编辑表的内容。需要在需要编辑的列上配置单元格编辑器。

fit_columns¶

属性类型： Bool

列是否应适合可用宽度。这会导致没有水平滚动条显示，但是如果没有足够的可用空间，数据可能无法读取。如果设置为 True ，列的宽度被理解为最大宽度。

frozen_columns¶

属性类型： Int

整数，指示要冻结的列数。如果设置了，前N列将被冻结，这将防止它们滚动到帧外。

frozen_rows¶

属性类型： Int

整数，指示要冻结的行数。如果设置为负值，前N行将被冻结，以防止它们在帧外滚动；如果设置为负值，最后N行将被冻结。

grouping¶

属性类型： List （ Instance （ GroupingInfo ) )

描述用于定义小计和总计的聚合操作

header_row¶

属性类型： Bool

是否在表的顶部显示具有列名的标题行。

height¶

属性类型： NonNegativeInt

高度（像素）。

这可以是固定高度，也可以是首选高度，具体取决于高度大小调整策略。

height_policy¶

属性类型： Either （ Auto ， Enum （ SizingPolicy ) )

描述组件应如何保持其高度。

"auto": 使用组件的首选大小策略。
"fixed": 准确使用 height 像素。如果组件不能容纳在可用的垂直空间中，它将溢出。
"fit": 使用组件的首选高度（如果设置）并允许在最小和最大高度边界（如果设置）内适合可用的垂直空间。组件的高度既不会被激进地最小化也不会被最大化。
"min": 使用尽可能少的垂直空间，不小于最小高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会收缩或增长，这取决于父布局、方面管理和其他因素。
"max": 使用尽可能多的垂直空间，不超过最大高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会收缩或增长，这取决于父布局、方面管理和其他因素。

注解

这是一个实验特性，将来可能会改变。你可以随意使用。喜欢使用 sizing_mode 如果这种程度的控制不是绝对必要的。

index_header¶

属性类型： String

要为索引列显示的列标题（如果存在）。

index_position¶

属性类型： Int

在列列表中插入显示行索引的列。支持负索引，并从列列表的末尾指定索引位置（即标准Python行为）。

若要防止添加索引列，请将其设置为“无”。

如果索引位置的绝对值大于列的长度，则索引将根据符号显示在开始或结尾。

index_width¶

属性类型： Int

索引列的宽度（如果存在）。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

margin¶

属性类型： Tuple （ Int ， Int ， Int ， Int ）

允许在组件周围创建额外的空间。元组中的值按如下顺序排列-上边距、右边距、下边距和左边距，类似于CSS标准。负边距值可用于从任何方向收缩空间。

max_height¶

属性类型： NonNegativeInt

如果高度可调，组件的最大高度（以像素为单位）。

max_width¶

属性类型： NonNegativeInt

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height¶

属性类型： NonNegativeInt

如果高度可调，组件的最小高度（以像素为单位）。

min_width¶

属性类型： NonNegativeInt

如果宽度可调，组件的最小宽度（以像素为单位）。

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也不以任何理由直接使用该名称。

orientation¶

属性类型： Enum （枚举（水平、垂直））

水平（默认）或垂直调整小部件的方向。

注意并不是所有的小部件都支持垂直方向。

reorderable¶

属性类型： Bool

允许对表的列重新排序。重新排列表格的位置，然后拖动表格的标题。两边的列将保持原来的顺序。

row_height¶

属性类型： Int

每行的高度（以像素为单位）。

scroll_to_selection¶

属性类型： Bool

每当在数据源上进行选择时，如果视口中没有选定的行，请将选定的行滚动到表的视口中。

selectable¶

属性类型： Either （ Bool ， Enum （枚举（复选框）））

是否可以选择表的行。使用 checkbox 相当于 True ，但通过每行的复选框显示所选内容，而不是突出显示行。允许多选，可以通过单击多个复选框（如果启用）或按住Shift键并单击行来实现。

sizing_mode¶

属性类型： Enum （ SizingMode ）

组件的大小。

这是一个高级设置，用于保持组件的宽度和高度。要获得对大小的更细粒度控制，请使用 width_policy ， height_policy 和 aspect_ratio 相反（这些优先于 sizing_mode ）

可能的情况：

"fixed": 组件没有响应。它将保留其原始的宽度和高度，而不考虑任何后续的浏览器窗口调整事件。
"stretch_width": 组件将相应地调整大小以拉伸到可用的宽度，而不保持任何宽高比。组件的高度取决于组件的类型，可以固定或适合组件的内容。
"stretch_height": 组件将相应地调整大小以拉伸到可用的高度，而不保持任何纵横比。组件的宽度取决于组件的类型，可以固定或适合组件的内容。
"stretch_both": 如果纵横比是独立的，那么纵横比会完全占据垂直部分的空间。
"scale_width": 组件将相应地调整大小以拉伸到可用的宽度，同时保持原始或提供的纵横比。
"scale_height": 组件将相应地调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。
"scale_both": 组件将相应地调整到可用的宽度和高度，同时保持原始或提供的纵横比。

sortable¶

属性类型： Bool

允许对表的内容进行排序。默认情况下，自然秩序保持不变。要对列进行排序，请单击其标题。再单击一次可更改排序方向。使用Ctrl+单击可返回到自然顺序。使用Shift+单击可同时对多个列进行排序。

source¶

属性类型： Instance （ DataSource ）

小部件的数据源。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

target¶

属性类型： Instance （ DataSource ）

两列数据源（row_indexes&labels），描述数据多维数据集的哪些行被展开或折叠

view¶

属性类型： Instance （ CDSView ）

呈现表行时要使用的数据源视图。如果在初始化期间没有传入视图，则会创建整个数据源的默认视图。

visible¶

属性类型： Bool

组件是否可见以及是否是布局的一部分。

width¶

属性类型： NonNegativeInt

组件的宽度（以像素为单位）。

这可以是固定宽度，也可以是首选宽度，具体取决于宽度大小调整策略。

width_policy¶

属性类型： Either （ Auto ， Enum （ SizingPolicy ) )

描述组件应如何保持其宽度。

"auto": 使用组件的首选大小策略。
"fixed": 准确使用 width 像素。如果组件不能容纳在可用的水平空间中，它将溢出。
"fit": 使用组件的首选宽度（如果设置），并允许它在最小和最大宽度范围内（如果设置）适合可用的水平空间。组件的宽度既不会被积极地最小化也不会被最大化。
"min": 尽可能少地使用水平空间，不小于最小宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会根据父布局、方面管理和其他因素而缩小或增大。
"max": 使用尽可能多的水平空间，不超过最大宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会收缩或增长，这取决于父布局、方面管理和其他因素。

注解

这是一个实验特性，将来可能会改变。你可以随意使用。喜欢使用 sizing_mode 如果这种程度的控制不是绝对必要的。

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "align": "start",
  "aspect_ratio": null,
  "auto_edit": false,
  "autosize_mode": "force_fit",
  "background": null,
  "columns": [],
  "css_classes": [],
  "default_size": 300,
  "disabled": false,
  "editable": false,
  "fit_columns": null,
  "frozen_columns": null,
  "frozen_rows": null,
  "grouping": [],
  "header_row": true,
  "height": 400,
  "height_policy": "auto",
  "id": "9822",
  "index_header": "#",
  "index_position": 0,
  "index_width": 40,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "margin": [
    5,
    5,
    5,
    5
  ],
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "orientation": "horizontal",
  "reorderable": true,
  "row_height": 25,
  "scroll_to_selection": true,
  "selectable": true,
  "sizing_mode": null,
  "sortable": true,
  "source": null,
  "subscribed_events": [],
  "tags": [],
  "target": null,
  "view": {
    "id": "9823"
  },
  "visible": true,
  "width": 600,
  "width_policy": "auto"
}

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

基类：bokeh.models.widgets.tables.TableWidget

用于可视化和编辑大量数据的二维网格。

align¶

属性类型： Either （ Enum （ Align ） Tuple （ Enum （ Align ） Enum （ Align ) ) )

父容器中的对齐点。

如果布局是这个元素的一个子元素，那么这个布局是有用的。自对齐可以被父容器覆盖（例如网格跟踪对齐）。

aspect_ratio¶

属性类型： Either （ Enum （枚举（自动））， Float ）

描述组件的宽度和高度之间的比例关系。

如果任何一个组件的尺寸在尺寸上是灵活的，这就可以了。如果设置为数字， width / height = aspect_ratio 关系将得到维持。否则，如果设置为 "auto" ，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不保留纵横比）。

auto_edit¶

属性类型： Bool

启用时编辑模式在单击表格单元格后启用。

autosize_mode¶

属性类型： Enum （ AutosizeMode ）

使用以下选项之一描述列自动调整大小模式：

"fit_columns": 根据单元格内容计算列宽，但要确保表格适合可用的视口。这会导致没有水平滚动条显示，但是如果没有足够的可用空间，数据可能无法读取。
"fit_viewport": 根据单元格内容计算列宽后调整视口大小。
"force_fit": 将列调整到可用空间中，将表宽度平均分配到各个列上（相当于 fit_columns=True ). 这会导致没有水平滚动条显示，但是如果没有足够的可用空间，数据可能无法读取。
"none": 不要自动计算列宽。

background¶

属性类型： Color

组件的背景色。

columns¶

属性类型： List （ Instance （ TableColumn ) )

子列小部件的列表。

css_classes¶

属性类型： List （ String ）

要添加到此DOM元素的CSS类名的列表。注意：类名只是按原样添加，不提供其他保证。

也允许从元组赋值，但是这些元组是经过调整的——属性将始终包含一个列表。

default_size¶

属性类型： Int

主维度中的默认大小（宽度或高度）。

主导维度由控件方向决定。

disabled¶

属性类型： Bool

小部件在呈现时是否被禁用。

如果 True ，小部件将变灰，并且不会响应UI事件。

editable¶

属性类型： Bool

允许编辑表的内容。需要在需要编辑的列上配置单元格编辑器。

fit_columns¶

属性类型： Bool

列是否应适合可用宽度。这会导致没有水平滚动条显示，但是如果没有足够的可用空间，数据可能无法读取。如果设置为 True ，列的宽度被理解为最大宽度。

frozen_columns¶

属性类型： Int

整数，指示要冻结的列数。如果设置了，前N列将被冻结，这将防止它们滚动到帧外。

frozen_rows¶

属性类型： Int

整数，指示要冻结的行数。如果设置为负值，前N行将被冻结，以防止它们在帧外滚动；如果设置为负值，最后N行将被冻结。

header_row¶

属性类型： Bool

是否在表的顶部显示具有列名的标题行。

height¶

属性类型： NonNegativeInt

高度（像素）。

这可以是固定高度，也可以是首选高度，具体取决于高度大小调整策略。

height_policy¶

属性类型： Either （ Auto ， Enum （ SizingPolicy ) )

描述组件应如何保持其高度。

"auto": 使用组件的首选大小策略。
"fixed": 准确使用 height 像素。如果组件不能容纳在可用的垂直空间中，它将溢出。
"fit": 使用组件的首选高度（如果设置）并允许在最小和最大高度边界（如果设置）内适合可用的垂直空间。组件的高度既不会被激进地最小化也不会被最大化。
"min": 使用尽可能少的垂直空间，不小于最小高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会收缩或增长，这取决于父布局、方面管理和其他因素。
"max": 使用尽可能多的垂直空间，不超过最大高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会收缩或增长，这取决于父布局、方面管理和其他因素。

注解

这是一个实验特性，将来可能会改变。你可以随意使用。喜欢使用 sizing_mode 如果这种程度的控制不是绝对必要的。

index_header¶

属性类型： String

要为索引列显示的列标题（如果存在）。

index_position¶

属性类型： Int

在列列表中插入显示行索引的列。支持负索引，并从列列表的末尾指定索引位置（即标准Python行为）。

若要防止添加索引列，请将其设置为“无”。

如果索引位置的绝对值大于列的长度，则索引将根据符号显示在开始或结尾。

index_width¶

属性类型： Int

索引列的宽度（如果存在）。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

margin¶

属性类型： Tuple （ Int ， Int ， Int ， Int ）

允许在组件周围创建额外的空间。元组中的值按如下顺序排列-上边距、右边距、下边距和左边距，类似于CSS标准。负边距值可用于从任何方向收缩空间。

max_height¶

属性类型： NonNegativeInt

如果高度可调，组件的最大高度（以像素为单位）。

max_width¶

属性类型： NonNegativeInt

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height¶

属性类型： NonNegativeInt

如果高度可调，组件的最小高度（以像素为单位）。

min_width¶

属性类型： NonNegativeInt

如果宽度可调，组件的最小宽度（以像素为单位）。

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也不以任何理由直接使用该名称。

orientation¶

属性类型： Enum （枚举（水平、垂直））

水平（默认）或垂直调整小部件的方向。

注意并不是所有的小部件都支持垂直方向。

reorderable¶

属性类型： Bool

允许对表的列重新排序。重新排列表格的位置，然后拖动表格的标题。两边的列将保持原来的顺序。

row_height¶

属性类型： Int

每行的高度（以像素为单位）。

scroll_to_selection¶

属性类型： Bool

每当在数据源上进行选择时，如果视口中没有选定的行，请将选定的行滚动到表的视口中。

selectable¶

属性类型： Either （ Bool ， Enum （枚举（复选框）））

是否可以选择表的行。使用 checkbox 相当于 True ，但通过每行的复选框显示所选内容，而不是突出显示行。允许多选，可以通过单击多个复选框（如果启用）或按住Shift键并单击行来实现。

sizing_mode¶

属性类型： Enum （ SizingMode ）

组件的大小。

这是一个高级设置，用于保持组件的宽度和高度。要获得对大小的更细粒度控制，请使用 width_policy ， height_policy 和 aspect_ratio 相反（这些优先于 sizing_mode ）

可能的情况：

"fixed": 组件没有响应。它将保留其原始的宽度和高度，而不考虑任何后续的浏览器窗口调整事件。
"stretch_width": 组件将相应地调整大小以拉伸到可用的宽度，而不保持任何宽高比。组件的高度取决于组件的类型，可以固定或适合组件的内容。
"stretch_height": 组件将相应地调整大小以拉伸到可用的高度，而不保持任何纵横比。组件的宽度取决于组件的类型，可以固定或适合组件的内容。
"stretch_both": 如果纵横比是独立的，那么纵横比会完全占据垂直部分的空间。
"scale_width": 组件将相应地调整大小以拉伸到可用的宽度，同时保持原始或提供的纵横比。
"scale_height": 组件将相应地调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。
"scale_both": 组件将相应地调整到可用的宽度和高度，同时保持原始或提供的纵横比。

sortable¶

属性类型： Bool

允许对表的内容进行排序。默认情况下，自然秩序保持不变。要对列进行排序，请单击其标题。再单击一次可更改排序方向。使用Ctrl+单击可返回到自然顺序。使用Shift+单击可同时对多个列进行排序。

source¶

属性类型： Instance （ DataSource ）

小部件的数据源。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

view¶

属性类型： Instance （ CDSView ）

呈现表行时要使用的数据源视图。如果在初始化期间没有传入视图，则会创建整个数据源的默认视图。

visible¶

属性类型： Bool

组件是否可见以及是否是布局的一部分。

width¶

属性类型： NonNegativeInt

组件的宽度（以像素为单位）。

这可以是固定宽度，也可以是首选宽度，具体取决于宽度大小调整策略。

width_policy¶

属性类型： Either （ Auto ， Enum （ SizingPolicy ) )

描述组件应如何保持其宽度。

"auto": 使用组件的首选大小策略。
"fixed": 准确使用 width 像素。如果组件不能容纳在可用的水平空间中，它将溢出。
"fit": 使用组件的首选宽度（如果设置），并允许它在最小和最大宽度范围内（如果设置）适合可用的水平空间。组件的宽度既不会被积极地最小化也不会被最大化。
"min": 尽可能少地使用水平空间，不小于最小宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会根据父布局、方面管理和其他因素而缩小或增大。
"max": 使用尽可能多的水平空间，不超过最大宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会收缩或增长，这取决于父布局、方面管理和其他因素。

注解

这是一个实验特性，将来可能会改变。你可以随意使用。喜欢使用 sizing_mode 如果这种程度的控制不是绝对必要的。

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "align": "start",
  "aspect_ratio": null,
  "auto_edit": false,
  "autosize_mode": "force_fit",
  "background": null,
  "columns": [],
  "css_classes": [],
  "default_size": 300,
  "disabled": false,
  "editable": false,
  "fit_columns": null,
  "frozen_columns": null,
  "frozen_rows": null,
  "header_row": true,
  "height": 400,
  "height_policy": "auto",
  "id": "9910",
  "index_header": "#",
  "index_position": 0,
  "index_width": 40,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "margin": [
    5,
    5,
    5,
    5
  ],
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "orientation": "horizontal",
  "reorderable": true,
  "row_height": 25,
  "scroll_to_selection": true,
  "selectable": true,
  "sizing_mode": null,
  "sortable": true,
  "source": null,
  "subscribed_events": [],
  "tags": [],
  "view": {
    "id": "9911"
  },
  "visible": true,
  "width": 600,
  "width_policy": "auto"
}

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

基于日历的日期单元格编辑器。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "9994",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.models.widgets.tables.StringFormatter

日期单元格格式化程序。

font_style¶

属性类型： Enum （ FontStyle ）

可选的文本字体样式，例如粗体、斜体。

format¶

属性类型： Either （ Enum （ DateFormat ） String ）

日期格式可以是任何标准格式 strftime 格式字符串以及以下任何预定义格式名称：

格式名称	设置字符串格式	输出示例
`ATOM` / `W3C` / `RFC-3339` / `ISO-8601`	`"%Y-%m-%d"`	2014-03-01
`COOKIE`	`"%a, %d %b %Y"`	2014年3月1日星期六
`RFC-850`	`"%A, %d-%b-%y"`	2014年3月1日，星期六
`RFC-1123` / `RFC-2822`	`"%a, %e %b %Y"`	2014年3月1日星期六
`RSS` / `RFC-822` / `RFC-1036`	`"%a, %e %b %y"`	2014年3月1日星期六
`TIMESTAMP`	（自纪元起毫秒）	1393632000000

请注意，在表中，有些格式名是同义的，格式名相同，用斜杠隔开。

支持的列表 strftime 格式代码如下所示。

%a: 根据当前区域设置的星期几的缩写名称。
%A: 根据当前区域设置的星期几的全名。
%b: 根据当前区域设置的缩写月份名称。
%B: 根据当前区域设置的完整月份名称。
%c: 当前区域设置的首选日期和时间表示形式。
%C: 世纪数（年/100）为2位整数。
%d: 以十进制数表示的月份的日期（范围01到31）。
%D: 相当于%m/%d/%y。（美国人应该注意，在许多其他国家%d/%m/%y是相当常见的。这意味着在国际环境中，这种格式模糊不清，不应使用。）
%e: 像%d一样，月份的日期是十进制数，但是前导的零会被空格替换。
%F: 微秒作为十进制数，在左边填充零（范围000000-999999）。这是对可用于的一组指令的扩展 timezone .
%F: 相当于%Y-%m-%d（ISO 8601日期格式）。
%G: 以星期为基础的ISO8601年，以世纪为十进制数。与ISO周数相对应的4位数年份（请参见%V）。它的格式和值与%Y相同，只是如果ISO周数属于上一年或下一年，则使用该年。
%g: 像%G，但是没有世纪，也就是说，有2位数的年份（00-99）。
%H: 相当于%b。
%H: 使用24小时制时钟（范围从00到23）的十进制小时数。
%我: 使用12小时时钟（范围01到12）将小时作为十进制数。
%j: 以十进制数表示的一年中的某一天（范围001到366）。
%K: 小时（24小时制）十进制数（范围0到23）。个位数前面有一个空格。（另请参见%H。）
%我: 小时（12小时时钟）作为十进制数（范围1到12）。个位数前面有一个空格。（另请参阅%I.）（TZ）
%米: 以十进制数表示的月份（范围01到12）。
%米: 以十进制数表示的分钟（范围从00到59）。
%n: 换行符。Bokeh文本当前不支持换行符。
%N: 纳秒作为十进制数，在左边填充零（范围000000000-99999999）。支持填充宽度说明符，即%3N显示3个最左边的数字。但是，由于 timezone .
%p: 根据给定的时间值“AM”或“PM”，或当前区域设置的相应字符串。中午被视为“下午”，午夜被视为“上午”。
%P: 与%p类似，但小写：“am”或“pm”或当前区域设置的相应字符串。
%r: 以上午或下午表示的时间。在POSIX区域设置中，这相当于%I:%M:%S%p。
%R: 以24小时表示的时间（%H:%M）。有关包含秒数的版本，请参阅下面的%T。
%S: 自纪元以来的秒数，1970-01-01 00:00:00+0000（UTC）。
%S: 第二个是十进制数（范围从00到60）。（该范围最大为60，以允许偶尔的闰秒。）
%T: 制表符。Bokeh文本当前不支持制表符。
%T: 以24小时表示的时间（%H:%M:%S）。
%美国: 以十进制形式表示的星期几，范围为1到7，星期一为1。另请参见%w。
%美国: 当前年度的周数（十进制数），范围从00到53，从第一个星期日开始作为第01周的第一天。另请参见%V和%W。
%五: 当前年份的ISO 8601周数（见注释）为十进制数，范围为01到53，其中第1周是新年中至少有4天的第一周。另请参见%U和%W。
%W: 以十进制形式表示的星期几，范围为0到6，星期日为0。另请参见%u。
%W: 当前年度的周数（十进制数），范围从00到53，从第一个星期一开始是第01周的第一天。
%x: 不带时间的当前区域设置的首选日期表示形式。
%x: 不带日期的当前区域设置的首选时间表示形式。
%Y: 以十进制数字表示的年份，没有世纪（范围从00到99）。
%Y: 年包括十进制数。
%z: +hhmm或-hhmm数字时区（即UTC的小时和分钟偏移量）。
%Z: 时区名称或缩写。

%%: 文本“%”字符。

警告

客户端库BokehJS使用 timezone 设置日期时间格式的库。列入以下清单的依据是 timezone 使其支持“GNU日期格式说明符的完整补充”。然而，这个声明并没有针对这个列表进行详尽的测试。如果您发现格式不符合预期，请提交 github issue ，以便适当更新文档。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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也不以任何理由直接使用该名称。

nan_format¶

属性类型： String

应用于NaN和None值的格式（如果未设置，则返回常规日期格式）。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

当查询文档以检索特定的Bokeh模型时，此数据非常有用：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者简单地将任何必要的元数据附加到可以通过 CustomJS 回调等。

注解

对于所提供的任何标签，不存在唯一性保证或其他条件，Bokeh也不以任何理由直接使用这些标签。

text_align¶

属性类型： Enum （ TextAlign ）

可选文本对齐，即左对齐、居中对齐或右对齐。

text_color¶

属性类型： Color

可选文本颜色。看到了吗 bokeh.core.properties.Color 有关详细信息。

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "font_style": "normal",
  "format": "ISO-8601",
  "id": "10000",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "nan_format": null,
  "subscribed_events": [],
  "tags": [],
  "text_align": "left",
  "text_color": null
}

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

基类：bokeh.model.Model

描述如何计算总计和小计

aggregators¶

属性类型： List （ Instance （ RowAggregator ) )

描述如何聚合将填充此小计的列。

collapsed¶

属性类型： Bool

默认情况下是展开还是收拢相应的小计。

getter¶

属性类型： String

引用生成此小计（groupby）的唯一键的列。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "aggregators": [],
  "collapsed": false,
  "getter": "",
  "id": "10011",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.models.widgets.tables.CellFormatter

使用模板的HTML格式化程序。这使用下划线 template 方法和语法。http://underlinejs.org/#模板格式化程序可以通过访问行中的其他项 dataContext 对象传递给格式化程序。例如，如果数据源中的另一列被命名为 url ，模板可以访问它：

<a href="<%= url %>"><%= value %></a>

若要使用不同的模板分隔符集，请为传递适当的值 evaluate ， interpolate', or ` 逃跑。请参见下划线 template 有关详细信息的文档。http://下划线js.org/35;模板

示例：将列值格式化为代码的简单HTML模板。

HTMLTemplateFormatter(template='<code><%= value %></code>')

示例：使用其他列中的值 (manufacturer 和 model )建立超链接。

HTMLTemplateFormatter(template=
    '<a href="https:/www.google.com/search?q=<%= manufacturer %>+<%= model %>" target="_blank"><%= value %></a>'
)

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

template¶

属性类型： String

要由下划线的模板方法使用的模板字符串。

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "10020",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "template": "<%= value %>"
}

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

基于微调器的整数单元格编辑器。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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也不以任何理由直接使用该名称。

step¶

属性类型： Int

主要步长值。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "10027",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "step": 1,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.models.widgets.tables.RowAggregator

跨多行的最大值。

field_¶

属性类型： String

引用正在聚合的表列

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "field_": "",
  "id": "10034",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.models.widgets.tables.RowAggregator

跨多行的最小值。

field_¶

属性类型： String

引用正在聚合的表列

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "field_": "",
  "id": "10041",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基于微调器的数字单元格编辑器。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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也不以任何理由直接使用该名称。

step¶

属性类型： Float

主要步长值。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "10048",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "step": 0.01,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.models.widgets.tables.StringFormatter

数字单元格格式化程序。

font_style¶

属性类型： Enum （ FontStyle ）

可选的文本字体样式，例如粗体、斜体。

format¶

属性类型： String

下表中定义的数字格式：

NUMBERS ：

数	格式	弦
10000	'0,0.0000'	10,000.0000
10000.23	“0,0”	一万
10000.23	'+0,0'	+10000个
-10000	'0,0.0'	-10000.0万
10000.1234	'0.000'	10000.123
10000.1234	'0[.]00000'	10000.12340
-10000	'（0,0.0000）'	（10000.0000）
-0.23	'.00'	-.23
-0.23	'（.00）'	（二十三）
0.23	'0.00000'	0.23000
0.23	'0.0[0000]'	0.23
1230974	'0.0a'	1.2m
1460	“0 a”	1千
-104000	“0a”	-10万4千
1	'0o'	第一
52	'0o'	第五十二
23	'0o'	第二十三
100	'0o'	第一百

CURRENCY ：

数	格式	弦
1000.234	'$0,0.00'	$1,000.23
1000.2	“0,0” [.] 00美元	1000.20美元$
1001	'0,0美元 [.] 00’	1001美元
-1000.234	'（$0,0）'	（1000美元）
-1000.234	'$0.00'	-1000.23美元
1230974	'（$0.00 a）'	123万美元

BYTES ：

数	格式	弦
100	'0b'	100亿
2048	'0 b'	2千字节
7884486213	'0.0b'	7.3GB
3467479682787	“0.000亿”	3.154 TB

PERCENTAGES ：

数	格式	弦
1	“0%”	100%
0.974878234	'0.000%'	97.488%
-0.43	“0%”	-43%
0.43	'（0.000%）'	43%

TIME ：

数	格式	弦
25	'00:00:00'	0:00:25
238	'00:00:00'	0:03:58分
63846	'00:00:00'	17： 44:06分

有关完整规范，请参见http://numbrojs.com/format.html

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

language¶

属性类型： Enum （ NumeralLanguage ）

用于格式化特定语言功能的语言（例如千位分隔符）。

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也不以任何理由直接使用该名称。

nan_format¶

属性类型： String

要应用于NaN和None值的格式（如果未设置，则返回Numbro格式）。

rounding¶

属性类型： Enum （ RoundingFunction ）

舍入函数（round、floor、ceil）及其同义词（nearest、rounddown、roundup）。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

当查询文档以检索特定的Bokeh模型时，此数据非常有用：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者简单地将任何必要的元数据附加到可以通过 CustomJS 回调等。

注解

对于所提供的任何标签，不存在唯一性保证或其他条件，Bokeh也不以任何理由直接使用这些标签。

text_align¶

属性类型： Enum （ TextAlign ）

可选文本对齐，即左对齐、居中对齐或右对齐。

text_color¶

属性类型： Color

可选文本颜色。看到了吗 bokeh.core.properties.Color 有关详细信息。

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "font_style": "normal",
  "format": "0,0",
  "id": "10055",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "language": "en",
  "name": null,
  "nan_format": null,
  "rounding": "round",
  "subscribed_events": [],
  "tags": [],
  "text_align": "left",
  "text_color": null
}

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

IntEditor 为编辑百分比而优化。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "10068",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.models.widgets.tables.StringFormatter

默认情况下，将连续范围内的数值显示为“基本数字”，并使用科学记数法。

font_style¶

属性类型： Enum （ FontStyle ）

可选的文本字体样式，例如粗体、斜体。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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也不以任何理由直接使用该名称。

nan_format¶

属性类型： String

应用于NaN和None值的格式（如果未设置，则返回到科学格式）。

power_limit_high¶

属性类型： Int

将科学记数法的使用限制在：: log（x）>=功率上限

power_limit_low¶

属性类型： Int

将科学记数法的使用限制在：: log（x）<=功率极限_低

precision¶

属性类型： Int

显示多少位精度。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

当查询文档以检索特定的Bokeh模型时，此数据非常有用：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者简单地将任何必要的元数据附加到可以通过 CustomJS 回调等。

注解

对于所提供的任何标签，不存在唯一性保证或其他条件，Bokeh也不以任何理由直接使用这些标签。

text_align¶

属性类型： Enum （ TextAlign ）

可选文本对齐，即左对齐、居中对齐或右对齐。

text_color¶

属性类型： Color

可选文本颜色。看到了吗 bokeh.core.properties.Color 有关详细信息。

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "font_style": "normal",
  "id": "10074",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "nan_format": null,
  "power_limit_high": 5,
  "power_limit_low": -3,
  "precision": 10,
  "subscribed_events": [],
  "tags": [],
  "text_align": "left",
  "text_color": null
}

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

选择单元格编辑器。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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也不以任何理由直接使用该名称。

options¶

属性类型： List （ String ）

要从中选择的选项列表。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "10087",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "options": [],
  "subscribed_events": [],
  "tags": []
}

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

自动完成的基本字符串单元格编辑器。

completions¶

属性类型： List （ String ）

完成字符串的可选列表。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "completions": [],
  "id": "10094",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.models.widgets.tables.CellFormatter

基本字符串单元格格式设置程序。

font_style¶

属性类型： Enum （ FontStyle ）

可选的文本字体样式，例如粗体、斜体。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

当查询文档以检索特定的Bokeh模型时，此数据非常有用：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者简单地将任何必要的元数据附加到可以通过 CustomJS 回调等。

注解

对于所提供的任何标签，不存在唯一性保证或其他条件，Bokeh也不以任何理由直接使用这些标签。

text_align¶

属性类型： Enum （ TextAlign ）

可选文本对齐，即左对齐、居中对齐或右对齐。

text_color¶

属性类型： Color

可选文本颜色。看到了吗 bokeh.core.properties.Color 有关详细信息。

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "font_style": "normal",
  "id": "10101",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "text_align": "left",
  "text_color": null
}

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

基类：bokeh.models.widgets.tables.RowAggregator

多行的简单求和。

field_¶

属性类型： String

引用正在聚合的表列

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "field_": "",
  "id": "10110",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基类：bokeh.model.Model

表列小部件。

default_sort¶

属性类型： Enum （枚举（升序、降序）

默认排序顺序。默认情况下 ascending 使用订单。

editor¶

属性类型： Instance （ CellEditor ）

此列的单元格编辑器。默认情况下，使用一个简单的字符串编辑器。

field¶

属性类型： String

映射到数据源中列的字段的名称。

formatter¶

属性类型： Instance （ CellFormatter ）

此列的单元格格式化程序。默认情况下，使用简单的字符串格式化程序。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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也不以任何理由直接使用该名称。

sortable¶

属性类型： Bool

此列是否可排序。请注意，数据表必须启用排序才能允许一般排序。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

title¶

属性类型： String

此列的标题。如果未设置，则使用列的数据字段。

width¶

属性类型： Int

此列的宽度或最大宽度（取决于数据表的配置），以像素为单位。

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "default_sort": "ascending",
  "editor": {
    "id": "10118"
  },
  "field": null,
  "formatter": {
    "id": "10119"
  },
  "id": "10117",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "sortable": true,
  "subscribed_events": [],
  "tags": [],
  "title": null,
  "width": 300
}

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

基类：bokeh.models.widgets.widget.Widget

数据表（数据网格）小部件的抽象基类。

注解

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

align¶

属性类型： Either （ Enum （ Align ） Tuple （ Enum （ Align ） Enum （ Align ) ) )

父容器中的对齐点。

如果布局是这个元素的一个子元素，那么这个布局是有用的。自对齐可以被父容器覆盖（例如网格跟踪对齐）。

aspect_ratio¶

属性类型： Either （ Enum （枚举（自动））， Float ）

描述组件的宽度和高度之间的比例关系。

如果任何一个组件的尺寸在尺寸上是灵活的，这就可以了。如果设置为数字， width / height = aspect_ratio 关系将得到维持。否则，如果设置为 "auto" ，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不保留纵横比）。

background¶

属性类型： Color

组件的背景色。

css_classes¶

属性类型： List （ String ）

要添加到此DOM元素的CSS类名的列表。注意：类名只是按原样添加，不提供其他保证。

也允许从元组赋值，但是这些元组是经过调整的——属性将始终包含一个列表。

default_size¶

属性类型： Int

主维度中的默认大小（宽度或高度）。

主导维度由控件方向决定。

disabled¶

属性类型： Bool

小部件在呈现时是否被禁用。

如果 True ，小部件将变灰，并且不会响应UI事件。

height¶

属性类型： NonNegativeInt

高度（像素）。

这可以是固定高度，也可以是首选高度，具体取决于高度大小调整策略。

height_policy¶

属性类型： Either （ Auto ， Enum （ SizingPolicy ) )

描述组件应如何保持其高度。

"auto": 使用组件的首选大小策略。
"fixed": 准确使用 height 像素。如果组件不能容纳在可用的垂直空间中，它将溢出。
"fit": 使用组件的首选高度（如果设置）并允许在最小和最大高度边界（如果设置）内适合可用的垂直空间。组件的高度既不会被激进地最小化也不会被最大化。
"min": 使用尽可能少的垂直空间，不小于最小高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会收缩或增长，这取决于父布局、方面管理和其他因素。
"max": 使用尽可能多的垂直空间，不超过最大高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会收缩或增长，这取决于父布局、方面管理和其他因素。

注解

这是一个实验特性，将来可能会改变。你可以随意使用。喜欢使用 sizing_mode 如果这种程度的控制不是绝对必要的。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

margin¶

属性类型： Tuple （ Int ， Int ， Int ， Int ）

允许在组件周围创建额外的空间。元组中的值按如下顺序排列-上边距、右边距、下边距和左边距，类似于CSS标准。负边距值可用于从任何方向收缩空间。

max_height¶

属性类型： NonNegativeInt

如果高度可调，组件的最大高度（以像素为单位）。

max_width¶

属性类型： NonNegativeInt

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height¶

属性类型： NonNegativeInt

如果高度可调，组件的最小高度（以像素为单位）。

min_width¶

属性类型： NonNegativeInt

如果宽度可调，组件的最小宽度（以像素为单位）。

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也不以任何理由直接使用该名称。

orientation¶

属性类型： Enum （枚举（水平、垂直））

水平（默认）或垂直调整小部件的方向。

注意并不是所有的小部件都支持垂直方向。

sizing_mode¶

属性类型： Enum （ SizingMode ）

组件的大小。

这是一个高级设置，用于保持组件的宽度和高度。要获得对大小的更细粒度控制，请使用 width_policy ， height_policy 和 aspect_ratio 相反（这些优先于 sizing_mode ）

可能的情况：

"fixed": 组件没有响应。它将保留其原始的宽度和高度，而不考虑任何后续的浏览器窗口调整事件。
"stretch_width": 组件将相应地调整大小以拉伸到可用的宽度，而不保持任何宽高比。组件的高度取决于组件的类型，可以固定或适合组件的内容。
"stretch_height": 组件将相应地调整大小以拉伸到可用的高度，而不保持任何纵横比。组件的宽度取决于组件的类型，可以固定或适合组件的内容。
"stretch_both": 如果纵横比是独立的，那么纵横比会完全占据垂直部分的空间。
"scale_width": 组件将相应地调整大小以拉伸到可用的宽度，同时保持原始或提供的纵横比。
"scale_height": 组件将相应地调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。
"scale_both": 组件将相应地调整到可用的宽度和高度，同时保持原始或提供的纵横比。

source¶

属性类型： Instance （ DataSource ）

小部件的数据源。

subscribed_events¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

view¶

属性类型： Instance （ CDSView ）

呈现表行时要使用的数据源视图。如果在初始化期间没有传入视图，则会创建整个数据源的默认视图。

visible¶

属性类型： Bool

组件是否可见以及是否是布局的一部分。

width¶

属性类型： NonNegativeInt

组件的宽度（以像素为单位）。

这可以是固定宽度，也可以是首选宽度，具体取决于宽度大小调整策略。

width_policy¶

属性类型： Either （ Auto ， Enum （ SizingPolicy ) )

描述组件应如何保持其宽度。

"auto": 使用组件的首选大小策略。
"fixed": 准确使用 width 像素。如果组件不能容纳在可用的水平空间中，它将溢出。
"fit": 使用组件的首选宽度（如果设置），并允许它在最小和最大宽度范围内（如果设置）适合可用的水平空间。组件的宽度既不会被积极地最小化也不会被最大化。
"min": 尽可能少地使用水平空间，不小于最小宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会根据父布局、方面管理和其他因素而缩小或增大。
"max": 使用尽可能多的水平空间，不超过最大宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会收缩或增长，这取决于父布局、方面管理和其他因素。

注解

这是一个实验特性，将来可能会改变。你可以随意使用。喜欢使用 sizing_mode 如果这种程度的控制不是绝对必要的。

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "align": "start",
  "aspect_ratio": null,
  "background": null,
  "css_classes": [],
  "default_size": 300,
  "disabled": false,
  "height": null,
  "height_policy": "auto",
  "id": "10132",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "margin": [
    5,
    5,
    5,
    5
  ],
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "orientation": "horizontal",
  "sizing_mode": null,
  "source": null,
  "subscribed_events": [],
  "tags": [],
  "view": {
    "id": "10133"
  },
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

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

多行字符串单元格编辑器。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。

{
  "id": "10184",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

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

基于微调器的时间单元编辑器。

js_event_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_event 方法：

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

js_property_callbacks¶

属性类型： Dict （ String ， List （ Instance （ CustomJS ) ) )

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

通常，应该使用 Model.js_on_change 方法：

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

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¶

属性类型： List （ String ）

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

tags¶

属性类型： List （ Any ）

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

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

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

js_link(attr, other, other_attr, attr_selector=None)¶

使用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）

返回

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

返回类型

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 字段（如果此模型是子类型）。