Merge pull request #355 from Dessia-tech/dev

v0.23.0

Author: Tanguylo

.gitignore

@@ -1,7 +1,3 @@
-node_modules/
-lib/
-libdev/
-
 # CAD files
 *.fcstd
 *.fcstd1
@@ -26,7 +22,9 @@ downloads/
 eggs/
 .eggs/
 lib/
+libdev/
 lib64/
+node_modules/
 parts/
 sdist/
 var/

CHANGELOG.md

@@ -5,11 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.23.0]
+
+### Feat
+- Add events (Subject) to emit shape hovering and clicking
+- Highlight shapes when corresponding function is called from wrapper software
+
+### Fix
+- Remove offline mode
+
+### Refactor
+- Implements InteractiveObject for handling all mouse objects in one class
+
 ## [0.22.0]
 ### Add
 - Integer axes only show integer ticks
 - Handle date as continuous value on axes
 - Allow to log scale axes
+- Offline mode
 
 ### Fix
 - Add reference_path to all Primitive / Elementary drawing Objects

cypress/e2e/axes.cy.ts

@@ -22,8 +22,8 @@ describe('Axis', function() {
 
     axis.draw(context);
 
-    cy.wrap(context.fill).should('have.been.calledWith', axis.drawPath);
-    cy.wrap(context.stroke).should('have.been.calledWith', axis.drawPath);
+    cy.wrap(context.fill).should('have.been.calledWith', axis.drawnPath);
+    cy.wrap(context.stroke).should('have.been.calledWith', axis.drawnPath);
   });
 
   it('should be well created without vector features', function() {

cypress/e2e/baseShape.cy.ts

@@ -153,7 +153,7 @@ describe('Shape', function() {
   it('should initialize Shape without any arguments', function() {
     const shape = new Shape();
     expect(shape.path instanceof Path2D, "path").to.be.true;
-    expect(shape.scaledPath instanceof Path2D, "scaledPath").to.be.true;
+    expect(shape.drawnPath instanceof Path2D, "drawnPath").to.be.true;
     expect(shape.inStrokeScale.y, "inStrokeScale").to.equal(1);
     expect(shape.lineWidth, "lineWidth").to.equal(1);
     expect(shape.dashLine.length, "dashLine").to.equal(0);
@@ -187,8 +187,8 @@ describe('Shape', function() {
 
     shape.draw(context);
 
-    cy.wrap(context.fill).should('have.been.calledWith', shape.scaledPath);
-    cy.wrap(context.stroke).should('have.been.calledWith', shape.scaledPath);
+    cy.wrap(context.fill).should('have.been.calledWith', shape.drawnPath);
+    cy.wrap(context.stroke).should('have.been.calledWith', shape.drawnPath);
   });
 
   // Shape can be hovered over

cypress/e2e/figures.cy.ts

@@ -122,15 +122,20 @@ describe("Figure", function() {
         ]);
         scatter.initRubberBandMultiplot(multiplotRubberBands);
 
-        expect(multiplotRubberBands, "empty multiplotRubberBands").to.deep.equal(referenceRubberBands);
+        scatter.axes.forEach(axis => {
+            expect(multiplotRubberBands.get(axis.name).minValue, `empty rubberband ${axis.name}.minValue`).to.deep.equal(referenceRubberBands.get(axis.name).minValue);
+            expect(multiplotRubberBands.get(axis.name).maxValue, `empty rubberband ${axis.name}.minValue`).to.deep.equal(referenceRubberBands.get(axis.name).maxValue);
+        });
 
         scatter.axes[0].rubberBand.minValue = 1;
         scatter.axes[0].rubberBand.maxValue = 4;
         scatter.axes[1].rubberBand.minValue = 2;
         scatter.axes[1].rubberBand.maxValue = 5;
         scatter.updateRubberBandMultiplot(multiplotRubberBands);
-
-        expect(multiplotRubberBands, "edited multiplotRubberBands").to.deep.equal(referenceRubberBands);
+        scatter.axes.forEach(axis => {
+            expect(multiplotRubberBands.get(axis.name).minValue, `edited rubberband ${axis.name}.minValue`).to.deep.equal(referenceRubberBands.get(axis.name).minValue);
+            expect(multiplotRubberBands.get(axis.name).maxValue, `edited rubberband ${axis.name}.minValue`).to.deep.equal(referenceRubberBands.get(axis.name).maxValue);
+        });
     });
 });
 
@@ -233,12 +238,12 @@ describe("Histogram", function() {
 
     it("should hover/click on bar", function () {
         const [canvasMouse, frameMouse, mouseCoords] = histogram.projectMouse({"offsetX": 350, "offsetY": 420} as MouseEvent);
-        histogram.mouseMove(canvasMouse, frameMouse, mouseCoords);
+        histogram.castMouseMove(canvasMouse, frameMouse, mouseCoords);
         expect(histogram.hoveredIndices[1], "hoveredIndices[1]").to.equal(7);
         expect(histogram.hoveredIndices.length, "hoveredIndices.length").to.equal(3);
 
-        histogram.mouseDown(canvasMouse, frameMouse, mouseCoords);
-        histogram.mouseUp(false)
+        histogram.castMouseDown(canvasMouse, frameMouse, mouseCoords);
+        histogram.castMouseUp(false)
         expect(histogram.clickedIndices[2], "clickedIndices[2]").to.equal(8);
         expect(histogram.clickedIndices[0], "clickedIndices[0]").to.equal(6);
     });

cypress/e2e/visualRegressions.cy.ts

@@ -66,9 +66,9 @@ FIGURES_DATA.forEach(figureData => {
                 cy.window().then((win) => {
                     const draw = win.eval('plot_data');
                     const [canvasMouse, frameMouse, mouseCoords] = draw.projectMouse({"offsetX": 746, "offsetY": 176} as MouseEvent);
-                    draw.mouseMove(canvasMouse, frameMouse, mouseCoords);
-                    draw.mouseDown(canvasMouse, frameMouse, mouseCoords);
-                    draw.mouseUp(false);
+                    draw.castMouseMove(canvasMouse, frameMouse, mouseCoords);
+                    draw.castMouseDown(canvasMouse, frameMouse, mouseCoords);
+                    draw.castMouseUp(false);
                     draw.draw();
                     cy.compareSnapshot(describeTitle + this.test.title, 0.05);
                 });
@@ -78,11 +78,11 @@ FIGURES_DATA.forEach(figureData => {
                 cy.window().then((win) => {
                     const draw = win.eval('plot_data');
                     let [canvasMouse, frameMouse, mouseCoords] = draw.projectMouse({"offsetX": 814, "offsetY": 196} as MouseEvent);
-                    draw.mouseMove(canvasMouse, frameMouse, mouseCoords);
+                    draw.castMouseMove(canvasMouse, frameMouse, mouseCoords);
                     expect(draw.relativeObjects.shapes[23].isHovered).to.be.true;
 
                     [canvasMouse, frameMouse, mouseCoords] = draw.projectMouse({"offsetX": 822, "offsetY": 196} as MouseEvent);
-                    draw.mouseMove(canvasMouse, frameMouse, mouseCoords);
+                    draw.castMouseMove(canvasMouse, frameMouse, mouseCoords);
                     expect(draw.relativeObjects.shapes[23].isHovered).to.be.true;
                 });
             });

package-lock.json

@@ -9,19 +9,15 @@
     "build": "npm run instrument && NODE_ENV=production webpack --config webpack.config.js",
     "dev": "npm run instrument && NODE_ENV=development webpack --config webpack-dev.config.cjs",
     "cov": "npm run instrument && NODE_ENV=coverage webpack --config webpack-dev.config.cjs",
-
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "tslint -p tsconfig.json",
     "start": "http-server -a localhost -p 3030",
-
     "merge_reports": "mochawesome-merge cypress/results/*.json > cypress/results/full_report.json",
     "generate_mochawesome_report": "marge cypress/results/full_report.json --reportDir cypress/results",
-
     "cy:run-base": "cypress run --env type=base --browser firefox",
     "cy:run-actual": "node ./cypress_run_report.cjs",
     "cy:run-open": "cypress open --env type=actual",
     "cy:open": "npm run cov & start-server-and-test start http-get://localhost:3030 cy:run-open",
-
     "test": "npm run cov && start-server-and-test start http-get://localhost:3030 cy:run-actual",
     "base-test": "npm run cov && start-server-and-test start http-get://localhost:3030 cy:run-base"
   },
@@ -78,6 +74,7 @@
     "fs": "^0.0.1-security",
     "html-webpack-plugin": "^5.5.0",
     "ignore-errors": "^2.0.0",
+    "rxjs": "^7.8.1",
     "ts-loader": "^9.2.6",
     "typedoc": "^0.23.28",
     "webpack": "^5.75.0"

package.json

@@ -127,21 +127,21 @@ def _export_formats(self) -> List[ExportFormat]:
         formats.append(ExportFormat(selector="html", extension="html", method_name="to_html_stream", text=False))
         return formats
 
-    def _to_html(self, debug_mode: bool = False, canvas_id: str = 'canvas', version: str = None):
-        lib_path = plot_data_path(debug_mode=debug_mode, version=version)
+    def _to_html(self, local: bool = False, canvas_id: str = 'canvas', version: str = None):
+        lib_path = plot_data_path(local=local, version=version)
         return self.template.substitute(data=json.dumps(self.to_dict()), core_path=lib_path, canvas_id=canvas_id,
                                         width=self.width, height=self.height)
 
-    def to_html_stream(self, stream, debug_mode: bool = False, canvas_id: str = 'canvas', version: str = None):
+    def to_html_stream(self, stream, local: bool = False, canvas_id: str = 'canvas', version: str = None):
         """ Export current Figure to its equivalent html stream file. """
-        html = self._to_html(debug_mode=debug_mode, canvas_id=canvas_id, version=version)
+        html = self._to_html(local=local, canvas_id=canvas_id, version=version)
         stream.write(html)
 
-    def to_html(self, filepath: str = None, debug_mode: bool = False, canvas_id: str = 'canvas', version: str = None):
+    def to_html(self, filepath: str = None, local: bool = False, canvas_id: str = 'canvas', version: str = None):
         """ Export current Figure to an HTML file given by the filepath. """
         filepath = make_filepath(filepath=filepath)
         with open(filepath, 'w', encoding="utf-8") as file:
-            self.to_html_stream(file, debug_mode=debug_mode, canvas_id=canvas_id, version=version)
+            self.to_html_stream(file, local=local, canvas_id=canvas_id, version=version)
         return filepath
 
     def plot_data(self, **kwargs):
@@ -165,7 +165,6 @@ class Sample(ReferencedObject):
 
     def __init__(self, values, reference_path: str = "#", name: str = ""):
         self.values = values
-        self.reference_path = reference_path
         super().__init__(type_="sample", reference_path=reference_path, name=name)
 
     def to_dict(self, use_pointers: bool = True, memo=None, path: str = '#', id_method=True,
@@ -1505,10 +1504,10 @@ def __init__(self, plots: List[PlotDataObject], sizes: List[Window] = None, elem
         super().__init__(width=width, height=height, type_='multiplot', name=name)
 
 
-def plot_data_path(debug_mode: bool = False, version: str = None):
+def plot_data_path(local: bool = False, version: str = None):
     """ Get path of plot_data package to write it in html file of Figure to draw. """
     version, folder, filename = get_current_link(version=version)
-    if debug_mode:
+    if local:
         core_path = os.sep.join(os.getcwd().split(os.sep)[:-1] + [folder, filename])
         if os.path.isfile(core_path):
             return core_path.replace(" ", "%20")
@@ -1526,17 +1525,17 @@ def make_filepath(filepath: str = None):
     return filepath
 
 
-def plot_canvas(plot_data_object: Figure, filepath: str = None, debug_mode: bool = False, canvas_id: str = 'canvas',
+def plot_canvas(plot_data_object: Figure, filepath: str = None, local: bool = False, canvas_id: str = 'canvas',
                 force_version: str = None, width: float = None, height: float = None):
     """
     Creates a html file and plots input data in web browser.
 
     :param plot_data_object: a PlotDataObject(ie Scatter, ParallelPlot,\
       MultiplePlots, Graph2D, PrimitiveGroup or PrimitiveGroupContainer)
     :type plot_data_object: PlotDataObject
-    :param debug_mode: uses local library if True, uses typescript \
+    :param local: uses local library if True, uses typescript \
     library from cdn if False
-    :type debug_mode: bool
+    :type local: bool
     :param canvas_id: set canvas' id, ie name
     :type canvas_id: str
     :param width: set the canvas' width:
@@ -1550,7 +1549,7 @@ def plot_canvas(plot_data_object: Figure, filepath: str = None, debug_mode: bool
         plot_data_object.width = width
     if height:
         plot_data_object.height = height
-    plot_data_object.plot(filepath=filepath, debug_mode=debug_mode, canvas_id=canvas_id, version=force_version)
+    plot_data_object.plot(filepath=filepath, local=local, canvas_id=canvas_id, version=force_version)
 
 
 def write_json_for_tests(plot_data_object: PlotDataObject, json_path: str):

plot_data/core.py

@@ -5,4 +5,4 @@
 # The graph's definition has been moved to test_objects.graph_test.py to
 # make MultiplePlots.py' imports more convenient
 plot_data_object = graph2d
-plot_data.plot_canvas(plot_data_object=graph2d, canvas_id='canvas', debug_mode=True)
+plot_data.plot_canvas(plot_data_object=graph2d, canvas_id='canvas', local=True)

script/graph2D.py

@@ -22,4 +22,4 @@
                                        surface_style=plot_data.SurfaceStyle("rgb(50, 50, 220)"),
                                        edge_style=plot_data.EdgeStyle(1, "rgb(0, 255, 0)", [5, 3]))
 
-plot_data.plot_canvas(plot_data_object=plot_data_object, debug_mode=True)
+plot_data.plot_canvas(plot_data_object=plot_data_object, local=True)

script/histogram.py

@@ -7,6 +7,7 @@
 """
 
 import random
+import plot_data
 
 random.seed(7)
 
@@ -37,4 +38,4 @@
 multipleplots = plot_data.MultiplePlots(elements=elements, plots=plots,
                                         initial_view_on=True)
 
-plot_data.plot_canvas(plot_data_object=multipleplots, debug_mode=True)
+plot_data.plot_canvas(plot_data_object=multipleplots, local=True)

script/minimal_dataviz.py

@@ -79,5 +79,5 @@
                                                            plot_data.PointFamily('rgb(146, 178, 78)', [11,21,31,41,25,26,27])])
 
 # Display
-plot_data_object.plot(debug_mode=True, canvas_id='canvas')
-# plot_data.plot_canvas(plot_data_object=multiplot, debug_mode=True)
+plot_data_object.plot(local=True, canvas_id='canvas')
+# plot_data.plot_canvas(plot_data_object=multiplot, local=True)

script/multiplot.py

@@ -18,4 +18,4 @@
                                                                                                                                 text_align_x='center',
                                                                                                                                 text_align_y='middle')))
 
-plot_data.plot_canvas(plotdata_nx_graph, debug_mode=True)
+plot_data.plot_canvas(plotdata_nx_graph, local=True)

script/networkx_graph.py

@@ -55,5 +55,5 @@
                                                  disposition=disposition,
                                                  rgbs=rgbs)
 
-# if debug_mode == True, set it to False
-plot_data.plot_canvas(plot_data_object=plot_data_object, debug_mode=True)
+# if local == True, set it to False
+plot_data.plot_canvas(plot_data_object=plot_data_object, local=True)

script/parallel_plot.py

@@ -73,5 +73,5 @@
                                      tooltip=tooltip,
                                      heatmap=heatmap)
 
-# if debug_mode is True, set it to False
-plot_data.plot_canvas(plot_data_object=plot_data_object, debug_mode=True)
+# if local is True, set it to False
+plot_data.plot_canvas(plot_data_object=plot_data_object, local=True)

script/plot_scatter.py

@@ -30,5 +30,5 @@
 
 plot_data_object = plot_data.PrimitiveGroupsContainer(primitive_groups=primitive_groups)
 
-# if debug_mode is True, set it to False
-plot_data.plot_canvas(plot_data_object=plot_data_object, debug_mode=True)
+# if local is True, set it to False
+plot_data.plot_canvas(plot_data_object=plot_data_object, local=True)

script/primitive_group_container.py

@@ -20,4 +20,4 @@
                      })
 
 plot_data_object = plot_data.ScatterMatrix(elements=elements)
