Dash㉙（コールバック停止／全体）

コールバック停止の方法

コールバックは特定の条件で停止することができます。

コールバックの停止の方法は下記の２種類があります。

  • 全体停止
    PreventUpdateクラスを使用
  • 部分停止
    no_updateクラスを使用

コールバック停止（全体）

PreventUpdateクラスを使って、hoverData属性が値を持たない場合コールバックを停止してみます。

[ソースコード]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
import json

import dash
import dash_core_components as dcc
import dash_html_components as html
import plotly.express as px
from dash.dependencies import Input, Output

gapminder = px.data.gapminder()   # データの読み込み
gapminder2007 = gapminder[gapminder['year'] == 2007]

app = dash.Dash(__name__)       # Dashインスタンスを生成

app.layout = html.Div(
    [
        html.H1('Gapminder Graph'),
        # 散布図
        dcc.Graph(
            id='graph1',
            figure=px.scatter(
                gapminder2007, x='gdpPercap', y='lifeExp', hover_name='country'
            )
        ),
        # ホバーデータを表示するコンポーネント
        html.P(id='hover_text1', style={'fontSize':'40', 'textAlign':'center', 'backgroundColor':'#CCFFFF'}),
        html.P(id='hover_text2', style={'fontSize':'40', 'textAlign':'center', 'backgroundColor':'#FFD5EC'})
    ],
    style={'width':'90%', 'fontSize':'40', 'textAlign':'center'}
)


# コールバック１
@app.callback(
    Output('hover_text1', 'children'),
    Input('graph1', 'hoverData')
)
def show_text1(text):
    return json.dumps(text)

# コールバック２
@app.callback(
    Output('hover_text2', 'children'),
    Input('graph1', 'hoverData')
)
def show_text2(text):
    if text is None:
        raise dash.exceptions.PreventUpdate # コールバック処理を停止
    return json.dumps(text)

if __name__ == '__main__':
    app.run_server(debug=True)      # アプリケーションを起動

ホバーデータを返すコールバックを２つ定義し、２つ目のコールバックではホバーデータがない場合コールバック処理を停止しています。（47行目）

[ブラウザで表示]

画面をロードした直後は、１つめのPコンポーネントには‘null’が表示されていますが、２つめのPコンポーネントには何も表示されていません。（ホバーデータがないのでコールバック処理が停止されたため）

グラフ上のデータをマウスオバーすると、両方のPコンポーネントに同じデータが表示されます。（ホバーデータがありコールバック処理が停止されなかったため）