bokeh.events

コールバックをトリガするために使用可能な粒度イベントを表す.

Bokeh文書とアプリケーションは，様々なタイプのインタラクションをサポートすることができる.これらのイベントは、一般に、マウスまたはタッチイベント、対話型ダウンサンプリングモードアクティブ化、ウィジェットまたはツールイベントなどのイベントに関連する。このモジュール内のクラスは、イベントが発生したときにコールバックを追加して実行するために、これらの異なるイベントを表す。

以下のようにイベントに応答することができる CustomJS コールバックは，Bokehサーバの有無にかかわらず動作可能である.これは伝達やイベントや CustomJS 模型から js_on_event() 方法です。当たる CustomJS ブラウザで実行すると cb_obj パラメータはコールバックをトリガする特定のイベントオブジェクトを含む.

from bokeh.events import ButtonClick
from bokeh.models import Button, CustomJS

button = Button()

button.js_on_event(ButtonClick, CustomJS(code='console.log("JS:Click")'))

あるいは、Bokehサーバ上で実行されるBokehアプリケーションのコンテキストで、イベント発生時にPythonコードの実行をトリガしてもよい。これはイベントクラスとコールバック関数を on_event() 方法です。コールバックは単一のパラメータを受け入れるべきです event これは，コールバックをトリガする特定のイベントオブジェクトが渡される.

from bokeh.events import ButtonClick
from bokeh.models import Button

button = Button()

def callback(event):
    print('Python:Click')

button.on_event(ButtonClick, callback)

注釈

事件に制限はない。いくつかの活動は MouseMove 非常に高い速度で触発されるかもしれない。

class ButtonClick(model)[ソース]

Bokeh Buttonウィジェットにボタンクリックイベントを宣言します。

class DocumentEvent[ソース]

すべてのBokeh文書イベントの基本クラス。

このクラスは通常単独インスタンス化には適用されない.

class DocumentReady[ソース]

文書が完全に空いている場合は通知します。

class DoubleTap(model, sx=None, sy=None, x=None, y=None)[ソース]

イベントは、Bokeh図でダブルクリックまたはダブルクリックすることが宣言されています。

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

class Event[ソース]

すべてのBokehイベントの基本クラス。

このクラスは通常単独インスタンス化には適用されない.

classmethod decode_json(dct)[ソース]

イベントのカスタムJSONデコーダ.

使用することができます object_hook 論争する. json.load あるいは…。 json.loads それがそうです。

パラメータ

dct (dict) -- 辞書を復号するためのJSON辞書にはキーがあるはずです event_name そして event_values

例外

ValueError, if the event_name is unknown --

サンプル

>>> import json
>>> from bokeh.events import Event
>>> data = '{"event_name": "pan", "event_values" : {"model_id": 1, "x": 10, "y": 20, "sx": 200, "sy": 37}}'
>>> json.loads(data, object_hook=Event.decode_json)
<bokeh.events.Pan object at 0x1040f84a8>
class LODEnd(model)[ソース]

ストーリーの“インタラクション詳細レベル”モデルの終了を宣言する.

パンまたはズームなどの相互作用の間、Bokehは、より高い相互作用率を維持するために、低減されたデータセットを一時的にレンダリングすることを選択することができる。これをインタラクティブな詳細階層(LOD)モデルと呼ぶ.LODパターンが終了したばかりであれば，このイベントをトリガする.

class LODStart(model)[ソース]

1つのストーリーで“インタラクションの詳細レベル”モデルの開始を宣言する.

パンまたはズームなどの相互作用の間、Bokehは、より高い相互作用率を維持するために、低減されたデータセットを一時的にレンダリングすることを選択することができる。これをインタラクティブな詳細階層(LOD)モデルと呼ぶ.LODパターンが始まったばかりであれば，このイベントをトリガする.

class MenuItemClick(model, item=None)[ソース]

Bokehメニュー項目のボタンクリックイベントを発表します。

class ModelEvent(model)[ソース]

すべてのBokeh Modelイベントの基底クラス.

このクラスは通常単独インスタンス化には適用されない.

__init__(model)[ソース]

新しい基本的なイベントを作る。

パラメータ

model (Model) -- イベントコールバックを登録するためのBokehモデル

class MouseEnter(model, sx=None, sy=None, x=None, y=None)[ソース]

Bokeh図上でマウスがイベントに入ることを宣言する.

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

マウスが描画キャンバス全体(任意の枠充填および軸または図例の空間を含む)から離れると、Enterイベントが生成される。

class MouseLeave(model, sx=None, sy=None, x=None, y=None)[ソース]

