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.

More details can be found in the documentation.

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{
x Australia NewZealand
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
}\dataA

\begin{tikzpicture}

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

\begin{axis}[
xlabel=year,
ylabel=lifeExp
]
\addplot+ [mark=*, solid, color=636efa] table[y=Australia] {\dataA};
\addlegendentry{Australia}
\addplot+ [mark=*, solid, color=EF553B] table[y=NewZealand] {\dataA};
\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.2.tar.gz (59.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tikzplotly-0.2.2-py3-none-any.whl (61.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tikzplotly-0.2.2.tar.gz
  • Upload date:
  • Size: 59.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for tikzplotly-0.2.2.tar.gz
Algorithm Hash digest
SHA256 8f3e50702f2ba8e36d44a1b9c4af7fa7700903fc9374cd6e7e00f30854cee26c
MD5 18fb64af89e9f923e8c8b6a701e50858
BLAKE2b-256 d7a0a8c02fec690564f8fba4cb28d3e2c5446d85e7767772e53f2bea2a9592d9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tikzplotly-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 61.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for tikzplotly-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 18009aa541ee7defeaca9b5809abb278fe374119d84783ea94fc21b8008b1562
MD5 588adb5705983f14f55d56a20d14796e
BLAKE2b-256 d0020215a737cba554e87d796c149e1cb23b365e98cc7cde3e5b259be6825643

See more details on using hashes here.

Supported by

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