jtablesaw / jtablesaw/plotly.java

API Changes requested

Abierto
#10 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Java
Estrellas
28
Forks
3
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza revisando Figure.java y las clases Plot de tech.tablesaw.plotly.api; después, lee los issues originales enlazados 716 y 693 para determinar qué cambios de API siguen siendo relevantes. El trabajo terminado debería conservar la API actual y permitir a la vez objetos Layout personalizados y clases Plot extensibles, pero el issue necesita definir el alcance y tomar decisiones de diseño antes de la implementación.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
java
Área
data-visualization
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.