Bokeh図からマウス離脱イベントを宣言する.

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

マウスが描画キャンバス全体(任意の枠パッドや軸や図例の空間を含む)から離れると，Leaveイベントが生成される.

class MouseMove(model, sx=None, sy=None, x=None, y=None)[ソース]

Bokeh図上でマウス移動イベントを宣言する.

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

このイベントは、非常に高いレートでトリガされる可能性があり、ネットワークトラフィックまたはCPU負荷を増加させる可能性がある。

class MouseWheel(model, delta=None, **kwargs)[ソース]

Bokeh図上でマウスローライベントを宣言する.

delta

スクロール速度

タイプ

ブイ.ブイ

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

デフォルトの場合、Bokeh描画は、デフォルトスクロールイベントを阻止しない。 WheelZoomTool あるいは…。 WheelPanTool 活躍しています。この状況は将来のバージョンで変化するかもしれない。

class Pan(model, delta_x=None, delta_y=None, direction=None, **kwargs)[ソース]

Bokehブロック上でPAN活動が宣言された。

delta_x

X方向の転動量

タイプ

ブイ.ブイ

delta_y

Y方向の転動量

タイプ

ブイ.ブイ

direction

スクロール方向(1または−1)

タイプ

ブイ.ブイ

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

class PanEnd(model, sx=None, sy=None, x=None, y=None)[ソース]

ポークブロック上のPAN活動終了を宣言する.

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

class PanStart(model, sx=None, sy=None, x=None, y=None)[ソース]

ポークブロック上のPAN活動開始を宣言した。

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

class Pinch(model, scale=None, **kwargs)[ソース]

ポークのブロックに挟撃事件を宣言した。

scale

伸縮量(署名済み)

タイプ

ブイ.ブイ

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

このイベントは、タッチをサポートするデバイスにのみ適用されます。

class PinchEnd(model, sx=None, sy=None, x=None, y=None)[ソース]

ポークブロックでの挟撃事件が終了したことを宣言した。

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

このイベントは、タッチをサポートするデバイスにのみ適用されます。

class PinchStart(model, sx=None, sy=None, x=None, y=None)[ソース]

ポークブロックでの挟撃活動の開始を宣言した。

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

このイベントは、タッチをサポートするデバイスにのみ適用されます。

class PlotEvent(model)[ソース]

描画モデルのすべてのイベントの基底クラスに適用する.

class PointEvent(model, sx=None, sy=None, x=None, y=None)[ソース]

特定の(x，y)点に関連するUIイベントの基本クラス。

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

なお、データ空間座標は、任意の追加範囲ではなく、デフォルト範囲に対して、スクリーン空間の原点がHTMLキャンバスの左上隅に位置する。

class Press(model, sx=None, sy=None, x=None, y=None)[ソース]

Bokeh陰謀に関する記者会見を発表した。

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

class PressUp(model, sx=None, sy=None, x=None, y=None)[ソース]

Bokehブロックで加圧イベントが発表された。

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

class Reset(model)[ソース]

描画上でボタンを宣言してイベントをクリックします ResetTool それがそうです。

class Rotate(model, rotation=None, **kwargs)[ソース]

Bokehブロックでローテーション事件が発表された。

rotation

完成した回転(度単位)

タイプ

ブイ.ブイ

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

このイベントは、タッチをサポートするデバイスにのみ適用されます。

class RotateEnd(model, sx=None, sy=None, x=None, y=None)[ソース]

Bokehブロック上の回転イベントの終了を宣言する.

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

このイベントは、タッチをサポートするデバイスにのみ適用されます。

class RotateStart(model, sx=None, sy=None, x=None, y=None)[ソース]

Bokehブロック上での回転活動開始を宣言する.

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ

注釈

このイベントは、タッチをサポートするデバイスにのみ適用されます。

class SelectionGeometry(model, geometry=None, final=True)[ソース]

ブロック上でイベントの座標を選択することを宣言する.

geometry

選択イベント座標を含む辞書.

タイプ

ディクト！

final

マウス移動ごとに選択を行う場合には，イベントが最後の選択イベントであるかどうかを選択する.

タイプ

ブール.

class Tap(model, sx=None, sy=None, x=None, y=None)[ソース]

Bokeh図上のクリックまたはイベントをクリックすることを宣言します。

sx

中イベントのX座標 網をかける. 空間

タイプ

ブイ.ブイ

sy

中イベントのY座標 網をかける. 空間

タイプ

ブイ.ブイ

x

中イベントのX座標 data 空間

タイプ

ブイ.ブイ

y

中イベントのY座標 data 空間

タイプ

ブイ.ブイ