41

However, I feel saving the figure with plotly.express is pretty tricky.

How to save plotly.express or plotly plot into a individual html or static image file? Anyone can help?

vestland
  • 55,229
  • 37
  • 187
  • 305
roudan
  • 3,082
  • 5
  • 31
  • 72

5 Answers5

57

Updated answer:

With newer versions of plotly, static Image export in Python is a breeze. Just make sure to install kaleido using:

pip install -U kaleido

or, for Anaconda:

conda install -c conda-forge python-kaleido

And then run

fig.write_image("yourfile.png") 

Filetypes such as .jpeg and .pdf are also available options.

Producing an individual html file is still very easy:

Just use plotly.offline.plot(fig, filename='C:/plotlyplots/canada_offline.html')

This will give you a html file of a plotly express bar chart with the name lifeExp in a desired folder. Remember import plotly and not only import plotly.express as px.

Complete code:

# imports
import plotly
import plotly.express as px

# data
df = px.data.gapminder().query("continent=='Oceania'")

# plotly express bar chart
fig = px.line(df, x="year", y="lifeExp", color='country')

# html file
plotly.offline.plot(fig, filename='C:/plotlyplots/lifeExp.html')

Plot:

enter image description here

File as it appears in the foler:

enter image description here

From here you can open the file in any browser or any other way you want.

Here's the content as it is displayed using Notepad++

enter image description here

If you don't mind a bit of manual labor, you dan save a .png version using the toolbar:

enter image description here


Old answer for static images:

Producing a static image automatically is a bit mote tricky.

Take a look at Static Image Export in Python if you prefer that to html.

I like to use the approach including orca that can produce a variety of image files. I haven't found any other way to install it other than using npm which is installed with node.js If you get that in order, you only have to go run the following to get it up and running (I'm on Windows):

npm install -g electron@1.8.4 orca

pip install psutil requests

Then you can change the last line in the snippet above with fig.write_image("C:/plotlyplots/lifeExp.png") to produce a .png file.

vestland
  • 55,229
  • 37
  • 187
  • 305
  • Thank vestland. That is awesome!!! I appreciate it. One more question, if I like to include the plot into powerpoint, is it possible that I could still have the animation like plotly is designed for? For example, using animation_frame='year', to change the plot from different years. Thanks – roudan Jan 20 '20 at 20:49
  • Thanks vestland. I just posted a new question. – roudan Jan 20 '20 at 22:18
  • @roudan Happy to help! I'm no sure if there's a direct way to do that. I'd suggest you raise that as a new question. I'd like to know the answer to that myself! – vestland Jan 20 '20 at 22:22
  • 1
    Great answer @vestland . For those who like to save a png file, saving as html and opening this html in the browser gives the option "Download plot as png" (click the photo camera icon in the Plotly menu on the top). – Ruthger Righart Jun 18 '20 at 14:24
  • Every time I click the snapshot button in the toolbar, it just saves a blank white image. Do you know why that might be ? – theonlygusti Apr 28 '23 at 16:34
5

Exporting a static image in Python

Short story: pip install kaleido, then fig.write_image(<output_filename>).

I stumbled on this as I am also looking for ways on how to export plotly figures to static images. I realized that installing orca and making it work is not so easy, but good thing is they actually made this package called kaleido that is easier to install. Found it from these links:

rjd
  • 51
  • 1
  • 2
5

Somehow the above solution for .html files did not work, but I found that

from pathlib import Path

with Path("myfile.html").open("w") as f:
    f.write(fig.to_html())

worked just fine.

TaZi
  • 51
  • 1
  • 1
5

Adding to @vestland 's answer about saving to HTML, another way to do it according to the documentation would be:

import plotly.express as px

# a sample scatter plot figure created
fig = px.scatter(x=range(10), y=range(10))
fig.write_html("path/to/file.html")

You can read about it further (controlling size of the HTML file) here: Interactive HTML Export in Python

Aadi Shah
  • 99
  • 1
  • 8
0

If you want to make sure your notebook

  • Is distributable with its images
  • Works offline
  • Is convertable to formats like PDFs
  • Can be attached as a file
  • Can be read by generic tools that use HTML as input

...you can also set the Plotly itself to ensure every generated image is static, either SVG or PNG, and then embedded in the notebook itself. This is the opposite of Plotly interactive charts. This will also allow you to use HTML generated from notebook elsewhere (documentation) or make it available as a file (PDF for email).

You can set Plotly to offline mode and then force it to use svg output:

         # https://stackoverflow.com/a/52956402/315168
        from plotly.offline import init_notebook_mode
        init_notebook_mode()

        # https://stackoverflow.com/a/74609837/315168
        import plotly.io as pio
        pio.kaleido.scope.default_format = "svg"

        # https://plotly.com/python/renderers/#overriding-the-default-renderer
        pio.renderers.default = "svg"
        svg_renderer = pio.renderers["svg"] 
        # Have SVGs default 1200 pixel with
        svg_renderer.width = 1200

Now when you run the notebook, all charts are SVGs in the resulting notebook. You can save them individually through web br, or if you are interested multiple images as a whole, you can convert the notebook itself to other formats.

  • HTML with embedded images

  • PDF

Here is how to convert a notebook to a HTML:

    # Latex/Mactex needed 
    # To install on macOS:
    # brew install --cask mactex
    # eval "$(/usr/libexec/path_helper)"
    jupyter nbconvert --to pdf my_notebook.ipynb
Mikko Ohtamaa
  • 82,057
  • 50
  • 264
  • 435