GitHub

PlotlyJS

Welcome to the documentation for PlotlyJS.jl, a Julia interface to the plotly.js visualization library.

The goals of PlotlyJS.jl are to:

  1. make it convenient to construct and manipulate plotly visualizations;
  2. provide the infrastructure for viewing and interacting with plots from different front-ends such as the Julia REPL, web browsers and IDEs;
  3. save plotly graphics to files in different formats.

Getting Help

The Plotly Julia Library documentation has a quick reference guide and an gallery of additional examples.

A single-page attribute reference is also available.

There are three primary resources for asking for help with using this library:

  1. The Julia Discourse page. This is your best option if the question you have is specific to Julia. Appropriate topics include how to integrate with other Julia packages or how to use plotly features unique to PlotlyJS.jl (tag as plotlyjs)
  2. The julia channel on the plotly discussion page. This is your best option if you want visibility from other parts of the plotly community including python and R users.
  3. GitHub Issues. This is appropriate only for bug reports or feature requests. General usage questions should not be posted to GitHub, but rather should utilize one of the discussion forums above.

Installation

To install PlotlyJS.jl, open up a Julia REPL, press ] to enter package mode and type:

pkg> add PlotlyJS

For existing users you can run up from the package manager REPL mode to update to the latest release. If after doing this plots do not show up in your chosen front-end, please run build PlotlyJS (again from pkg> REPL mode) to tell Julia to download the latest updates to the plotly.js JavaScript library.

Saving figures

PlotlyJS.jl comes with built-in support for saving figures to files via the integration between PlotlyBase.jl (a dependency of PlotlyJS.jl) and Plotly's kaleido tool (via the PlotlyKaleido.jl package).

See exporting figures for more information.

Relation to Plotly.com

This package does not interact with plotly.com or any web API, but rather leverages the underlying JavaScript library to construct plotly graphics using all local resources. This means you do not need a Plotly account or an internet connection to use this package after installation.

Plots.jl

If you would like to have a more comprehensive set of top-level functions for constructing plots, see the Plots.jl package. This package is the plotlyjs backend of Plots.jl and is fully supported by JuliaPlots.