Py.Cafe
Exploring Plotly Express with Vizro Palettes
- folderassets/
- analyze_color_args.py
- app.py
- charts.py
- palettes.py
- requirements.txt
app.py
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
import itertools
import plotly.io as pio
import vizro.models as vm
from charts import CHARTS_BY_CATEGORY
from dash import Input, Output, State, clientside_callback, html
from palettes import DIVERGING_PALETTE, QUALITATIVE_PALETTE, SEQUENTIAL_PALETTE, SEQUENTIALMINUS_PALETTE
from vizro import Vizro
palettes = {
"colorscale": {
"sequential": SEQUENTIAL_PALETTE,
"diverging": DIVERGING_PALETTE,
"sequentialminus": SEQUENTIALMINUS_PALETTE,
},
"colorway": QUALITATIVE_PALETTE,
}
pio.templates["vizro_light"] = pio.templates.merge_templates("vizro_light", {"layout": palettes})
pio.templates["vizro_dark"] = pio.templates.merge_templates("vizro_dark", {"layout": palettes})
DISCRETE_TEXT = """
## Discrete
`px` functions have arguments `color_discrete_sequence` and `color_discrete_map`.
Palette is given by `template.layout.colorway`.
"""
CONTINUOUS_TEXT = """
## Continuous
`px` functions have arguments `color_continuous_scale`, `color_continuous_midpoint`, and `range_color`.
Palette is given by `template.layout.colorscale.sequential`, `template.layout.colorscale.diverging`, and `template.layout.colorscale.sequentialminus`.
"""
INTRODUCTION_TEXT = """
This page demonstrates all Plotly Express chart types (with the exception of `imshow` and deprecated `mapbox` functions) and the different discrete and continuous palettes available in Vizro.
### Features
* Change the continuous color scale using the dropdown in the header
* Change the container fill variant using the dropdown in the header
* Switch between light and dark themes using the theme toggle
* Hover over info icons to see the underlying trace type and Plotly Express function
### Chart Categories
{chart_categories_text}
"""
class CustomDashboard(vm.Dashboard):
"""Custom dashboard with page controls in header and no left panel."""
def _inner_page(self, page):
# Need to store the current page to access the controls in the custom_header method.
self._current_page = page
inner_page = super()._inner_page(page)
# Best hidden here rather than CSS so that collapse icon is also hidden.
inner_page["nav-control-panel"] = html.Div(id="nav-control-panel", hidden=True)
return inner_page
def custom_header(self):
return [control.build() for control in self._current_page.controls]
def make_chart_id(px_function, suffix):
return f"{px_function.split('.')[1]}_{suffix}"
def make_chart_container(category, charts):
"""Make a container for a chart category."""
graphs = []
grid = []
graph_index = 0
for chart_type in charts:
description = (
f"**Plotly Express function:** `{chart_type.px_function}` \n**Trace type:** `{chart_type.trace_type}`"
)
row = []
for figure, suffix in [
(chart_type.discrete_figure, "discrete"),
(chart_type.continuous_figure, "continuous"),
]:
if figure is not None:
graphs.append(
vm.Graph(
id=make_chart_id(chart_type.px_function, suffix),
title=chart_type.title,
header=chart_type.extra_notes,
figure=figure,
description=description,
)
)
row.append(graph_index)
graph_index += 1
else:
row.append(-1)
grid.append(row)
return vm.Container(
title=category,
layout=vm.Flex(),
components=[
vm.Container(
layout=vm.Grid(grid=[[0, 1]]), components=[vm.Text(text=DISCRETE_TEXT), vm.Text(text=CONTINUOUS_TEXT)]
),
vm.Container(layout=vm.Grid(grid=grid), components=graphs),
],
)
def generate_chart_categories_text():
"""Generate markdown text listing all chart categories and their charts."""
lines = []
for category, charts in CHARTS_BY_CATEGORY.items():
chart_titles = [chart.title.lower() for chart in charts]
lines.append(f"* **{category}**: {', '.join(chart_titles)}")
return "\n".join(lines)
introduction_container = vm.Container(
title="Introduction",
components=[vm.Text(text=INTRODUCTION_TEXT.format(chart_categories_text=generate_chart_categories_text()))],
)
chart_containers = [make_chart_container(category, charts) for category, charts in CHARTS_BY_CATEGORY.items()]
vm.Page.add_type("controls", vm.Dropdown)
page = vm.Page(
title="",
layout=vm.Flex(),
components=[vm.Tabs(tabs=[introduction_container, *chart_containers])],
controls=[
vm.Parameter(
targets=[
f"{make_chart_id(chart_type.px_function, 'continuous')}.color_continuous_scale"
for chart_type in itertools.chain.from_iterable(CHARTS_BY_CATEGORY.values())
if chart_type.continuous_figure is not None
],
selector=vm.Dropdown(
id="colorscale_selector",
options=["sequential colorscale", "diverging colorscale", "sequentialminus colorscale"],
multi=False,
extra={"style": {"width": "220px"}, "optionHeight": 32},
),
),
vm.Dropdown(
id="container_variant",
options=["outlined container", "filled container"],
multi=False,
extra={"style": {"width": "160px"}, "optionHeight": 32},
),
],
)
# Clientside callback to update container variant.
clientside_callback(
"""
function(variant_value, ...container_ids) {
const variants = {
"plain container": "",
"filled container": "bg-container p-3",
"outlined container": "border p-3"
};
const className = variants[variant_value];
return Array(container_ids.length).fill(className);
}
""",
[Output(container.id, "class_name") for container in [introduction_container, *chart_containers]],
Input("container_variant", "value"),
*[State(container.id, "id") for container in [introduction_container, *chart_containers]],
)
dashboard = CustomDashboard(title="Plotly Express Charts with Vizro Palettes", pages=[page])
Vizro().build(dashboard).run()
app.py
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
import itertools
import plotly.io as pio
import vizro.models as vm
from charts import CHARTS_BY_CATEGORY
from dash import Input, Output, State, clientside_callback, html
from palettes import DIVERGING_PALETTE, QUALITATIVE_PALETTE, SEQUENTIAL_PALETTE, SEQUENTIALMINUS_PALETTE
from vizro import Vizro
palettes = {
"colorscale": {
"sequential": SEQUENTIAL_PALETTE,
"diverging": DIVERGING_PALETTE,
"sequentialminus": SEQUENTIALMINUS_PALETTE,
},
"colorway": QUALITATIVE_PALETTE,
}
pio.templates["vizro_light"] = pio.templates.merge_templates("vizro_light", {"layout": palettes})
pio.templates["vizro_dark"] = pio.templates.merge_templates("vizro_dark", {"layout": palettes})
DISCRETE_TEXT = """
## Discrete
`px` functions have arguments `color_discrete_sequence` and `color_discrete_map`.
Palette is given by `template.layout.colorway`.
"""
CONTINUOUS_TEXT = """
## Continuous
`px` functions have arguments `color_continuous_scale`, `color_continuous_midpoint`, and `range_color`.
Palette is given by `template.layout.colorscale.sequential`, `template.layout.colorscale.diverging`, and `template.layout.colorscale.sequentialminus`.
"""
INTRODUCTION_TEXT = """
This page demonstrates all Plotly Express chart types (with the exception of `imshow` and deprecated `mapbox` functions) and the different discrete and continuous palettes available in Vizro.
### Features
* Change the continuous color scale using the dropdown in the header
* Change the container fill variant using the dropdown in the header
* Switch between light and dark themes using the theme toggle
* Hover over info icons to see the underlying trace type and Plotly Express function
### Chart Categories
{chart_categories_text}
"""
class CustomDashboard(vm.Dashboard):
"""Custom dashboard with page controls in header and no left panel."""
def _inner_page(self, page):
# Need to store the current page to access the controls in the custom_header method.
self._current_page = page
inner_page = super()._inner_page(page)
# Best hidden here rather than CSS so that collapse icon is also hidden.
inner_page["nav-control-panel"] = html.Div(id="nav-control-panel", hidden=True)
return inner_page
def custom_header(self):
return [control.build() for control in self._current_page.controls]
def make_chart_id(px_function, suffix):
return f"{px_function.split('.')[1]}_{suffix}"
def make_chart_container(category, charts):
"""Make a container for a chart category."""
graphs = []
grid = []
graph_index = 0
for chart_type in charts:
description = (
f"**Plotly Express function:** `{chart_type.px_function}` \n**Trace type:** `{chart_type.trace_type}`"
)
row = []
for figure, suffix in [
(chart_type.discrete_figure, "discrete"),
(chart_type.continuous_figure, "continuous"),
]:
if figure is not None:
graphs.append(
vm.Graph(
id=make_chart_id(chart_type.px_function, suffix),
title=chart_type.title,
header=chart_type.extra_notes,
figure=figure,
description=description,
)
)
row.append(graph_index)
graph_index += 1
else:
row.append(-1)
grid.append(row)
return vm.Container(
title=category,
layout=vm.Flex(),
components=[
vm.Container(
layout=vm.Grid(grid=[[0, 1]]), components=[vm.Text(text=DISCRETE_TEXT), vm.Text(text=CONTINUOUS_TEXT)]
),
vm.Container(layout=vm.Grid(grid=grid), components=graphs),
],
)
def generate_chart_categories_text():
"""Generate markdown text listing all chart categories and their charts."""
lines = []
for category, charts in CHARTS_BY_CATEGORY.items():
chart_titles = [chart.title.lower() for chart in charts]
lines.append(f"* **{category}**: {', '.join(chart_titles)}")
return "\n".join(lines)
introduction_container = vm.Container(
title="Introduction",
components=[vm.Text(text=INTRODUCTION_TEXT.format(chart_categories_text=generate_chart_categories_text()))],
)
chart_containers = [make_chart_container(category, charts) for category, charts in CHARTS_BY_CATEGORY.items()]
vm.Page.add_type("controls", vm.Dropdown)
page = vm.Page(
title="",
layout=vm.Flex(),
components=[vm.Tabs(tabs=[introduction_container, *chart_containers])],
controls=[
vm.Parameter(
targets=[
f"{make_chart_id(chart_type.px_function, 'continuous')}.color_continuous_scale"
for chart_type in itertools.chain.from_iterable(CHARTS_BY_CATEGORY.values())
if chart_type.continuous_figure is not None
],
selector=vm.Dropdown(
id="colorscale_selector",
options=["sequential colorscale", "diverging colorscale", "sequentialminus colorscale"],
multi=False,
extra={"style": {"width": "220px"}, "optionHeight": 32},
),
),
vm.Dropdown(
id="container_variant",
options=["outlined container", "filled container"],
multi=False,
extra={"style": {"width": "160px"}, "optionHeight": 32},
),
],
)
# Clientside callback to update container variant.
clientside_callback(
"""
function(variant_value, ...container_ids) {
const variants = {
"plain container": "",
"filled container": "bg-container p-3",
"outlined container": "border p-3"
};
const className = variants[variant_value];
return Array(container_ids.length).fill(className);
}
""",
[Output(container.id, "class_name") for container in [introduction_container, *chart_containers]],
Input("container_variant", "value"),
*[State(container.id, "id") for container in [introduction_container, *chart_containers]],
)
dashboard = CustomDashboard(title="Plotly Express Charts with Vizro Palettes", pages=[page])
Vizro().build(dashboard).run()