-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
adding a JavaScript/Jinja example to dropdowns.md #4886
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
05e8485
7b0e444
28b6062
9af87c9
9ab1c69
9b057ee
fd655c2
21c1098
1594a39
bd50dd6
8e9c21a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
- Loading branch information
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -444,5 +444,94 @@ fig.update_layout(title_text="Yahoo") | |
| fig.show() | ||
| ``` | ||
|
|
||
| ### Creating several independent graphs and using Jinja to insert them into a JavaScript enabled webpage | ||
|
||
|
|
||
| It is often easier to create each potential view as a separate graph and then use Jinja to insert each potential view into a div on a JavaScript enabled webpage with a drop down that chooses which div to display. This approach produces code that requires little customization or updating as you e.g. add, drop, or reorder views or traces, so it is particularly compelling for prototyping and rapid iteration. This requires both a Python program and a Jinja template file. You may want to consult the documentation on [using Jinja templates with Plotly](https://plotly.com/python/interactive-html-export/#inserting-plotly-output-into-html-using-a-jinja2-template). | ||
|
|
||
| #### Python Code File | ||
|
|
||
| ``` | ||
| import plotly.express as px | ||
| from jinja2 import Template | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this needs to be marked as a python block. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. agreed! Thanks! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This probably actually needs the same There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added in commit 5; there's something funky with the preview screen -- neither the example -- which demonstrably renders correctly when live -- nor my new commit convert e.g. > to > in preview mode. I hope I've done everything right, but it's difficult to tell. |
||
| import collections | ||
| # Load the gapminder dataset | ||
| df = px.data.gapminder() | ||
|
|
||
| #create a dictionary with Plotly figures as values | ||
rl-utility-man marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| fig_dict = {} | ||
|
|
||
| # Loop through each unique continent and create a scatter plot using the 2007 data | ||
| for continent in df['continent'].unique(): | ||
| # Filter data for the current continent | ||
| continent_data = df[(df['continent'] == continent) & (df['year'] == 2007)] | ||
|
|
||
| fig_dict[continent] = px.scatter(continent_data, x='gdpPercap', y='lifeExp', | ||
| title=f'GDP vs Life Expectancy for {continent}', | ||
| labels={'gdpPercap': 'GDP per Capita (USD)', 'lifeExp': 'Life Expectancy (Years)'}, | ||
| hover_name='country', | ||
| ) | ||
|
|
||
| # Create a dictionary, data_for_jinja with two entries: | ||
| # the value for the "dropdown_entries" key contains string containing a series of <option> tags, one for each item in the drop down | ||
| # the value for the "divs" key contains a string with a series of <div> tags, each containing the content that appears only when the user selects the corresponding item from the dropdown | ||
| # in this example, that content is a figure and descriptive text. | ||
| data_for_jinja= collections.defaultdict(str) | ||
| text_dict = {} | ||
| for n, figname in enumerate(fig_dict.keys()): | ||
| text_dict[figname]=f"Here is some custom text about the {figname} figure" #This is a succinct way to populate text_dict; in practice you'd probably populate it manually elsewhere | ||
| data_for_jinja["dropdown_entries"]+=f"<option value='{figname}'>{fig_dict[figname].layout.title.text}</option>" | ||
| #YOU MAY NEED TO UPDATE THE LINK TO THE LATEST PLOTLY.JS | ||
| fig_html = fig_dict[figname].to_html(full_html=False, config=dict(responsive=False, scrollZoom=False, doubleClick=False), include_plotlyjs = "https://cdn.plot.ly/plotly-2.35.2.min.js") | ||
rl-utility-man marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| data_for_jinja["divs"]+=f'<div id="{figname}" class="content-div" {"style=""display:none;"""*(n>0)}>{fig_html}{text_dict[figname]}</div>' | ||
|
|
||
| # Insert data into the template and write the file to disk | ||
| # YOU WILL LIKELY NEED TO CUSTOMIZE THESE PATHS | ||
| input_template_path=r"C:\data\demo_template.jinja" | ||
| output_html_path=r"C:\data\demo_result.html" | ||
rl-utility-man marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| with open(output_html_path, "w", encoding='utf-8') as output_file: | ||
| with open(input_template_path) as template_file: | ||
| j2_template = Template(template_file.read()) | ||
| output_file.write(j2_template.render(data_for_jinja)) | ||
| ``` | ||
|
|
||
| #### Jinja HTML Template | ||
|
|
||
| ``` | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
|
|
||
| </head> | ||
|
||
| <body> | ||
| <div class="container"> | ||
| <h1>Select an analysis</h1> | ||
| <select id="dropdown" class="form-control"> | ||
| {{ dropdown_entries }} | ||
| </select> | ||
|
|
||
|
|
||
| {{ divs }} | ||
|
|
||
| </div> | ||
|
|
||
| <script> | ||
| document.getElementById('dropdown').addEventListener('change', function() { | ||
| const divs = document.querySelectorAll('.content-div'); | ||
| divs.forEach(div => div.style.display = 'none'); | ||
|
|
||
| const selectedDiv = document.getElementById(this.value); | ||
| if (selectedDiv) { | ||
| selectedDiv.style.display = 'block'; | ||
| } | ||
| }); | ||
| </script> | ||
| </body> | ||
| </html> | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| #### Reference | ||
| See https://plotly.com/python/reference/layout/updatemenus/ for more information about `updatemenu` dropdowns. | ||