bokeh.embed

WebページにBokeh独立とサーバコンテンツを埋め込む機能を提供する.

autoload_static(model: Union[bokeh.model.Model, bokeh.document.document.Document], resources: bokeh.resources.Resources, script_path: str) → Tuple[str, str][ソース]

Bokehマップを埋め込むために利用可能なJavaScriptコードとスクリプトタグを返す.

描画データは返されたJavaScriptコードに直接格納される.

パラメータ
戻り値

以下の位置に保存するJavaScriptコード script_path 1つと <script> タグをロードします

戻り値の型

(js, tag)

例外

ValueError --

components(models: Union[bokeh.model.Model, bokeh.document.document.Document, Sequence[Union[bokeh.model.Model, bokeh.document.document.Document]], Dict[str, Union[bokeh.model.Model, bokeh.document.document.Document]]], wrap_script: bool = True, wrap_plot_info: bool = True, theme: Union[None, bokeh.themes.theme.Theme, Type[bokeh.embed.util.FromCurdoc]] = None) → Tuple[str, Any][ソース]

HTMLコンポーネントを返してBokehグラフを埋め込む.描画データは返されたHTMLに直接格納される.

例は、Examples/embed/embed_multiple.pyで見つけることができる

返されたコンポーネントBokehJSリソースは ロードされました それがそうです。これらが埋め込まれたHTMLテンプレートには,以下のスクリプトタグが必要である.コンポーネントが小さなコンポーネントおよびテーブルを使用する場合にのみ、小さなコンポーネントおよびテーブルリソースが必要となる。

<script src="https://cdn.bokeh.org/bokeh/release/bokeh-x.y.z.min.js"></script>
<script src="https://cdn.bokeh.org/bokeh/release/bokeh-widgets-x.y.z.min.js"></script>
<script src="https://cdn.bokeh.org/bokeh/release/bokeh-tables-x.y.z.min.js"></script>

Jupyterノートでは、同じノートユニットでコンポーネントや表示を使用することは不可能であることに注意されたい。

パラメータ
  • models (Model|list|dict|tuple) -- 単一のモデル、モデルリスト/タプルまたはキー、およびモデル辞書。

  • wrap_script (boolean, optional) -- Trueであれば,返されたjavascriptはスクリプトタグに実装される.(デフォルト値:TRUE)

  • wrap_plot_info (boolean, optional) --

    Trueであれば戻ります <div> 弦楽です。そうでなければ、あなた自身のdivを構築するために使用できるdictsを返します。(デフォルト値:TRUE)

    Falseであれば,返される辞書は以下の情報を含む:

    {
        'modelid':  'The model ID, used with Document.get_model_by_id',
        'elementid': 'The css identifier the BokehJS will look for to target the plot',
        'docid': 'Used by Bokeh to find the doc embedded in the returned script',
    }
    

  • theme (Theme, optional) -- コンポーネントを作成する際に指定されたトピックを適用します。指定されていない場合、または指定されておらず、提供されたモデルが文書の完全なルートセットを構成する場合、文書の主題はコンポーネントに適用される。そうでなければ、デフォルトのトピックが適用されます。

戻り値

UTF-8コード [(スクリプト,div[s])] あるいは…。 [(raw_script, plot_info[s])]

サンプル

デフォルトエンベロープパラメータ値を使用する:

components(plot)
# => (script, plot_div)

components((plot1, plot2))
# => (script, (plot1_div, plot2_div))

components({"Plot 1": plot1, "Plot 2": plot2})
# => (script, {"Plot 1": plot1_div, "Plot 2": plot2_div})

サンプル

小包パラメータを False

components(plot, wrap_script=False, wrap_plot_info=False)
# => (javascript, plot_dict)

components((plot1, plot2), wrap_script=False, wrap_plot_info=False)
# => (javascript, (plot1_dict, plot2_dict))

components({"Plot 1": plot1, "Plot 2": plot2}, wrap_script=False, wrap_plot_info=False)
# => (javascript, {"Plot 1": plot1_dict, "Plot 2": plot2_dict})
file_html(models: Union[bokeh.model.Model, bokeh.document.document.Document, Sequence[bokeh.model.Model]], resources: Union[bokeh.resources.Resources, Tuple[bokeh.resources.JSResources, bokeh.resources.CSSResources]], title: Optional[str] = None, template: Union[jinja2.environment.Template, str] = <Template 'file.html'>, template_variables: Dict[str, Any] = {}, theme: Union[None, bokeh.themes.theme.Theme, Type[bokeh.embed.util.FromCurdoc]] = None, suppress_callback_warning: bool = False, _always_new: bool = False)str[ソース]

Bokeh ModelまたはDocumentオブジェクトに埋め込まれたHTML文書を返す.

描画データは返されたHTMLに直接格納され,JS/CSSリソースの独立カスタマイズとJJANA 2テンプレートのカスタマイズがサポートされる.

パラメータ
  • models (Model or Document or seq[Model]) -- 提示される1つ以上のbokehオブジェクトは、一般にモデルまたは文書である

  • resources (Resources or tuple(JSResources or None, CSSResources or None)) -- Bokeh JS&CSS資産の資源配置。

  • title (str, optional) -- HTML文書のタイトル <title> ラベルまたはラベルなし。(デフォルト値:なし)ない場合は、所与の印刷オブジェクトから文書タイトルを自動的に検索しようと試みる。

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

  • template_variables (dict, optional) -- JJIA 2テンプレートで使用する変数.使用すると、以下の変数名が上書きされます:title、bokeh_js、bokeh_css、lot_script、lot_div

  • theme (Theme, optional) -- 指定されたトピックを作成したhtmlに適用します。もし None または指定されておらず、文書または文書の集合体ルートが関数に伝達されると、文書の主題が適用される。そうでなければ、デフォルトのトピックが適用されます。

  • suppress_callback_warning (bool, optional) -- 通常、Pythonコールバックを持つBokeh文書から独立したHTMLを生成することにより警告を招き、宣言コールバックが動作しません。しかし、この値をTrue(デフォルト値:False)に設定することで、この警告をキャンセルすることができる。