-plot_data.plot_canvas(plot_data_object=plot_data_object, debug_mode=True)
+plot_data.plot_canvas(plot_data_object=plot_data_object, local=True)

script/scatter_matrix.py

@@ -16,4 +16,4 @@
 # plot_data_object.mpl_plot()
 
 plot_data_object.save_to_image('primitive_group.png')
-plot_data.plot_canvas(plot_data_object=plot_data_object, debug_mode=True)
+plot_data.plot_canvas(plot_data_object=plot_data_object, local=True)

script/simple_shapes.py

@@ -128,4 +128,4 @@
 # labels = plot_data.MultipleLabels(labels=[label_custo_1, label_custo_2])
 primitives += [label_custo_1, label_custo_2]
 primitive_group = plot_data.PrimitiveGroup(primitives=primitives)
-# plot_data.plot_canvas(primitive_group, debug_mode=True)
+# plot_data.plot_canvas(primitive_group, local=True)

script/test_objects/primitive_group_test.py

@@ -121,4 +121,4 @@ def plot_data(self, pos_y=0.):
 
 ff = primitives + texts
 plot_data_object = plot_data.PrimitiveGroup(primitives=ff)
-plot_data.plot_canvas(plot_data_object, debug_mode=True)
+plot_data.plot_canvas(plot_data_object, local=True)