Altair: Hide Export as PNG/ View Source/ Open in Vega Editor

Created on 29 Mar 2018 · 14Comments · Source: altair-viz/altair

Hi,
i recently discovered Altair and I'm playing around with it.
It looks quite impressive and easy to use!

Under every visualization i create an Export as PNG/ View Source/ Open in Vega Editor footer is shown.
I already searched the documentation but couldn't find where to disable this "footer row".
Could anybody give me a hint how i can turn off this Footer?

Kind regards
Bernd

enhancement

Source

bgruenefeld

Most helpful comment

The save() method accepts an embed_options parameter, that lets you specify this sort of thing. So, for example you could do

chart.save('viz.html', embed_options={'actions': False})

jakevdp on 12 Feb 2019

👍7 🎉2

All 14 comments

There is currently no way to do this. We've been talking about a model to give users control over chart metadata, but it's not implemented yet.

jakevdp on 29 Mar 2018

👍1

Hi @yashagrawal3 - this issue is a bit complicated because it requires defining a Python-side API for setting metadata, defining a way for that metadata to be passed to the frontends, and updating all the frontends to handle metadata in that format. None of those three things has been figured out yet, though #678 is one proposal for how to handle the first of the three related issues.

jakevdp on 23 Apr 2018

I'm hoping to tackle related things this week, so hopefully there will be some progress here :smile:

jakevdp on 23 Apr 2018

@bgruenefeld You can hide the chart footer by inserting <style>.vega-actions {display: none}</style> in the html.

repmax on 29 Apr 2018

Note: as soon as #776 is merged, there will be a better story for controlling plot metadata without manually adjusting CSS

jakevdp on 29 Apr 2018

This works now in the most recent versions of the notebook and jupyterlab renderers; you can use, e.g. for the notebook:

alt.renderers.enable('notebook', embed_options={'actions': False})

jakevdp on 17 May 2018

👍2

Didn't want to open a new issue about this so commenting here.

This works in the notebook, however, chart.save('viz.html') still has the footer. Is there a way to turn it off in the HTML, or should we add CSS as mentioned above?

In my specific use case, I am using a vega html export in a reveal.js slide, so I would love the HTML export to not have the footer.

Best,
Gaurav

ggada on 12 Feb 2019

The save() method accepts an embed_options parameter, that lets you specify this sort of thing. So, for example you could do

chart.save('viz.html', embed_options={'actions': False})

jakevdp on 12 Feb 2019

👍7 🎉2

Thank you so much for the quick response Jake.
That works perfect!

ggada on 12 Feb 2019

The current best way to do this (Altair 4.0) is to run

alt.renderers.set_embed_options(actions=False)

which should work with any renderer.

jakevdp on 17 Dec 2019

👍2

@jakevdp alt.renderers.set_embed_options(actions=False) works well in Notebook. However when I do the same in a script it doesn't seem to work. In my script I actually return to_json() called on the chart by a function which is then embedded using vega embed.

Is there any way to make it work there? I tried looking for passing kwargs = {'actions': False} in to_json but that gives errors.

armsp on 16 May 2020

@jakevdp I found a way...was experimenting with it and the important piece is {"actions": false, "mode": "vega-lite"}
So if using templates it can be used as -

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="style.css">
  <script src="https://cdn.jsdelivr.net/npm/vega@{vega_version}"></script>
  <script src="https://cdn.jsdelivr.net/npm/vega-lite@{vegalite_version}"></script>
  <script src="https://cdn.jsdelivr.net/npm/vega-embed@{vegaembed_version}"></script>
</head>
<body>

<div id="vis1"></div>

<script type="text/javascript">
  vegaEmbed('#vis1', {spec1}, {kwargs}).catch(console.error);

</script>
</body>
</html>
"""
with open('viz.html', 'w') as f:
    f.write(two_charts_template.format(
        vega_version=alt.VEGA_VERSION,
        vegalite_version=alt.VEGALITE_VERSION,
        vegaembed_version=alt.VEGAEMBED_VERSION,
        spec1=final_map.to_json(indent=None),
        kwargs = """{"actions": false, "mode": "vega-lite"}"""
        # spec2=final_map.to_json(indent=None),
    ))

armsp on 16 May 2020

We should document this somewhere too

armsp on 16 May 2020

It’s documented in the Vega-Embed docs. Since you’re using Vega-Embed to display your exported JSON, that seems like the appropriate place.

jakevdp on 16 May 2020

Was this page helpful?

0 / 5 - 0 ratings