62 Stars
Updated Last
1 Year Ago
Started In
March 2020

Build status Codecov


PlotlyLight is an ultra-lightweight (~150 lines) interface for working with Plotly.js.

πŸ†’ Features

  • πŸš€ Fastest time-to-first-plot in Julia!
  • 🌐 Use the Plotly.js Javascript documentation directly. No magic syntax: Just JSON3.write.
    • Set deeply-nested keys easily with EasyConfig.jl.
      • e.g. myplot.layout.xaxis.title.font.family = "Arial"
  • πŸ•ΈοΈ Plays nicely with Cobweb.jl to display or save plots as HTML.
  • 🎈 Plots will appear in MIME"text/html" environments (like Pluto.jl).
  • πŸ“Š The Same built-in themes as Plotly's python package.

πŸš€ Quickstart

using PlotlyLight

# Change template

# Make plot
p = Plot(x = 1:20, y = cumsum(randn(20)), type="scatter", mode="lines+markers")

# Make changes
p.layout.title.text = "My Title!"

# `display(p)` to see the updated plot

Adding Traces

  • PlotlyLight.Plot objects are callable. Repeatedly make calls to add traces.
    x = 1:10, y = randn(10), name = "trace 1"
    x = 3:12, y = randn(10), name = "trace 2"

πŸ“„ Saving Plots

Save HTML files with Cobweb.jl

using Cobweb: Page

page = Page(p)

save(page, "myplot.html")

Save images with PlotlyKaleido.jl

using PlotlyKaleido

PlotlyKaleido.savefig(p, "myplot.png")

πŸ“– Docs


Plot(data, layout, config; id, js)
  • A Plotly.js plot with components data, layout, and config.
    • data = Config(): A Config (single trace) or Vector{Config} (multiple traces).
    • layout = Config().
    • config = Config(displaylogo=false, responsive=true).
  • Each of the three components are converted to JSON via JSON3.write.
  • See the Plotly Javascript docs here: https://plotly.com/javascript/.
  • Keyword Args:
    • id: The id of the <div> the plot will be created in. Default: randstring(10).
    • js: Cobweb.Javascript to add after the creation of the plot. Default:
      • Cobweb.Javascript("console.log('plot created!')")


src!(x::Symbol) # `x` must be one of: [:cdn, :local, :standalone, :none]
  • :cdn β†’ Use PlotlyJS CDN.
  • :local β†’ Use local artifact.
  • :standalone β†’ Write JS into the HTML file directly (can be shared and viewed offline).
  • :none β†’ For when inserting into a page with Plotly.js already included.

βš™οΈ Defaults

You can set default values for the layout, config, and a number of other options that affect how the plot displays in your browser. HTML defaults (class/style/parent_class/parent_style) are chosen to make the plot reactive to the browser window size.

module Defaults
# Plot defaults
config          = Ref(Config(displaylogo=false, responsive=true))
layout          = Ref(Config())

# HTML defaults
src             = Ref(:cdn)  # How plotly gets loaded.  see ?PlotlyLight.src!
class           = Ref("")  # class of the <div> the plot is inside of.
style           = Ref("height: 100%;")  # style of the <div> the plot is inside of.
parent_class    = Ref("")  # class of the plot's parent <div>.
parent_style    = Ref("height: 100vh;")  # style of the plot's parent <div>.
  • As a reference, the underlying HTML of the plot looks like this:
<div class="$parent_class" style="$parent_style">
    <div class="$class" style="$style" id="plot_goes_here"></div>
  • Default values are Refs and can be changed e.g.
PlotlyLight.Defaults.layout[].title.text = "Default Title"
  • Revert back to the original defaults with Defaults.reset!()

πŸ“Š Themes/Templates

The themes available in Plotly's python package are also made available in PlotlyLight.jl. They can be set via:

layout = Config(template = PlotlyLight.template("plotly_dark"))

PlotlyLight.template!("plotly_dark")  # or replace the default `layout.template`

See PlotlyLight.templates for a list of theme/template options:


πŸ˜΅β€πŸ’« Gotchas

  • JSON does not have multidimensional arrays (https://www.w3schools.com/js/js_json_datatypes.asp). Therefore, traces that require matrix inputs (such as heatmap) must use a Vector of Vectors. We include a small utility function for running this conversion: PlotlyLight.collectrows(x::Matrix).

Used By Packages