表示要在客户端(浏览器)端发生的数据转换。
CustomJSTransform
基类:bokeh.models.transforms.Transform
bokeh.models.transforms.Transform
对数据应用自定义转换。
警告
这个Bokeh模型的明确目的是嵌入 原始JavaScript代码 用于执行浏览器。如果代码的任何部分是从不受信任的用户输入派生的,那么在传递给Bokeh之前,必须谨慎地清理用户输入。
args
属性类型: Dict ( String , AnyRef )
Dict
String
AnyRef
名称到Python对象的映射。尤其是那些可以是博克的模型。这些对象作为回调的命名参数的值提供给transform的代码段。
func
属性类型: String
转换单个值的JavaScript代码片段。变量 x 将包含未转换的值,并且可能在呈现时出现在函数命名空间中。代码段将放入函数体中,因此需要一个return语句。
x
例子:
func = ''' return Math.floor(x) + 0.5 '''
js_event_callbacks
属性类型: Dict ( String , List ( Instance ( CustomJS ) ) )
List
Instance
CustomJS
事件名称到列表的映射 CustomJS 回调。
通常,应该使用 Model.js_on_event 方法:
Model.js_on_event
callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
js_property_callbacks
属性名到列表的映射 CustomJS 回调,在创建文档时在BokehJS侧设置。
通常,应该使用 Model.js_on_change 方法:
Model.js_on_change
callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
name
用户为此模型提供的任意名称。
当查询文档以检索特定的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 )
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也不以任何理由直接使用这些标签。
v_func
用于转换值数组的JavaScript代码片段。变量 xs 将包含未转换的数组,并且可能在呈现时出现在函数命名空间中。代码段将放入函数体中,因此需要一个return语句。
xs
v_func = ''' var new_xs = new Array(xs.length) for(var i = 0; i < xs.length; i++) { new_xs[i] = xs[i] + 0.5 } return new_xs '''
将函数矢量化, v_func ,必须返回与输入长度相同的数组 xs 数组。
apply_theme
应用一组主题值,这些值将被使用而不是默认值,但不会覆盖应用程序集值。
传入的字典可以保持原样,并与其他实例共享以节省内存(因此无论是调用方还是 HasProps 实例应该修改它)。
HasProps
property_values (dict) -- 主题值用于替代默认值
没有
dataspecs
收集所有人的名字 DataSpec 类的属性。
DataSpec
这种方法 总是 遍历类层次结构并包含在任何父类上定义的属性。
名称 DataSpec 性质
set[str]
dataspecs_with_props
收集一张记录所有人姓名的字典 DataSpec 类的属性。
名称和 DataSpec 性质
dict[str, DataSpec]
equals
模型的结构相等。
other (HasProps) -- 要比较的另一个实例
如果属性在结构上相等,则为True,否则为False
js_link
使用JavaScript链接两个Bokeh模型属性。
这是一种方便的方法,它简化了添加一个CustomJS回调,以便在另一个Bokeh模型属性更改值时更新它。
attr (str) -- 此模型上的Bokeh属性的名称
other (Model) -- 要链接到的Bokeh模型自我属性
other_attr (str) -- 上的财产 other 连接在一起
other
attr_selector (Union[int, str]) -- 链接可订阅项中的项的索引 attr
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
附A CustomJS 对任意BokehJS模型事件的回调。
在BokehJS方面,模型属性的更改事件具有以下形式 "change:property_name" . 为了方便起见,如果传递给此方法的事件名也是模型上某个属性的名称,那么它的前缀将是 "change:" 自动:
"change:property_name"
"change:"
# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
但是,除了属性更改事件之外,还有其他类型的事件可以用来响应。例如,每当数据流式传输到 ColumnDataSource 使用 "stream" 源上的事件:
ColumnDataSource
"stream"
source.js_on_change('streaming', callback)
layout
lookup
找到 PropertyDescriptor 对于类上的Bokeh属性,给定属性名。
PropertyDescriptor
name (str) -- 要搜索的属性的名称
名为的属性的描述符 name
on_change
在此对象上添加回调以在 attr 变化。
attr (str) -- 此对象的属性名
*callbacks (callable) -- 要注册的回调函数
widget.on_change('value', callback1, callback2, ..., callback_n)
properties
收集此类的属性名称。
这种方法 任选地 遍历类层次结构并包含在任何父类上定义的属性。
with_bases (bool, optional) -- 是否在结果中包含在父类上定义的属性。(默认值:True)
属性名称
properties_containers
收集此类上所有容器属性的名称。
容器属性名称
properties_with_refs
收集该类上也有引用的所有属性的名称。
具有引用的属性的名称
properties_with_values
收集将属性名称映射到其值的dict。
跳过不可序列化的属性,属性值采用“序列化”格式,这可能与通常从属性中读取的值略有不同;此方法的目的是返回无损重建对象实例所需的信息。
include_defaults (bool, optional) -- 是否包含自创建对象后尚未显式设置的属性。(默认值:True)
从属性名到属性值的映射
dict
query_properties_with_values
查询的属性值 HasProps 带有谓词的实例。
query (callable) -- 接受属性描述符并返回True或False的可调用文件
include_defaults (bool, optional) -- 是否包含尚未由用户显式设置的属性(默认值:True)
为匹配的属性映射属性名称和值
references
返回全部 Models 此对象引用的。
Models
remove_on_change
从此对象中删除回调
select
查询此对象及其所有引用以查找与给定选择器匹配的对象。
selector (JSON-like) --
SEQ [模型]
select_one
查询此对象及其所有引用以查找与给定选择器匹配的对象。如果找到多个对象,则引发错误。返回单个匹配的对象,如果找不到任何对象,则返回无:param selector::type selector:JSON like
模型
set_from_json
从JSON设置此对象的属性值。
name -- (str):要设置的属性的名称
json -- (JSON value):要设置为的属性的值
models (dict or None, optional) -- 模型ID到模型的映射(默认值:无)在要更新的属性也有引用的值的情况下,需要这样做。
setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。在Bokeh服务器应用程序的上下文中,对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较,并禁止任何源自自身的更新。
set_select
更新与具有指定属性/值的给定选择器匹配的对象将更新。
updates (dict) --
themed_values
获取任何主题提供的覆盖。
结果以dict形式从属性名返回到值,或者 None 如果没有主题覆盖此实例的任何值。
None
不记名
to_json
返回此对象属性的字典,只包含“JSON类型”(string、number、boolean、none、dict、list)。
对其他对象的引用被序列化为“refs”(只是对象ID和类型信息),因此反序列化程序需要单独拥有这些其他对象的完整属性。
没有对应的 from_json() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。
from_json()
在大多数情况下,最好序列化和反序列化整个文档。
include_defaults (bool) -- 是否包含未从默认值更改的属性
to_json_string
返回编码此对象属性的JSON字符串。
对其他对象的引用被序列化为引用(仅对象ID和类型信息),因此反序列化程序将需要单独拥有这些其他对象的完整属性。
没有对应的 from_json_string() 因为反序列化对象通常是在文档上下文中完成的(因为文档可以解析引用)。
from_json_string()
trigger
unapply_theme
删除所有主题值并恢复默认值。
update
从给定的关键字参数更新对象的属性。
以下是等效的:
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 -- (JSON dict):要更新的属性和值
document
这个 Document 此模型附加到(可以是 None )
Document
struct
此模型的Bokeh协议“结构”,即以下形式的dict:
{ 'type' : << view model name >> 'id' : << unique model id >> }
此外,可能还有 subtype 字段(如果此模型是子类型)。
{ "args": {}, "func": "", "id": "8763", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [], "v_func": "" }
Dodge
对数据应用固定闪避量。
range
属性类型: Instance ( Range )
Range
申请时 Dodge 对于分类数据值,相应的 FactorRange 必须作为 range 财产。
FactorRange
value
属性类型: Float
Float
回避输入数据的量。
{ "id": "8772", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "range": null, "subscribed_events": [], "tags": [], "value": 0 }
Interpolator
插值器变换的基类。
插值器返回在指定(x,y)对数据之间计算的函数值。例如,如果向内插器提供两个控制点对,则特定值为“x”的线性插值将产生连接两个控制点的线上存在的“y”值。
插值器的控制点对可以通过
值的字面序列:
interp = Interpolator(x=[1, 2, 3, 4, 5], y=[2, 5, 10, 12, 16])
或在 ColumnDataSource 对象:
interp = Interpolator(x="year", y="earnings", data=jewlery_prices))
这是基类,不打算最终使用。有关最终的派生类,请参阅文档 (Jitter , LineraInterpolator , StepInterpolator )以获取更多关于其特定插值方法的信息。
Jitter
LineraInterpolator
StepInterpolator
这是一个抽象基类,用于帮助组织Bokeh模型类型的层次结构。 单独实例化是没有用的。
clip
属性类型: Bool
Bool
确定插值是否应剪裁结果以仅包含其预定义范围内的值。如果设置为False,它将返回最近点的最大值。
data
属性类型: Instance ( ColumnarDataSource )
ColumnarDataSource
如果将字符串传递给 x 或 y 参数。
y
属性类型: Either ( String , Seq ( Float ) )
Either
Seq
表示点位置的独立坐标。
表示某一位置上某一点的值的从属坐标。
{ "clip": true, "data": null, "id": "8780", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [], "x": null, "y": null }
对数据应用均匀或正常采样的随机抖动。
distribution
属性类型: Enum ( JitterRandomDistribution )
Enum
JitterRandomDistribution
随机分布,随机分布
mean
随机样本的中心值
当对分类数据值应用抖动时,相应的 FactorRange 必须作为 range 财产。
width
随机样本的宽度(均匀分布为绝对值,正态分布为σ)。
{ "distribution": "uniform", "id": "8790", "js_event_callbacks": {}, "js_property_callbacks": {}, "mean": 0, "name": null, "range": null, "subscribed_events": [], "tags": [], "width": 1 }
LinearInterpolator
基类:bokeh.models.transforms.Interpolator
bokeh.models.transforms.Interpolator
计算通过提供的控制点之间的线性插值 x , y 和 data 参数。
{ "clip": true, "data": null, "id": "8800", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [], "x": null, "y": null }
在通过 x , y 和 data 参数。
mode
属性类型: Enum ( StepMode )
StepMode
调整返回值相对于控制点的行为。参数可以采用以下三个值之一:
after (默认):假设y值与最近的x值关联,该值小于或等于要变换的点。
after
before :假设y值与最接近的x值关联,该值大于要转换的点。
before
center :假设y值与要变换的点最近的x值关联。
center
{ "clip": true, "data": null, "id": "8810", "js_event_callbacks": {}, "js_property_callbacks": {}, "mode": "after", "name": null, "subscribed_events": [], "tags": [], "x": null, "y": null }
Transform
基类:bokeh.model.Model
bokeh.model.Model
基类 Transform 表示要在客户端执行的计算的模型。
JavaScript实现应该实现以下方法:
{ "id": "8821", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [] }