戻り値

UTF-8コードのHTML

json_item(model: bokeh.model.Model, target: Optional[str] = None, theme: Union[None, bokeh.themes.theme.Theme, Type[bokeh.embed.util.FromCurdoc]] = None) → Any[ソース]

独立したBokehコンテンツを埋め込むために使用可能なJSONブロックを返す。

パラメータ
  • model (Model) -- Bokehオブジェクトを埋め込む

  • target (string, optional) -- モデルをその中のdiv idに埋め込む.そうでなければ,JavaScript呼び出しでターゲットIDを提供しなければならない.

  • theme (Theme, optional) -- 指定されたトピックを作成したhtmlに適用します。もし None または指定されておらず、文書または文書の集合体ルートが関数に伝達されると、文書の主題が適用される。そうでなければ、デフォルトのトピックが適用されます。

戻り値

類JSON

この関数は,BokehJS関数が使用可能なJSONブロックを返す. Bokeh.embed.embed_item それがそうです。例えばフラスコの最終点は /plot Bokehグラフをidを持つdivに埋め込むために以下が返される可能性がある “私のエピソード”

@app.route('/plot')
def plot():
    p = make_plot('petal_width', 'petal_length')
    return json.dumps(json_item(p, "myplot"))

そして,WebページはそのJSONを検索して呼び出すことができる. Bokeh.embed.embed_item

<script>
fetch('/plot')
    .then(function(response) { return response.json(); })
    .then(function(item) { Bokeh.embed.embed_item(item); })
</script>

あるいは,ページソースコードにオブジェクトdiv idを直接提供した方が便利であることも可能である.もし target_id この関数を呼び出す際には省略される:

return json.dumps(json_item(p))

私たちに伝えられています embed_item 使用しているのは

Bokeh.embed.embed_item(item, "myplot");
server_document(url='default', relative_urls=False, resources='default', arguments=None, headers=None)[ソース]

Bokehサーバのコンテンツに埋め込まれたスクリプトタグを返す.

これらの手法を用いて埋め込まれたbokehアプリケーションにはブラウザウィンドウヘッダは設定されていない.

パラメータ
  • url (str, optional) -- Bokehサーバ上のBokehアプリケーションのURL(デフォルト値:“default”)であれば "default" デフォルトURL http://localhost:5006/ 使用されます。

  • relative_urls (bool, optional) -- 資源の相対URLを使用するかどうか。もし True BokehJS,JavaScript,CSSなどの資源のために生成されるリンクは相対リンクとなる.これは通常 False しかし設定しなければなりません True 相対URLのみが有効な場合。例えば、いくつかの構成では、バックエージェントの後でBokehが実行される場合

  • resources -- 文書と共にロードする必要があるリソースを指定する文字列。もし default その後、デフォルトのJS/CSS bokehファイルがロードされます。そうでなければ、リソースファイルはロードされません。これらのリソースファイルを他の方法(例えば、キャッシュサーバから)で提供することを望む場合、これは非常に有用である。しかし、単独でロードされたリソースファイルのバージョンはサーバのバージョンと同じであり、そうでなければレンダリングが正常に動作しない可能性があることに注意されたい。

戻り値

A <script> Bokehサーバコンテンツのタグを埋め込む.

server_session(model=None, session_id=None, url='default', relative_urls=False, resources='default', headers={})[ソース]

Bokehサーバ上の特定の既存セッションのコンテンツに埋め込まれたスクリプトタグを返す。

この関数は通常以前からのみ使用されています bokeh.client 原料の薬。

これらの手法を用いて埋め込まれたbokehアプリケーションにはブラウザウィンドウヘッダは設定されていない.

注釈

一般に、異なるまたは複数のページロードの場合、この関数の出力を保存または再使用することは望ましくありません。

パラメータ
  • model (Model or None, optional) -- セッションから提示されるオブジェクト、またはなし。(デフォルト値:なし)ない場合は、文書全体を表示します。

  • session_id (str) -- サーバセッションID

  • url (str, optional) -- Bokehサーバ上のBokehアプリケーションのURL(デフォルト値:“default”)であれば "default" デフォルトURL http://localhost:5006/ 使用されます。

  • relative_urls (bool, optional) -- 資源の相対URLを使用するかどうか。もし True BokehJS,JavaScript,CSSなどの資源のために生成されるリンクは相対リンクとなる.これは通常 False しかし設定しなければなりません True 相対URLのみが有効な場合。例えば、いくつかの構成では、バックエージェントの後でBokehが実行される場合

  • resources -- 文書と共にロードする必要があるリソースを指定する文字列。もし default その後、デフォルトのJS/CSS bokehファイルがロードされます。そうでなければ、リソースファイルはロードされません。これらのリソースファイルを他の方法(例えば、キャッシュサーバから)で提供することを望む場合、これは非常に有用である。しかし、単独でロードされたリソースファイルのバージョンはサーバのバージョンと同じであり、そうでなければレンダリングが正常に動作しない可能性があることに注意されたい。

戻り値

A <script> Bokehサーバコンテンツのタグを埋め込む.それは.警告:同じコードを繰り返し使用するのは通常良い考えではない session_id ページごとにロードします。これはスケーラビリティやセキュリティの問題となり,“google文書を共有する”という行為を招く可能性があり,これは我々が望むものではない可能性がある.