curdoc
返回当前默认状态的文档。
当前默认文档对象。
Document
export_png
导出 LayoutDOM 对象或文档作为PNG。
LayoutDOM
如果没有给出文件名,它将从脚本名派生(例如。 /foo/myplot.py 将创造 /foo/myplot.png )
/foo/myplot.py
/foo/myplot.png
obj (LayoutDOM or Document) -- 要导出的布局(行/列)、绘图或小部件对象或文档。
filename (str, optional) -- 用于保存文档的文件名(默认值:无)如果没有,则从文件名推断。
width (int) -- 仅当是打印实例时,导出的布局对象的所需宽度。否则将忽略宽度kwarg。
height (int) -- 仅当导出的布局对象是打印实例时,该对象的所需高度。否则将忽略kwarg高度。
webdriver (selenium.webdriver) -- 用于导出图像的selenium webdriver实例。
timeout (int) -- 等待Bokeh初始化的最长时间(秒)(默认值:5)(在1.1.1中添加)。
保存静态文件的文件名。
filename (str)
如果要直接访问图像对象,而不是将文件保存到磁盘,请使用较低级别 get_screenshot_as_png() 功能。
get_screenshot_as_png()
警告
响应大小调整模式可能会生成具有意外大小和纵横比的布局。建议使用默认值 fixed 调整大小模式。
fixed
export_svgs
在布局中导出启用SVG的绘图。每个绘图都将生成一个不同的SVG文件。
如果没有给出文件名,它将从脚本名派生(例如。 /foo/myplot.py 将创造 /foo/myplot.svg )
/foo/myplot.svg
obj (LayoutDOM object) -- 要显示的布局(行/列)、绘图或小部件对象
保存SVGs文件的文件名列表。
filenames (list(str))
install_notebook_hook
安装新的笔记本显示器挂钩。
Bokeh内置了对Jupyter笔记本电脑的支持。然而,不同社区也在使用其他类型的笔记本电脑。此函数为其他项目提供了一种机制来指导Bokeh如何在其他笔记本中显示内容。
此功能主要用于希望将Bokeh与新笔记本类型集成的开发人员。
notebook_type (str) -- 笔记本类型的名称,e.e。 'Jupyter' 或 'Zeppelin' 如果以前安装过该名称,则 RuntimeError 将被提高,除非 overwrite=True
'Jupyter'
'Zeppelin'
RuntimeError
overwrite=True
load (callable) -- 在笔记本类型中加载BokehJS的函数。将使用以下参数调用函数:。。代码块::python load(resources,#如何加载BokehJS verbose的resources对象,#是否显示详细加载banner hide_banner,#是否完全隐藏输出横幅加载超时#报告加载失败错误的时间)
show_doc (callable) -- 以笔记本类型显示Bokeh独立文档的函数。将使用以下参数调用此函数:。。代码块::python show_doc(obj,#要显示状态的Bokeh对象,#当前博克.io“state”notebook_handle#是否请求了笔记本句柄)如果笔记本平台能够支持对绘图的就地更新,则此函数可能会返回一个不透明的笔记本句柄可用于此目的。句柄将由 show() ,并可由在库中安装挂钩的附加函数酌情用于更新绘图等。
show()
show_app (callable) -- 一种用于在笔记本类型中显示Bokeh应用程序的函数。此函数将使用以下参数调用:。。代码块::python show_UApp(app,ා要显示状态的Bokeh应用程序,#当前博基·io“状态”笔记本url,#当前活动笔记本页的url**kw
overwrite (bool, optional) -- 是否允许现有钩子被新定义覆盖(默认值:False)
没有
RuntimeError -- 如果 notebook_type 已安装并且 overwrite=False
notebook_type
overwrite=False
output_file
将默认输出状态配置为在以下情况下生成保存到文件的输出 show() 被称为。
不改变电流 Document 从 curdoc() . 文件和笔记本输出可能同时处于活动状态,因此,这不能清除 output_notebook() .
curdoc()
output_notebook()
filename (str) -- 用于保存HTML文档的文件名
title (str, optional) -- HTML文档的标题(默认值:“Bokeh Plot”)
mode (str, optional) -- 如何包括BokehJS(默认: 'cdn' )其中之一: 'inline' , 'cdn' , 'relative(-dev)' 或 'absolute(-dev)' . 见 bokeh.resources.Resources 了解更多详细信息。
'cdn'
'inline'
'relative(-dev)'
'absolute(-dev)'
bokeh.resources.Resources
root_dir (str, optional) -- 用于“绝对”资源的根目录。(默认值:无)其他资源类型忽略此值,例如。 INLINE 或 CDN .
INLINE
CDN
注解
通常,这应该在交互会话的开始或脚本的顶部调用。
每次保存(例如每次调用show()或save()时)都会覆盖此输出文件。
output_notebook
配置默认输出状态,以便在笔记本单元格中生成输出 show() 被称为。请注意, show() 可以在单个单元格中多次调用以在输出单元格中显示多个对象。对象将按顺序显示。
resources (Resource, optional) -- 如何以及从何处加载BokehJS(默认值:CDN)
verbose (bool, optional) -- 是否显示详细的BokehJS横幅(默认:False)
hide_banner (bool, optional) -- 是否隐藏Bokeh横幅(默认值:False)
load_timeout (int, optional) -- 当绘图假定加载超时时超时(默认值:5000)
notebook_type (string, optional) -- 笔记本类型(默认:jupyter)
push_notebook
使用新数据或属性值更新Jupyter笔记本输出单元格中的Bokeh图。
在操作笔记本时 show 函数可以传递参数 notebook_handle=True ,这将导致它返回一个句柄对象,该对象可用于以后更新Bokeh输出。什么时候? push_notebook 调用,则表示自上次调用后的任何属性更新(例如,绘图标题或数据源值等) push_notebook 还是原版 show 调用应用于先前呈现的Jupyter输出单元中的Bokeh输出。
show
notebook_handle=True
可以在GitHub存储库的 examples/howto/notebook_comms 目录。
document (Document, optional) -- A Document 推开。如果没有,则使用 curdoc() . (默认值:无)
state (State, optional) -- A State 对象。如果没有,则当前默认状态(由设置 output_file ,等等)被使用。(默认值:无)
State
实际案例
典型用法与此类似:
from bokeh.plotting import figure from bokeh.io import output_notebook, push_notebook, show output_notebook() plot = figure() plot.circle([1,2,3], [4,6,5]) handle = show(plot, notebook_handle=True) # Update the plot title in the earlier cell plot.title.text = "New Title" push_notebook(handle=handle)
save
用当前文档的数据保存一个HTML文件。
将返回到默认输出状态(或显式提供 State 对象)用于 filename , resources 或 title 如果没有提供。如果文件名未给定,并且未通过输出状态提供,则它是从脚本名称(例如)派生的。 /foo/myplot.py 将创造 /foo/myplot.html )
filename
resources
title
/foo/myplot.html
filename (str, optional) -- 要保存文档的文件名(默认值:无)如果没有,则使用默认状态配置。
resources (Resources, optional) -- 要使用的资源配置(默认值:无)如果没有,则使用默认状态配置(如果有)。否则使用 resources.INLINE .
resources.INLINE
title (str, optional) -- HTML文档的标题(默认值:无)如果没有,则使用默认状态标题值(如果有)。否则,使用“Bokeh Plot”
template (Template, optional) -- HTML文档模板(默认:文件)Jinja2模板,请参见bokeh.core.templates公司.FILE以获取所需的模板参数
state (State, optional) -- A State 对象。如果没有,则使用当前默认的隐式状态。(默认值:无)。
保存HTML文件的文件名。
str
立即显示Bokeh对象或应用程序。
show() 可以在一个Jupyter笔记本单元中多次调用以显示多个对象。对象按顺序显示。
obj (LayoutDOM or Application or callable) -- 要显示的对象。Bokeh图、小部件、布局(即行和列)可以传递给 show 为了展示它们。什么时候? output_file 调用后,输出将被输出到一个HTML文件,该文件也将在新的浏览器窗口或选项卡中打开。什么时候? output_notebook 在笔记本被内联输出的笔记本中被称为内联输出。在Jupyter笔记本中,也可以传递Bokeh应用程序或callable。调用将被转换为使用 FunctionHandler . 应用程序将在相关联的笔记本输出单元格中以内联方式运行和显示。
FunctionHandler
browser (str, optional) -- 指定用于打开输出文件的浏览器(默认值:无)作为“文件输出”,则 浏览器 参数允许指定要在哪个浏览器中显示,例如“safari”、“firefox”、“opera”、“windows default”。并非所有平台都支持此选项,请参阅标准库的文档 webbrowser 模块了解更多信息
new (str, optional) -- 指定用于输出文件的浏览器模式(默认:“tab”)用于文件输出,打开或打开显示当前输出文件的浏览器窗口。如果 new 是“tab”,然后打开一个新选项卡。如果 new 是“窗口”,然后打开一个新窗口。
notebook_handle (bool, optional) -- 是否为笔记本输出创建笔记本交互句柄(默认值:False),切换是否可以与一起使用的句柄 push_notebook 返回。请注意,笔记本句柄仅适用于独立绘图、布局等。在笔记本中显示应用程序时,它们不适用。
notebook_url (URL, optional) -- Jupyter笔记本页面的位置(默认值:“本地主机:8888)当显示Bokeh应用程序时,Bokeh服务器必须显式配置为允许来自不同url的连接。此参数默认为标准笔记本主机和端口。如果您在不同的位置运行,则需要提供该值以使应用程序正确显示。如果URL中没有提供协议,例如本地主机:8888,则使用“http”。 notebook_url 也可以是对绑定服务器端口使用一个int的函数。如果提供了端口,则函数需要生成指向bokeh服务器的完整公共URL。如果没有传递,则函数将生成源URL。
notebook_url
只有当某些输出参数是有效的时,某些模式才是有用的:
这个 browser 和 new 参数仅适用于 output_file 是活跃的。
browser
new
这个 notebook_handle 参数仅适用于 output_notebook 处于活动状态,并且显示非应用程序对象。它只支持Jupyter笔记本,当它为真时引发其他笔记本类型的异常。
notebook_handle
这个 notebook_url 参数仅适用于在Jupyter笔记本中显示Bokeh应用程序时。
任何其他关键字参数都传递给 Server 显示Bokeh应用程序时(在版本1.1中添加)
Server
当在一个大笔记本里(带 output_notebook 启用)和 notebook_handle=True ,返回可由使用的句柄 push_notebook ,其他都没有。
set_curdoc
配置当前文档(由curdoc()返回)。
doc (Document) -- 我们将输出的文档。
调用此函数将替换任何现有文档。
export_svg
将布局导出为SVG文件,或将文档导出为一组SVG文件。
timeout (int) -- 等待Bokeh初始化的最长时间(秒)(默认值:5)
get_layout_html
get_screenshot_as_png
获取一个 LayoutDOM 对象。
driver (selenium.webdriver) -- 用于导出图像的selenium webdriver实例。
timeout (int) -- 等待初始化的最长时间。它将用作加载Bokeh的超时,然后在等待呈现布局时使用。
从PNG加载的枕头图像。
image (PIL.Image.Image)
CommsHandle
destroy_server
给定Jupyter笔记本中移除或替换的div的UUID id,销毁相应的服务器会话并停止它。
get_comms
为特定目标创建一个Jupyter comms对象,该对象可用于更新Jupyter笔记本中的Bokeh文档。
target_name (str) -- Comms对象应连接到的目标名称
Jupyter通信
install_jupyter_hooks
load_notebook
准备好IPython笔记本以显示Bokeh图。
verbose (bool, optional) -- 是否报告详细设置(默认:False)
清除包含已发布的BokehJS资源HTML代码的输出单元格可能会导致Bokeh CSS样式被删除。
publish_display_data
run_notebook_hook
使用提供的参数运行已安装的笔记本挂钩。
noteboook_type (str) -- 现有已安装笔记本挂钩的名称
actions (str) -- 要执行的操作的名称, 'doc' 或 'app'
'doc'
'app'
所有其他参数和关键字参数都完全按照提供的方式传递给钩子操作。
钩子动作的结果
RuntimeError -- 如果吊钩或特定动作未安装
show_app
在Jupyter笔记本输出单元中嵌入Bokeh服务器应用程序。
app (Application or callable) -- 一个Bokeh应用程序嵌入到Jupyter笔记本中。
state (State) -- 未使用
notebook_url (str or callable) -- 运行嵌入式应用程序的笔记本服务器的URL。如果 notebook_url 是一个字符串,则对值字符串进行解析以构造源URL和完整服务器URL。如果notebook_url是可调用的,则它必须接受一个参数,即服务器端口,或者不接受。如果传递了一个端口,则可调用程序必须生成服务器URL,否则,如果未传递,则必须生成服务器的源URL。
port (int) -- 嵌入式服务器的端口将监听。默认情况下,端口为0,这将导致服务器监听随机动态端口。
任何其他关键字参数都传递给 Server (在版本1.1中添加)
show_doc
reset_output
清除所有输出模式的默认状态。
封装对Bokeh绘图api有用的隐式状态。
同时 State 对象也可以显式操作,它们是在函数自动配置时 output_file() 等,从 bokeh.io 因此,在典型用法下,这是不必要的。
output_file()
生成Bokeh图的输出需要协调以下几点:
将图(例如,范围或数据源对象)之间共享的Bokeh模型组合到一个公共结构中。
Resources
控制如何在生成的输出中包含和使用客户端库BokehJS的JavaScript和CSS。
可以手动处理这些配置,可以在中找到一些这样做的示例 examples/models 目录。在开发复杂的应用程序时,可能需要或希望在这个级别工作。然而,对于一般用途,这将很快成为负担。此模块提供 State 类,该类封装这些对象并确保它们在许多常见使用场景中的正确配置。
examples/models
管理与控制Bokeh输出相关的状态。
配置输出到独立的HTML文件。
调用 output_file 不清楚任何其他调用 output_notebook 它添加了一个额外的输出目的地(发布到HTML文件)。任何其他激活的输出模式继续激活。
title (str, optional) -- HTML文档的标题
mode (str, optional) -- 如何包括BokehJS(默认: 'cdn' )其中之一: 'inline' , 'cdn' , 'relative(-dev)' 或 'absolute(-dev)' . 见 Resources 了解更多详细信息。
root_dir (str, optional) -- 用于绝对资源的根目录(默认值:无)对于其他资源类型,此值被忽略,例如。 INLINE 或 CDN .
每次保存时(例如每次)都会覆盖指定的输出文件 show() 或 save() 被称为。
save()
在笔记本单元格中生成输出。
调用 output_notebook 不清楚任何其他调用 output_file ,等等。它添加了一个额外的输出目标(发布到笔记本输出单元格)。任何其他激活的输出模式继续激活。
reset
停用所有当前激活的输出模式并设置 curdoc() 去一个新鲜的空的 Document .
后续呼叫 show() 在激活新的输出模式之前不会渲染。
document
A default Document to use for all output operations.
file
具有文件输出默认配置的dict(只读)
字典值的格式如下:
{ 'filename' : # filename to use when saving 'resources' : # resources configuration 'title' : # a title for the HTML document }
notebook
是否在显示操作时生成笔记本输出。(只读)
笔记本类型
curstate
返回当前状态对象
当前默认状态对象
default_filename
生成具有给定扩展名的默认文件名,如果可能,尝试使用当前正在运行的进程的文件名。
如果当前进程的文件名不可用(或不可写),则返回具有给定扩展名的临时文件。
ext (str) -- 文件名所需的扩展名
STR
RuntimeError -- 如果请求的扩展名是“.py”
detect_current_filename
尝试返回当前运行的Python进程的文件名
如果无法检测到文件名,则返回None。
temp_filename
生成具有给定扩展名的临时可写文件名