jtablesaw / jtablesaw/plotly.java

API Changes requested

オープン
#10 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Java
スター
28
フォーク
3
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず Figure.java と tech.tablesaw.plotly.api の Plot クラスを確認し、次にリンクされている元の issue 716 と 693 を読んで、どの API 変更が引き続き関連するかを判断してください。完了した作業では、現在の API を維持しながら、カスタム Layout オブジェクトと拡張可能な Plot クラスを使用できるようにする必要がありますが、実装前に issue のスコープと設計上の決定を定める必要があります。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
data-visualization
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。