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.

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

JavaScript: Investigate whether CliDE or Plotly.js wind roses can be provided as a web component #7

Open
4 tasks
isedwards opened this issue Jul 26, 2020 · 0 comments
Assignees

Comments

@isedwards
Copy link
Collaborator

isedwards commented Jul 26, 2020

Previous issues #4, #5 and #6 looked at creating windroses using processes running on the server. Thoses processes were each callable through Python with suitable docstrings and tests.

In a recent email, @WilliamJWright commented:

Among other things,CliDE does have very good functionality for Wind Roses. There was an issue with a proprietary module used in generating these, but if I remember correctly, this issue was being addressed

This issue investigates whether the client-side wind roses from either CliDE or plotly.js can be provided as a distinct, testable, module in a similar way to the R and Pascal methods.

Specifically the aim is to investigate whether:

  • A Javascript wind rose capability can be 'wrapped up' in a web component
  • Create a TypeScript function/method for the client-side wind rose and add this to a new opencdms-components repository
  • Create documentation for how the wind rose web component can be called (including parameter names, data types and a description of each parameter) as a TypeScript TSDoc docstring
  • Report on options for testing web components

Note: We're interested in web components as a possible way to remain "framework neutral" (for a client-side user interface) 
and also a micro-frontend architecture may assist us.

plotly-js-windrose

See also climsoft/climsoft-components#1 for the corresponding JavaScript development in opencdms-components

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants