Skip to main content

Convert plotly figures to LaTeX / tikz figures

Project description

logo-tikzplotly

PyPi Version PyPi Downloads PyPi License PyPI pyversions

GitHub release Issue codecov GitHub Actions Workflow Status

Tikzplotly

Convert plotly figures to tikz code for inclusion into PGFPlots (PGF/TikZ) figures.

This results in a tikz code, that can be easily included into your LaTeX document. This also allows to easily edit the content of the figure.

Example

The following Python code

import plotly.express as px
import tikzplotly

df = px.data.gapminder().query("continent == 'Oceania'")
fig = px.line(df, x='year', y='lifeExp', color='country', markers=True)
tikzplotly.save("example.tex", fig)

will result in the following tikz code

\pgfplotstableread{data0 Australia New_Zealand
1952 69.12 69.39
1957 70.33 70.26
1962 70.93 71.24
1967 71.1 71.52
1972 71.93 71.89
1977 73.49 72.22
1982 74.74 73.84
1987 76.32 74.32
1992 77.56 76.33
1997 78.83 77.55
2002 80.37 79.11
2007 81.235 80.204
}\dataZ

\begin{tikzpicture}

\definecolor{636efa}{HTML}{636efa}
\definecolor{EF553B}{HTML}{EF553B}

\begin{axis}[
xlabel=year,
ylabel=lifeExp,
]
\addplot+ [mark=*, solid, color=636efa, mark options={solid, draw=636efa}] table[y=Australia] {\dataZ};
\addlegendentry{Australia}
\addplot+ [mark=*, solid, color=EF553B, mark options={solid, draw=EF553B}] table[y=New_Zealand] {\dataZ};
\addlegendentry{New Zealand}
\end{axis}
\end{tikzpicture}

Installation

Tikzplotly is available from the Python Package Index, so it can be installed with pip :

pip install tikzplotly

Usage

  1. Generate the figure with Plotly,
  2. Invoke tikzplotly to convert the figure to tikz code :
import tikzplotly

tikzplotly.save("figure.tex", fig)
  1. Add the content of the generated file figure.tex to your LaTeX document :
\input{figure.tex}

To correctly compile the document, you will need to add the following packages to your preamble :

\usepackage{pgfplots}
\pgfplotsset{compat=newest}

Note

  • This module is in development and new features are added bit by bit, when needed. If you have a feature request, please open an issue with the plotly figure you want to convert and the desired output. You can also submit a pull request with the desired feature !
  • Some feature can result in different output between the plotly figure and the tikz figure, for instance the size of markers, more details can be found in the documentation.

References

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tikzplotly-0.2.0.tar.gz (43.5 kB view details)

Uploaded Source

Built Distribution

tikzplotly-0.2.0-py3-none-any.whl (43.5 kB view details)

Uploaded Python 3

File details

Details for the file tikzplotly-0.2.0.tar.gz.

File metadata

  • Download URL: tikzplotly-0.2.0.tar.gz
  • Upload date:
  • Size: 43.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for tikzplotly-0.2.0.tar.gz
Algorithm Hash digest
SHA256 cf6a1fd6d769779f13506d4b0e6dd4dea7f762e11eba4ed7d204ed8bdee65fe9
MD5 29b25641c6db23f50049fd44258a5bc4
BLAKE2b-256 9913b9e3fc09be9f5b353fa87d3a82f1735d48d838bda051386cf9b315c47f8a

See more details on using hashes here.

File details

Details for the file tikzplotly-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: tikzplotly-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 43.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for tikzplotly-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac4bff3360fe8962ad54d3319d1da9b4fc8d8fc43049a0bbe1737d353f1b04da
MD5 7df660511b2b57627460fdce39fab866
BLAKE2b-256 47db45b498286b89ad4022e4c04c3bb8bdfefa3ca48e2399fbb5d83e53a7d7f3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page