bokeh.resources#
资源模块提供了Resources类,用于轻松配置BokehJS代码和CSS资源应如何定位、加载和嵌入到Bokeh文档中。
此外,这里还提供了用于检索Bokeh JavaScript文件的子资源完整性哈希值的函数。
一些预配置的 Resources 对象作为属性提供。
- CDN#
从CDN加载最小化的BokehJS
- INLINE#
从库的静态目录提供压缩的BokehJS
- class Resources(mode: Literal['inline', 'cdn', 'server', 'relative', 'absolute'] | Literal['server-dev', 'relative-dev', 'absolute-dev'] | None = None, *, version: str | None = None, root_dir: str | PathLike[str] | None = None, dev: bool | None = None, minified: bool | None = None, log_level: Literal['trace', 'debug', 'info', 'warn', 'error', 'fatal'] | None = None, root_url: str | None = None, path_versioner: Callable[[str], str] | None = None, components: list[Literal['bokeh', 'bokeh-gl', 'bokeh-widgets', 'bokeh-tables', 'bokeh-mathjax', 'bokeh-api']] | None = None, base_dir: str | PathLike[str] | None = None)[源代码]#
Resources 类封装了与加载或嵌入 Bokeh Javascript 和 CSS 相关的信息。
- Parameters:
mode (str) –
Bokeh JS 和 CSS 应如何包含在输出中
请参阅以下可用模式的描述
版本 (str, 可选) –
加载哪个版本的 Bokeh JS 和 CSS
仅在
'cdn'模式下有效root_dir (str, optional) –
用于加载Bokeh JS和CSS资源的根目录
仅在
'relative'和'relative-dev'模式下有效压缩 (bool, 可选) – 是否应该压缩 JavaScript 和 CSS(默认值:True)
root_url (str, optional) –
用于加载资源的Bokeh服务器的URL和端口
仅在
'server'和'server-dev'模式下有效
以下模式值可用于配置资源对象:
'inline'配置为提供整个 Bokeh JS 和 CSS 内联'cdn'配置为从https://cdn.bokeh.org加载 Bokeh JS 和 CSS'server'配置为从 Bokeh 服务器加载'server-dev'与server相同,但支持未压缩的资源'relative'配置为相对于给定目录加载'relative-dev'与relative相同,但支持未压缩的资源'absolute'配置为从已安装的 Bokeh 库静态目录加载'absolute-dev'与absolute相同,但支持未压缩的资源
一旦配置完成,Resource对象将暴露以下公共属性:
- js_raw#
任何需要放置在
- css_raw#
任何需要放置在
- js_files#
需要通过
- css_files#
需要通过
标签加载的任何CSS文件的URL
这些属性在嵌入Bokeh图表时通常作为模板参数非常有用。
- get_sri_hashes_for_version(version: str) dict[str, str][source]#
报告特定版本BokehJS的SRI脚本哈希值。
Bokeh 为发布到 CDN 的所有 JavaScript 文件提供了 子资源完整性 哈希值。此函数返回一个字典,该字典将 JavaScript 文件名映射到它们的哈希值,适用于单个版本的 Bokeh。
- Parameters:
版本 (str) – 返回SRI哈希值的Bokeh版本。哈希值仅适用于完整版本,例如“1.4.0”,而不适用于“dev”构建或候选版本。
- Returns:
字典
- Raises:
ValueError – 如果指定的版本不存在
Example
返回的单个版本的字典将把该版本的文件名映射到它们的SRI哈希值:
{ 'bokeh-1.4.0.js': 'vn/jmieHiN+ST+GOXzRU9AFfxsBp8gaJ/wvrzTQGpIKMsdIcyn6U1TYtvzjYztkN', 'bokeh-1.4.0.min.js': 'mdMpUZqu5U0cV1pLU9Ap/3jthtPth7yWSJTu1ayRgk95qqjLewIkjntQDQDQA5cZ', 'bokeh-api-1.4.0.js': 'Y3kNQHt7YjwAfKNIzkiQukIOeEGKzUU3mbSrraUl1KVfrlwQ3ZAMI1Xrw5o3Yg5V', 'bokeh-api-1.4.0.min.js': '4oAJrx+zOFjxu9XLFp84gefY8oIEr75nyVh2/SLnyzzg9wR+mXXEi+xyy/HzfBLM', 'bokeh-tables-1.4.0.js': 'I2iTMWMyfU/rzKXWJ2RHNGYfsXnyKQ3YjqQV2RvoJUJCyaGBrp0rZcWiTAwTc9t6', 'bokeh-tables-1.4.0.min.js': 'pj14Cq5ZSxsyqBh+pnL2wlBS3UX25Yz1gVxqWkFMCExcnkN3fl4mbOF8ZUKyh7yl', 'bokeh-widgets-1.4.0.js': 'scpWAebHEUz99AtveN4uJmVTHOKDmKWnzyYKdIhpXjrlvOwhIwEWUrvbIHqA0ke5', 'bokeh-widgets-1.4.0.min.js': 'xR3dSxvH5hoa9txuPVrD63jB1LpXhzFoo0ho62qWRSYZVdyZHGOchrJX57RwZz8l' }
- verify_sri_hashes() None[source]#
验证完整发布包中的SRI哈希值。
此函数比较完整发布包中BokehJS文件的计算SRI哈希值与SRI清单文件中的值。如果所有哈希值匹配,则返回None,否则将引发异常。
注意
此函数只能在完整发布(例如“1.2.3”)的包上调用。
- Returns:
无
- Raises:
ValueError – 如果在完整发布包之外调用
RuntimeError – 如果文件缺失、多余或不匹配