jtablesaw / jtablesaw/plotly.java
API Changes requested
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
This covers a list of API changes suggested in the tablesaw repo. See original description below and original issue: https://github.com/jtablesaw/tablesaw/issues/716
I'm not sure what's left to do here that makes sense so a review is needed.
I would like to suggest some simple API changes to the jsplot-plotly classes which will slowly help in the direction proposed in issue https://github.com/jtablesaw/tablesaw/issues/693. If these suggestions sound acceptable, I can work on a PR.
Figure.java : Add methods .setTraces(Trace[]), .setLayout(Layout) & .setEventHandlers().
Figure.java : Change methods buildContext(), plotFunction(), eventHandlerFunction to "protected" instead of "private" so that they can be overridden.
For all Plot classes in tech.tablesaw.plotly.api.*, extend the classes to Figure.java.
Make the constructor of Heatmap (tech.tablesaw.plotly.api) public.
For all *Plot classes create constructors with parameters that match the static create() methods of each class, with an added Layout object. The constructors would do the same as the static methods except that it would setXXX() the layout, trace and eventhandlers instead of creating a new Figure.
If these changes are made, then the following will be true :
a) It will not break the current API.
b) It will allow users of Tablesaw to set a custom Layout object for each of the Plot classes.
c) It will allow users of Tablesaw to take advantage of inheritance and create classes which extend the Plot classes and override the underlying methods, so that they can make enhancements or changes to the current implementation.
d) It will allow users of Tablesaw to contribute their enhancements to the Tablesaw project, but still use their custom enhancements and the latest Tablesaw release while waiting for the acceptance of the enhancements and a new release with the changes.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing Figure.java and the Plot classes in tech.tablesaw.plotly.api, then read the linked original issues 716 and 693 to determine which API changes remain relevant. Done should preserve the current API while enabling custom Layout objects and extensible Plot classes, but the issue needs scope and design decisions before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- data-visualization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100