Add ImageExport renderer based on running node.js

Open
#422 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
fsharp, javascript, node.js

Research direction

Start by reading src/Plotly.NET.ImageExport/PuppeteerSharpRenderer.fs and compare its rendering flow with the linked jsdom approach and edge's Node.js execution model. Define the Node.js-based renderer's integration and verify that Plotly.NET JSON objects can be rendered and saved as images without a headless browser.

Written by the indexing model from the issue text.

Description

Area: ImageExport Difficulty: Advanced FsLab Hackathon 2023
Description

As plotly.js, the underlying library that Plotly.NET is using needs an environment that can execute javascript to render images programmatically.

https://github.com/tjanczuk/edge seems to be able to run javascript code in node.js from .NET, meaning it should be possible to use plotly.js to render our json objects and save them to a file via node. This would be a big addition, because it would not need a headless browser to achieve this, just a node installation.

Pointers
Dominant language
F#
Stars
860
Forks
99
Avg merge
22m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from plotly/Plotly.NET

All issues in plotly/Plotly.NET

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.