Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refer to original announcement #75

Merged
merged 1 commit into from
Jun 13, 2020
Merged

Refer to original announcement #75

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<img src="screenshot.png" alt="ElectronDisplay.jl screenshot" width="50%" align="right" />

This package provides a display for figures and plots. When you load the package, it will push a new display onto the julia display stack and from then on it will display any value that can be rendered as png, svg, vega, vega-lite or plotly in an electron based window. This is especially handy when one works on the REPL and wants plots to show up in a nice window.
This package provides a display for figures, plots and tables. When you load the package, it will push a new display onto the julia display stack and from then on it will display any value that can be rendered as png, svg, vega, vega-lite or plotly in an electron based window. This is especially handy when one works on the REPL and wants plots or tables to show up in a nice window.

<br clear="all"/>

Expand All @@ -25,6 +25,8 @@ As soon as you load the package with ``using ElectronDisplay``, it will start to

`ElectronDisplay` also exports a function `electrondisplay`. You can use `electrondisplay(x)` to show `x` explicitly in `ElectronDisplay` (e.g., when another display has higher precedence). You can also use `electrondisplay(mime, x)` to specify a MIME to be used. For example, to read the docstring of `reduce` in `ElectronDisplay`, you can use `electrondisplay(@doc reduce)`.

See the original [announcement](https://www.queryverse.org/2019/02/13/electrondisplay/) for a quick start guide.

## Configuration

You can use the following configuration option to reuse existing window for displaying a new content. The default behavior is to create a new window for each display.
Expand Down