bokeh.io

curdoc()[ソース]

現在のデフォルト状態に戻るドキュメント。

戻り値

現在のデフォルト文書オブジェクト。

戻り値の型

Document

export_png(obj: Union[bokeh.models.layouts.LayoutDOM, bokeh.document.document.Document], *, filename: Optional[str] = None, width: Optional[int] = None, height: Optional[int] = None, webdriver: Optional[WebDriver] = None, timeout: int = 5) → str[ソース]

導き出す LayoutDOM PNG形式のオブジェクトまたは文書。

ファイル名が指定されていない場合、スクリプト名から派生する(例えば、 /foo/myplot.py 作成されます /foo/myplot.png ）

パラメータ

  • obj (LayoutDOM or Document) -- 導出するレイアウト(行/列)、描画またはウィジェットオブジェクトまたは文書。

  • filename (str, optional) -- 文書を保存するファイル名(デフォルト値：なし)がなければ，ファイル名から推定する.

  • width (int) -- 導出されたレイアウトオブジェクトが印刷例である場合にのみ必要な幅である。そうでなければ、幅偏差は無視されるだろう。

  • height (int) -- 印刷例である場合にのみ、導出されるレイアウトオブジェクトの所望の高さである。そうでなければ、高度な偏差は無視されるだろう。

  • webdriver (selenium.webdriver) -- 画像を導出するためのSelenium WebDriver例.

  • timeout (int) -- Bokehの初期化を待つ最長時間(秒)(デフォルト値：5)(1.1.1で増加)。

戻り値

静的ファイルのファイル名を保存します。

戻り値の型

filename (str)

ファイルをディスクに保存するのではなく、イメージオブジェクトに直接アクセスする場合は、下位レベルのを使用してください get_screenshot_as_png() 機能します。

警告

応答するSIZING_MODEは、意外な大きさとアスペクト比を有するレイアウトを生成する可能性がある。デフォルト設定の使用をお勧めします fixed サイズパターンを調整する。

export_svgs(obj: Union[bokeh.models.layouts.LayoutDOM, bokeh.document.document.Document], *, filename: Optional[str] = None, width: Optional[int] = None, height: Optional[int] = None, webdriver: Optional[WebDriver] = None, timeout: int = 5) → List[str][ソース]

出力レイアウトでSVGの印刷を有効にします。各描画は異なるSVGファイルを生成する.

ファイル名が指定されていない場合、スクリプト名から派生する(例えば、 /foo/myplot.py 作成されます /foo/myplot.svg ）

パラメータ

  • obj (LayoutDOM object) -- 表示するレイアウト(行/列)、描画、またはウィジェットオブジェクト

  • filename (str, optional) -- 文書を保存するファイル名(デフォルト値：なし)がなければ，ファイル名から推定する.

  • width (int) -- 導出されたレイアウトオブジェクトが印刷例である場合にのみ必要な幅である。そうでなければ、幅偏差は無視されるだろう。

  • height (int) -- 印刷例である場合にのみ、導出されるレイアウトオブジェクトの所望の高さである。そうでなければ、高度な偏差は無視されるだろう。

  • webdriver (selenium.webdriver) -- 画像を導出するためのSelenium WebDriver例.

  • timeout (int) -- Bokehの初期化を待つ最長時間(秒)(デフォルト値：5)(1.1.1で増加)。

戻り値

SVGSファイルのファイル名リストを保存します。

戻り値の型

filenames (list(str))

警告

応答するSIZING_MODEは、意外な大きさとアスペクト比を有するレイアウトを生成する可能性がある。デフォルト設定の使用をお勧めします fixed サイズパターンを調整する。

install_notebook_hook(notebook_type, load, show_doc, show_app, overwrite=False)[ソース]

新しいノート型ディスプレイフックをインストールします。

BokehにはJupyterノートへのサポートが内蔵されています。しかし、他の地域社会もまた他のタイプのノートを使用している。この機能は、Bokehが他のノート内のコンテンツをどのように表示するかを示すための機構を他の項目に提供する。

この機能は，Bokehと新しいノート型を統合したい開発者に主に用いられている.

パラメータ

  • notebook_type (str) -- ノートタイプの名前，e.e. 'Jupyter' あるいは…。 'Zeppelin' この名前が以前にインストールされていれば、出現します。 RuntimeError 向上させなければなりません overwrite=True

  • load (callable) -- ノート型にBokehJSをロードするための関数.以下のパラメータを用いてこの関数を呼び出す：..Code-block：：Python Load(Resources，#A Resources Object for How to Load BokehJS Verbose，#詳細ロードバナーHIDE_BANNERを表示するか，#出力バナーLOAD_TIMEOUT#ロード失敗エラーの時間を報告)

  • show_doc (callable) -- ノート型でBokeh独立文書を表示するための機能。以下のパラメータを用いてこの関数を呼び出す：..Code-block：：Python show_doc(obj，#the Bokeh object to display state，#current boke.io“state”notebook_handle#ノートハンドルを要求するかどうか)ノートプラットフォームが描画の現地更新をサポートできれば，この関数はその目的に利用可能な不透明ノートハンドルを返すことができる.ハンドルが左右になる. show() また，フックを実装したライブラリ中の付加関数が適切なときに描画更新などに用いることができる.

  • show_app (callable) -- ノート型でBokehアプリケーションを表示するための機能。以下のパラメータを用いてこの関数を呼び出す：..Code-block：：Python show_app(app，#状態を表示するBokehアプリケーション，#current boke.io“state”notebook_url，#現在のアクティブノートページへのURL**kw#どのバックエンドにも特定のキーワードがそのまま渡されます)

  • overwrite (bool, optional) -- 既存のフックが新たに定義されることを許可するかどうか(デフォルト値：false)

戻り値

なし

例外

RuntimeError -- もし notebook_type すでにインストールされていて overwrite=False

output_file(filename, title='Bokeh Plot', mode=None, root_dir=None)[ソース]

デフォルト出力状態を，以下の場合にファイルに保存された出力を生成するように構成する. show() と言います。

現在のを変更しません Document 送信者. curdoc() それがそうです。ファイルとノート出力は同時にアクティブ状態にある可能性があるので、例えば、これはクリアされない。 output_notebook() それがそうです。

パラメータ

  • filename (str) -- HTML文書を保存するためのファイル名

  • title (str, optional) -- HTML文書のタイトル(デフォルト値：“Bokeh Plot”)

  • mode (str, optional) -- how to include BokehJS (default: 'cdn') One of: 'inline', 'cdn', 'relative(-dev)' or 'absolute(-dev)'. See bokeh.resources.Resources for more details.

  • root_dir (str, optional) -- “絶対”リソースのためのルートディレクトリ.(デフォルト値：なし)他のリソースタイプの場合、この値は無視され、例えば INLINE あるいは…。 CDN それがそうです。

戻り値

なし

注釈

一般に、これは、対話型セッションの開始時またはスクリプトの上部で呼び出されるべきである。

警告

この出力ファイルは、例えば、show()またはsave()が呼び出されるたびに保存されるたびに上書きされる。

output_notebook(resources=None, verbose=False, hide_banner=False, load_timeout=5000, notebook_type='jupyter')[ソース]

デフォルト出力状態を，以下の場合にノートセルで出力を生成するように構成する. show() と言います。注意してください。 show() 複数のオブジェクトを出力セルに表示するために、単一のセルで複数回呼び出すことができる。オブジェクトは順に表示される.

パラメータ

  • resources (Resource, optional) -- BokehJSのロード方式と位置(デフォルトCDN)

  • verbose (bool, optional) -- 詳細BokehJS banner(デフォルト値：false)が表示されているかどうか

  • hide_banner (bool, optional) -- Bokehバナーを隠蔽するかどうか(デフォルト値：False)

  • load_timeout (int, optional) -- 描画仮定ロードタイムアウト時のタイムアウト(ミリ秒単位)(デフォルト値：5000)

  • notebook_type (string, optional) -- ノートタイプ(デフォルト値：jupyter)

戻り値

なし

注釈

一般に、これは、対話型セッションの開始時またはスクリプトの上部で呼び出されるべきである。

push_notebook(*, document=None, state=None, handle=None)[ソース]

Jupyterノート出力セル内のBokehグラフは、新しいデータまたは属性値を使用して更新されます。

ノートを操作する際には show 関数はパラメータを伝達することができる notebook_handle=True これにより、Bokeh出力を後で更新するために使用することができるハンドルオブジェクトを返すことになる。いつ？ push_notebook 任意の属性更新(例えば、描画タイトルやデータソース値など)。前回から呼び出します push_notebook それとも原版の show 前に提示されたJupyter出力セルに適用されるBokeh出力を呼び出す.

GitHubリポジトリの examples/howto/notebook_comms カタログです。

パラメータ

  • document (Document, optional) -- A Document 押しのけ、押しのけ、突き放す。なければ使用する curdoc() それがそうです。(デフォルト値：なし)

  • state (State, optional) -- A State 物体です。Noneである場合、現在のデフォルト状態(より) output_file (など)全部使っています。(デフォルト値：なし)

戻り値

なし

サンプル

典型的な用法は通常以下のとおりである.

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(obj, filename=None, resources=None, title=None, template=None, state=None, **kwargs)[ソース]

現在の文書データを含むHTMLファイルを保存する.

Will fall back to the default output state (or an explicitly provided State object) for filename, resources, or title if they are not provided. If the filename is not given and not provided via output state, it is derived from the script name (e.g. /foo/myplot.py will create /foo/myplot.html)

パラメータ

  • obj (LayoutDOM object) -- 表示するレイアウト(行/列)、描画、またはウィジェットオブジェクト

  • filename (str, optional) -- 文書を保存するファイル名(デフォルト値：なし)がない場合は、デフォルト状態構成を使用します。

  • resources (Resources, optional) -- 使用するリソース構成(デフォルト値：なし)がない場合は、デフォルト状態構成(ある場合)を使用します。そうでなければ使う resources.INLINE それがそうです。

  • title (str, optional) -- HTML文書のタイトル(デフォルト：なし)がなければ，デフォルト状態タイトル値(あれば)を用いる.そうでなければ、“Bokeh Plot”を使用してください

  • template (Template, optional) -- HTML文書テンプレート(デフォルト値：file)JJIA 2テンプレート、必要なテンプレートパラメータについては、boke.code.templates.FILEを参照されたい。

  • state (State, optional) -- A State 物体です。Noneである場合、現在のデフォルトの暗黙的状態が使用される。(デフォルト値：なし)。

戻り値

HTMLファイルのファイル名を保存する.

戻り値の型

str

show(obj, browser=None, new='tab', notebook_handle=False, notebook_url='localhost:8888', **kw)[ソース]

Bokehオブジェクトまたはアプリケーションをすぐに表示します。

show() 複数のオブジェクトを表示するために、単一のJupyterノートユニット格で複数回呼び出すことができる。オブジェクトは順に表示される.

パラメータ

  • obj (LayoutDOM or Application or callable) -- 表示するBokehオブジェクト。ポーク図、ガジェット、レイアウト(すなわち行と列)は show それらを展示するためですいつ？ output_file 出力はHTMLファイルとなり，そのファイルも新しいブラウザウィンドウやオプションカードで開く.いつ？ output_notebook Jupyterノートで呼び出された場合，関連するノートにインライン接続されたノート出力セルを出力する.Jupyterノートでは，BokehアプリケーションやCallableを渡すことも可能である.呼び出し可能オブジェクトは使用に変換されます 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ノートページの位置(デフォルト値：“localhost：8888”)Bokehアプリケーションを表示する際には、Bokehサーバは、異なるURLからの接続を許可するように明示的に構成しなければなりません。このパラメータは、デフォルトで標準ノートホストとポートです。異なる位置で動作する場合、アプリケーションが正しく表示されるためには、この値を提供する必要があります。URLにプロトコルが提供されていない場合、例えば、そのフォーマットが“localhost：8888”であれば、“http”を使用する。 notebook_url 1つのintをバインディングとするサーバポートの関数であってもよい。ポートが提供されている場合、関数は、bokehサーバへの完全な共通URLを生成する必要がある。入力されていなければ，この関数はソースURLを生成する.

いくつかのパラメータは、いくつかの出力モードがアクティブ状態にある場合にのみ有用である：

  • ♪the browser そして new パラメータは以下の場合にのみ適用される output_file 活躍しています。

  • ♪the notebook_handle パラメータは以下の場合にのみ適用される output_notebook アクティブ状態にあり，非アプリケーションオブジェクトが表示されている.Jupyterノートのみをサポートしており，Trueの場合には他のノートタイプの異常を引き起こす.

  • ♪the notebook_url このパラメータは，JupyterノートにBokehアプリケーションが表示されている場合にのみ適用される.

  • 他のキーワードパラメータは Server Bokehアプリケーションを表示した場合(バージョン1.1新規)

戻り値

Jupyterノートにあるとき(持っている) output_notebook 有効化された)と notebook_handle=True 1つのハンドルに戻りますこのハンドルは push_notebook ほかにはありません。

bokeh.io.doc

curdoc()[ソース]

現在のデフォルト状態に戻るドキュメント。

戻り値

現在のデフォルト文書オブジェクト。

戻り値の型

Document

set_curdoc(doc)[ソース]

現在の文書を構成する(curdoc()により返される).

パラメータ

doc (Document) -- 私たちが出力する文書。

戻り値

なし

警告

この関数を呼び出すと，任意の既存文書を置き換える.

bokeh.io.export

export_png(obj: Union[bokeh.models.layouts.LayoutDOM, bokeh.document.document.Document], *, filename: Optional[str] = None, width: Optional[int] = None, height: Optional[int] = None, webdriver: Optional[WebDriver] = None, timeout: int = 5) → str[ソース]

導き出す LayoutDOM PNG形式のオブジェクトまたは文書。

ファイル名が指定されていない場合、スクリプト名から派生する(例えば、 /foo/myplot.py 作成されます /foo/myplot.png ）

パラメータ

  • obj (LayoutDOM or Document) -- 導出するレイアウト(行/列)、描画またはウィジェットオブジェクトまたは文書。

  • filename (str, optional) -- 文書を保存するファイル名(デフォルト値：なし)がなければ，ファイル名から推定する.

  • width (int) -- 導出されたレイアウトオブジェクトが印刷例である場合にのみ必要な幅である。そうでなければ、幅偏差は無視されるだろう。

  • height (int) -- 印刷例である場合にのみ、導出されるレイアウトオブジェクトの所望の高さである。そうでなければ、高度な偏差は無視されるだろう。

  • webdriver (selenium.webdriver) -- 画像を導出するためのSelenium WebDriver例.

  • timeout (int) -- Bokehの初期化を待つ最長時間(秒)(デフォルト値：5)(1.1.1で増加)。

戻り値

静的ファイルのファイル名を保存します。

戻り値の型

filename (str)

ファイルをディスクに保存するのではなく、イメージオブジェクトに直接アクセスする場合は、下位レベルのを使用してください get_screenshot_as_png() 機能します。

警告

応答するSIZING_MODEは、意外な大きさとアスペクト比を有するレイアウトを生成する可能性がある。デフォルト設定の使用をお勧めします fixed サイズパターンを調整する。

export_svg(obj: Union[bokeh.models.layouts.LayoutDOM, bokeh.document.document.Document], *, filename: Optional[str] = None, width: Optional[int] = None, height: Optional[int] = None, webdriver: Optional[WebDriver] = None, timeout: int = 5) → List[str][ソース]

レイアウトをSVGファイルとして導出したり，文書をSVGファイルのセットとして導出したりする.

ファイル名が指定されていない場合、スクリプト名から派生する(例えば、 /foo/myplot.py 作成されます /foo/myplot.svg ）

パラメータ

  • obj (LayoutDOM object) -- 表示するレイアウト(行/列)、描画、またはウィジェットオブジェクト

  • filename (str, optional) -- 文書を保存するファイル名(デフォルト値：なし)がなければ，ファイル名から推定する.

  • width (int) -- 導出されたレイアウトオブジェクトが印刷例である場合にのみ必要な幅である。そうでなければ、幅偏差は無視されるだろう。

  • height (int) -- 印刷例である場合にのみ、導出されるレイアウトオブジェクトの所望の高さである。そうでなければ、高度な偏差は無視されるだろう。

  • webdriver (selenium.webdriver) -- 画像を導出するためのSelenium WebDriver例.

  • timeout (int) -- Bokehの初期化を待つ最長時間(秒)(デフォルト値：5)

戻り値

SVGSファイルのファイル名リストを保存します。

戻り値の型

filenames (list(str))

警告

応答するSIZING_MODEは、意外な大きさとアスペクト比を有するレイアウトを生成する可能性がある。デフォルト設定の使用をお勧めします fixed サイズパターンを調整する。

export_svgs(obj: Union[bokeh.models.layouts.LayoutDOM, bokeh.document.document.Document], *, filename: Optional[str] = None, width: Optional[int] = None, height: Optional[int] = None, webdriver: Optional[WebDriver] = None, timeout: int = 5) → List[str][ソース]

出力レイアウトでSVGの印刷を有効にします。各描画は異なるSVGファイルを生成する.

ファイル名が指定されていない場合、スクリプト名から派生する(例えば、 /foo/myplot.py 作成されます /foo/myplot.svg ）

パラメータ

  • obj (LayoutDOM object) -- 表示するレイアウト(行/列)、描画、またはウィジェットオブジェクト

  • filename (str, optional) -- 文書を保存するファイル名(デフォルト値：なし)がなければ，ファイル名から推定する.

  • width (int) -- 導出されたレイアウトオブジェクトが印刷例である場合にのみ必要な幅である。そうでなければ、幅偏差は無視されるだろう。

  • height (int) -- 印刷例である場合にのみ、導出されるレイアウトオブジェクトの所望の高さである。そうでなければ、高度な偏差は無視されるだろう。

  • webdriver (selenium.webdriver) -- 画像を導出するためのSelenium WebDriver例.

  • timeout (int) -- Bokehの初期化を待つ最長時間(秒)(デフォルト値：5)(1.1.1で増加)。

戻り値

SVGSファイルのファイル名リストを保存します。

戻り値の型

filenames (list(str))

警告

応答するSIZING_MODEは、意外な大きさとアスペクト比を有するレイアウトを生成する可能性がある。デフォルト設定の使用をお勧めします fixed サイズパターンを調整する。

get_layout_html(obj: Union[bokeh.models.layouts.LayoutDOM, bokeh.document.document.Document], *, resources: bokeh.resources.Resources = <bokeh.resources.Resources object>, width: Optional[int] = None, height: Optional[int] = None) → str[ソース]
get_screenshot_as_png(obj: Union[bokeh.models.layouts.LayoutDOM, bokeh.document.document.Document], *, driver: Optional[WebDriver] = None, timeout: int = 5, resources: bokeh.resources.Resources = <bokeh.resources.Resources object>, width: Optional[int] = None, height: Optional[int] = None) → <module 'PIL.Image' from '/tmp/vpy/lib/python3.7/site-packages/PIL/Image.py'>[ソース]

以下の内容のスクリーンショットを取得します。 LayoutDOM 物体です。

パラメータ

  • obj (LayoutDOM or Document) -- 導出するレイアウト(行/列)、描画またはウィジェットオブジェクトまたは文書。

  • driver (selenium.webdriver) -- 画像を導出するためのSelenium WebDriver例.

  • timeout (int) -- 初期化を待つ最長時間。これは，Bokehをロードするタイムアウトとして用いられ，レイアウトレンダリングを待つ際に使用される.

戻り値

PNGからロードされた枕画像。

戻り値の型

image (PIL.Image.Image)

警告

応答するSIZING_MODEは、意外な大きさとアスペクト比を有するレイアウトを生成する可能性がある。デフォルト設定の使用をお勧めします fixed サイズパターンを調整する。

bokeh.io.notebook

class CommsHandle(comms, cell_doc)[ソース]
destroy_server(server_id)[ソース]

JupyterノートでdivのUUID idを除去または置換することが与えられ、対応するサーバセッションを破棄し、それを停止する。

get_comms(target_name)[ソース]

特定のターゲットのためのJupyter commsオブジェクトを作成し、このオブジェクトは、Jupyterノート内のBokeh文書を更新するために使用することができます。

パラメータ

target_name (str) -- Commsオブジェクトが接続すべきターゲット名

返品

木星通信会社(Jupyter Comms)

install_jupyter_hooks()[ソース]
install_notebook_hook(notebook_type, load, show_doc, show_app, overwrite=False)[ソース]

新しいノート型ディスプレイフックをインストールします。

BokehにはJupyterノートへのサポートが内蔵されています。しかし、他の地域社会もまた他のタイプのノートを使用している。この機能は、Bokehが他のノート内のコンテンツをどのように表示するかを示すための機構を他の項目に提供する。

この機能は，Bokehと新しいノート型を統合したい開発者に主に用いられている.

パラメータ

  • notebook_type (str) -- ノートタイプの名前，e.e. 'Jupyter' あるいは…。 'Zeppelin' この名前が以前にインストールされていれば、出現します。 RuntimeError 向上させなければなりません overwrite=True

  • load (callable) -- ノート型にBokehJSをロードするための関数.以下のパラメータを用いてこの関数を呼び出す：..Code-block：：Python Load(Resources，#A Resources Object for How to Load BokehJS Verbose，#詳細ロードバナーHIDE_BANNERを表示するか，#出力バナーLOAD_TIMEOUT#ロード失敗エラーの時間を報告)

  • show_doc (callable) -- ノート型でBokeh独立文書を表示するための機能。以下のパラメータを用いてこの関数を呼び出す：..Code-block：：Python show_doc(obj，#the Bokeh object to display state，#current boke.io“state”notebook_handle#ノートハンドルを要求するかどうか)ノートプラットフォームが描画の現地更新をサポートできれば，この関数はその目的に利用可能な不透明ノートハンドルを返すことができる.ハンドルが左右になる. show() また，フックを実装したライブラリ中の付加関数が適切なときに描画更新などに用いることができる.

  • show_app (callable) -- ノート型でBokehアプリケーションを表示するための機能。以下のパラメータを用いてこの関数を呼び出す：..Code-block：：Python show_app(app，#状態を表示するBokehアプリケーション，#current boke.io“state”notebook_url，#現在のアクティブノートページへのURL**kw#どのバックエンドにも特定のキーワードがそのまま渡されます)

  • overwrite (bool, optional) -- 既存のフックが新たに定義されることを許可するかどうか(デフォルト値：false)

戻り値

なし

例外

RuntimeError -- もし notebook_type すでにインストールされていて overwrite=False

load_notebook(resources=None, verbose=False, hide_banner=False, load_timeout=5000)[ソース]

Bokehマップを表示するためのIPythonノートを用意します。

パラメータ

  • resources (Resource, optional) -- BokehJSのロード方式と位置(デフォルトCDN)

  • verbose (bool, optional) -- 詳細設定を報告するかどうか(デフォルト値：FALSE)

  • hide_banner (bool, optional) -- Bokehバナーを隠蔽するかどうか(デフォルト値：False)

  • load_timeout (int, optional) -- 描画仮定ロードタイムアウト時のタイムアウト(ミリ秒単位)(デフォルト値：5000)

警告

配布されたBoehJSリソースHTMLコードを含む出力セルを除去することは，Bokeh CSSパターンを削除する可能性がある.

戻り値

なし

publish_display_data(*args, **kw)[ソース]
push_notebook(*, document=None, state=None, handle=None)[ソース]

Jupyterノート出力セル内のBokehグラフは、新しいデータまたは属性値を使用して更新されます。

ノートを操作する際には show 関数はパラメータを伝達することができる notebook_handle=True これにより、Bokeh出力を後で更新するために使用することができるハンドルオブジェクトを返すことになる。いつ？ push_notebook 任意の属性更新(例えば、描画タイトルやデータソース値など)。前回から呼び出します push_notebook それとも原版の show 前に提示されたJupyter出力セルに適用されるBokeh出力を呼び出す.

GitHubリポジトリの examples/howto/notebook_comms カタログです。

パラメータ

  • document (Document, optional) -- A Document 押しのけ、押しのけ、突き放す。なければ使用する curdoc() それがそうです。(デフォルト値：なし)

  • state (State, optional) -- A State 物体です。Noneである場合、現在のデフォルト状態(より) output_file (など)全部使っています。(デフォルト値：なし)

戻り値

なし

サンプル

典型的な用法は通常以下のとおりである.

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)
run_notebook_hook(notebook_type, action, *args, **kw)[ソース]

提供されたパラメータを用いてインストールされたノートフックを実行する.

パラメータ

  • noteboook_type (str) -- ノートフックがインストールされている既存の名前

  • actions (str) -- 実行するフック操作の名前は 'doc' あるいは…。 'app'

他のすべてのパラメータとキーワードパラメータは，与えられた方式でフック操作に完全に渡される.

戻り値

フック操作の結果

例外

RuntimeError -- フックや特定の操作がインストールされていない場合

show_app(app, state, notebook_url, port=0, **kw)[ソース]

Jupyterノート出力セルにBokehサーバアプリケーションを埋め込む.

パラメータ

  • app (Application or callable) -- Jupyterノートに埋め込まれたBokehアプリケーションです。

  • state (State) -- 未使用.

  • notebook_url (str or callable) -- 組込みアプリケーションを実行するノートサーバのURL.もし notebook_url 1つの文字列であれば，その値文字列を解析してソースURLと完全なサーバURLを構築する.Notebook_urlが呼び出し可能である場合、サーバポートであるパラメータを受け入れなければなりません。そうでなければ、いかなるパラメータも受け入れません。転送ポートであれば，呼び出し可能オブジェクトはサーバURLを生成しなければならず，そうでなければ，転送ポートがなければサーバのソースURLを生成しなければならない.

  • port (int) -- 組み込みサーバのポートは傍受されます。デフォルトの場合、ポートは0であり、これは、サーバがランダムな動的ポートをリッスンすることになる。

他のキーワードパラメータは Server (リリース1.1の追加)

戻り値

なし

show_doc(obj, state, notebook_handle)[ソース]

bokeh.io.output

output_file(filename, title='Bokeh Plot', mode=None, root_dir=None)[ソース]

デフォルト出力状態を，以下の場合にファイルに保存された出力を生成するように構成する. show() と言います。

現在のを変更しません Document 送信者. curdoc() それがそうです。ファイルとノート出力は同時にアクティブ状態にある可能性があるので、例えば、これはクリアされない。 output_notebook() それがそうです。

パラメータ

  • filename (str) -- HTML文書を保存するためのファイル名

  • title (str, optional) -- HTML文書のタイトル(デフォルト値：“Bokeh Plot”)

  • mode (str, optional) -- how to include BokehJS (default: 'cdn') One of: 'inline', 'cdn', 'relative(-dev)' or 'absolute(-dev)'. See bokeh.resources.Resources for more details.

  • root_dir (str, optional) -- “絶対”リソースのためのルートディレクトリ.(デフォルト値：なし)他のリソースタイプの場合、この値は無視され、例えば INLINE あるいは…。 CDN それがそうです。

戻り値

なし

注釈

一般に、これは、対話型セッションの開始時またはスクリプトの上部で呼び出されるべきである。

警告

この出力ファイルは、例えば、show()またはsave()が呼び出されるたびに保存されるたびに上書きされる。

output_notebook(resources=None, verbose=False, hide_banner=False, load_timeout=5000, notebook_type='jupyter')[ソース]

デフォルト出力状態を，以下の場合にノートセルで出力を生成するように構成する. show() と言います。注意してください。 show() 複数のオブジェクトを出力セルに表示するために、単一のセルで複数回呼び出すことができる。オブジェクトは順に表示される.

パラメータ

  • resources (Resource, optional) -- BokehJSのロード方式と位置(デフォルトCDN)

  • verbose (bool, optional) -- 詳細BokehJS banner(デフォルト値：false)が表示されているかどうか

  • hide_banner (bool, optional) -- Bokehバナーを隠蔽するかどうか(デフォルト値：False)

  • load_timeout (int, optional) -- 描画仮定ロードタイムアウト時のタイムアウト(ミリ秒単位)(デフォルト値：5000)

  • notebook_type (string, optional) -- ノートタイプ(デフォルト値：jupyter)

戻り値

なし

注釈

一般に、これは、対話型セッションの開始時またはスクリプトの上部で呼び出されるべきである。

reset_output(state=None)[ソース]

すべての出力モードのデフォルト状態をクリアします。

戻り値

なし

bokeh.io.saving

save(obj, filename=None, resources=None, title=None, template=None, state=None, **kwargs)[ソース]

現在の文書データを含むHTMLファイルを保存する.

Will fall back to the default output state (or an explicitly provided State object) for filename, resources, or title if they are not provided. If the filename is not given and not provided via output state, it is derived from the script name (e.g. /foo/myplot.py will create /foo/myplot.html)

パラメータ

  • obj (LayoutDOM object) -- 表示するレイアウト(行/列)、描画、またはウィジェットオブジェクト

  • filename (str, optional) -- 文書を保存するファイル名(デフォルト値：なし)がない場合は、デフォルト状態構成を使用します。

  • resources (Resources, optional) -- 使用するリソース構成(デフォルト値：なし)がない場合は、デフォルト状態構成(ある場合)を使用します。そうでなければ使う resources.INLINE それがそうです。

  • title (str, optional) -- HTML文書のタイトル(デフォルト：なし)がなければ，デフォルト状態タイトル値(あれば)を用いる.そうでなければ、“Bokeh Plot”を使用してください

  • template (Template, optional) -- HTML文書テンプレート(デフォルト値：file)JJIA 2テンプレート、必要なテンプレートパラメータについては、boke.code.templates.FILEを参照されたい。

  • state (State, optional) -- A State 物体です。Noneである場合、現在のデフォルトの暗黙的状態が使用される。(デフォルト値：なし)。

戻り値

HTMLファイルのファイル名を保存する.

戻り値の型

str

bokeh.io.showing

show(obj, browser=None, new='tab', notebook_handle=False, notebook_url='localhost:8888', **kw)[ソース]

Bokehオブジェクトまたはアプリケーションをすぐに表示します。

show() 複数のオブジェクトを表示するために、単一のJupyterノートユニット格で複数回呼び出すことができる。オブジェクトは順に表示される.

パラメータ

  • obj (LayoutDOM or Application or callable) -- 表示するBokehオブジェクト。ポーク図、ガジェット、レイアウト(すなわち行と列)は show それらを展示するためですいつ？ output_file 出力はHTMLファイルとなり，そのファイルも新しいブラウザウィンドウやオプションカードで開く.いつ？ output_notebook Jupyterノートで呼び出された場合，関連するノートにインライン接続されたノート出力セルを出力する.Jupyterノートでは，BokehアプリケーションやCallableを渡すことも可能である.呼び出し可能オブジェクトは使用に変換されます 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ノートページの位置(デフォルト値：“localhost：8888”)Bokehアプリケーションを表示する際には、Bokehサーバは、異なるURLからの接続を許可するように明示的に構成しなければなりません。このパラメータは、デフォルトで標準ノートホストとポートです。異なる位置で動作する場合、アプリケーションが正しく表示されるためには、この値を提供する必要があります。URLにプロトコルが提供されていない場合、例えば、そのフォーマットが“localhost：8888”であれば、“http”を使用する。 notebook_url 1つのintをバインディングとするサーバポートの関数であってもよい。ポートが提供されている場合、関数は、bokehサーバへの完全な共通URLを生成する必要がある。入力されていなければ，この関数はソースURLを生成する.

いくつかのパラメータは、いくつかの出力モードがアクティブ状態にある場合にのみ有用である：

  • ♪the browser そして new パラメータは以下の場合にのみ適用される output_file 活躍しています。

  • ♪the notebook_handle パラメータは以下の場合にのみ適用される output_notebook アクティブ状態にあり，非アプリケーションオブジェクトが表示されている.Jupyterノートのみをサポートしており，Trueの場合には他のノートタイプの異常を引き起こす.

  • ♪the notebook_url このパラメータは，JupyterノートにBokehアプリケーションが表示されている場合にのみ適用される.

  • 他のキーワードパラメータは Server Bokehアプリケーションを表示した場合(バージョン1.1新規)

戻り値

Jupyterノートにあるとき(持っている) output_notebook 有効化された)と notebook_handle=True 1つのハンドルに戻りますこのハンドルは push_notebook ほかにはありません。

bokeh.io.state

Bokeh描画APIに有用な暗黙的状態をカプセル化する.

注釈

同時に State オブジェクトは関数の場合にも明示的に操作することができる. output_file() 待ってください。 bokeh.io したがって，典型的な用法では不要である

Bokehグラフの出力を生成するにはいくつかの調整が必要である.

Document

描画間で共有可能なBokehモデル(例えば、範囲またはデータソースオブジェクト)は、1つの共通構造に組み合わされる。

Resources

生成された出力にクライアントライブラリBoehJSのJavaScriptとCSSをどのように含めるかを制御する.

これらのコンテンツの構成を手動で処理することができ、そのような例をいくつか見つけることができる examples/models カタログです。複雑なアプリケーションを開発する際には，このレベルで動作する必要があるか，あるいは希望される可能性がある.しかし、一般的な用途には、これはすぐに負担になるだろう。本モジュールは State クラスは、これらのオブジェクトをカプセル化し、多くの一般的な使用スキームにおいてそれらが正しく構成されることを保証する。

class State[ソース]

Bokeh出力の制御に関する状態を管理する.

output_file(filename, title='Bokeh Plot', mode=None, root_dir=None)[ソース]

出力を独立したHTMLファイルに配置する.

ほえる. output_file 他の呼び出しの影響は不明です。 output_notebook 待って。追加の出力先(HTMLファイルに公開)を追加します。任意の他のアクティブな出力モードはアクティブ状態を継続する。

パラメータ

  • filename (str) -- HTML文書を保存するためのファイル名

  • title (str, optional) -- HTML文書のタイトル

  • mode (str, optional) --

    BokehJS(デフォルト値： 'cdn' ）

    One of: 'inline', 'cdn', 'relative(-dev)' or 'absolute(-dev)'. See Resources for more details.

  • root_dir (str, optional) -- 絶対リソースのためのルートディレクトリ(デフォルト値：なし)は、他のリソースタイプの場合、例えば無視される。 INLINE あるいは…。 CDN それがそうです。

警告

指定された出力ファイルは、保存されるたびに上書きされ、例えば、毎回 show() あるいは…。 save() と言います。

output_notebook(notebook_type='jupyter')[ソース]

ノートセルに出力を生成する.

ほえる. output_notebook 他の呼び出しの影響は不明です。 output_file 待って。追加の出力先(ノート出力セルに公開)を追加します。任意の他のアクティブな出力モードはアクティブ状態を継続する。

戻り値

なし

reset()[ソース]

現在のアクティビティの出力モードをすべて無効にして設定する curdoc() 新鮮な空き地に行きます Document それがそうです。

後続呼び出し. show() 新しい出力モードが起動されるまでレンダリングされません。

戻り値

なし

property document

デフォルト設定 Document すべての出力操作に用いられる.

property file

ファイル出力のデフォルト構成を持つDICT(読み出し専用)

辞書値は、以下の形式を有する。

{
    'filename'  : # filename to use when saving
    'resources' : # resources configuration
    'title'     : # a title for the HTML document
}
property notebook

表示操作時にノート出力を生成するか否か.(読むだけ)

property notebook_type

ノート型

curstate()[ソース]

現在のステータス·オブジェクトに戻る

戻り値

現在のデフォルト状態オブジェクト

戻り値の型

State

bokeh.io.util

default_filename(ext: str) → str[ソース]

所与の拡張子を有するデフォルトファイル名を生成し、可能であれば、現在実行されているプロセスのファイル名の使用を試みる。

現在のプロセスのファイル名が利用できない(または書き込み不可)場合、所与の拡張子を有する一時ファイルが返される。

パラメータ

ext (str) -- ファイル名の必要な拡張子

戻り値

応力.応力

例外

RuntimeError -- 要求の拡張子が“.py”である場合

detect_current_filename() → Optional[str][ソース]

現在実行されているPythonプロセスのファイル名を返してみてください

ファイル名が検出されなければ、Noneを返す。

temp_filename(ext: str) → str[ソース]

所与の拡張子を有する一時的な書き込み可能ファイル名の生成