fix(toggle_axis): allow to directly hide axes on python command

Author: Tanguylo

CHANGELOG.md

@@ -5,12 +5,16 @@ 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]
+## [0.24.0]
+### Add
+- Allow to directly specify if axes are on or off in Python
 
+## [0.23.0]
 ### Feat
 - Add events (Subject) to emit shape hovering and clicking
 - Highlight shapes when corresponding function is called from wrapper software
 
+## [0.22.4]
 ### Fix
 - Remove offline mode
 

plot_data/core.py

@@ -110,9 +110,10 @@ class Figure(PlotDataObject):
 
     _standalone_in_db = True
 
-    def __init__(self, type_: str, width: int = 750, height: int = 400, name: str = '', **kwargs):
+    def __init__(self, type_: str, width: int = 750, height: int = 400, axis_on: bool = True, name: str = '', **kwargs):
         self.width = width
         self.height = height
+        self.axis_on = axis_on
         PlotDataObject.__init__(self, type_=type_, name=name, **kwargs)
 
     @property
@@ -879,7 +880,7 @@ class Graph2D(Figure):
 
     def __init__(self, graphs: List[Dataset], x_variable: str, y_variable: str, axis: Axis = None,
                  log_scale_x: bool = None, log_scale_y: bool = None, width: int = 750, height: int = 400,
-                 name: str = ''):
+                 axis_on: bool = True, name: str = ''):
         self.graphs = graphs
         self.attribute_names = [x_variable, y_variable]
         if axis is None:
@@ -888,7 +889,7 @@ def __init__(self, graphs: List[Dataset], x_variable: str, y_variable: str, axis
             self.axis = axis
         self.log_scale_x = log_scale_x
         self.log_scale_y = log_scale_y
-        super().__init__(width=width, height=height, type_='graph2d', name=name)
+        super().__init__(width=width, height=height, type_='graph2d', axis_on=axis_on, name=name)
 
     def mpl_plot(self, ax=None, **kwargs):
         """ Plots using matplotlib. """
@@ -1055,7 +1056,7 @@ class Scatter(Figure):
     def __init__(self, x_variable: str = None, y_variable: str = None, tooltip: Tooltip = None,
                  point_style: PointStyle = None, elements: List[Sample] = None, points_sets: List[PointFamily] = None,
                  axis: Axis = None, log_scale_x: bool = None, log_scale_y: bool = None, heatmap: Heatmap = None,
-                 heatmap_view: bool = None, width: int = 750, height: int = 400, name: str = ''):
+                 heatmap_view: bool = None, width: int = 750, height: int = 400, axis_on: bool = True, name: str = ''):
         self.tooltip = tooltip
         self.attribute_names = [x_variable, y_variable]
         self.point_style = point_style
@@ -1082,7 +1083,7 @@ def __init__(self, x_variable: str = None, y_variable: str = None, tooltip: Tool
         self.heatmap = heatmap
         self.heatmap_view = heatmap_view
         self.points_sets = points_sets
-        super().__init__(width=width, height=height, type_='scatterplot', name=name)
+        super().__init__(width=width, height=height, type_='scatterplot', axis_on=axis_on, name=name)
 
 
 class ScatterMatrix(Figure):
@@ -1092,7 +1093,8 @@ class ScatterMatrix(Figure):
     _plot_buttons = "MULTIPLOT_BUTTONS"
 
     def __init__(self, elements: List[Sample] = None, axes: List[str] = None, point_style: PointStyle = None,
-                 surface_style: SurfaceStyle = None, width: int = 750, height: int = 400, name: str = ""):
+                 surface_style: SurfaceStyle = None, width: int = 750, height: int = 400, axis_on: bool = True,
+                 name: str = ""):
         if elements is None:
             elements = []
         sampled_elements = []
@@ -1112,7 +1114,7 @@ def __init__(self, elements: List[Sample] = None, axes: List[str] = None, point_
         self.surface_style = surface_style
         self.plots = self._build_multiplot()
         self.initial_view_on = True
-        super().__init__(width=width, height=height, type_="multiplot", name=name)
+        super().__init__(width=width, height=height, type_="multiplot", axis_on=axis_on, name=name)
 
     def _build_multiplot(self):
         sample_attributes = self.elements[0].values.keys()
@@ -1299,10 +1301,10 @@ class PrimitiveGroup(Figure):
 
     def __init__(self, primitives: List[Union[Contour2D, Arc2D, LineSegment2D, Circle2D,
                                               Line2D, MultipleLabels, Wire, Point2D]], width: int = 750,
-                 height: int = 400, attribute_names: List[str] = None, name: str = ''):
+                 height: int = 400, attribute_names: List[str] = None, axis_on: bool = False, name: str = ''):
         self.primitives = primitives
         self.attribute_names = attribute_names
-        super().__init__(width=width, height=height, type_='draw', name=name)
+        super().__init__(width=width, height=height, type_='draw', axis_on=axis_on, name=name)
 
     def mpl_plot(self, ax=None, equal_aspect=True, **kwargs):
         """ Plots using matplotlib. """
@@ -1360,7 +1362,8 @@ class PrimitiveGroupsContainer(Figure):
 
     def __init__(self, primitive_groups: List[PrimitiveGroup], sizes: List[Tuple[float, float]] = None,
                  coords: List[Tuple[float, float]] = None, associated_elements: List[int] = None,
-                 x_variable: str = None, y_variable: str = None, width: int = 750, height: int = 400, name: str = ''):
+                 x_variable: str = None, y_variable: str = None, width: int = 750, height: int = 400,
+                 axis_on: bool = True, name: str = ''):
         for i, value in enumerate(primitive_groups):
             if not isinstance(value, PrimitiveGroup):
                 primitive_groups[i] = PrimitiveGroup(primitives=value)
@@ -1378,7 +1381,7 @@ def __init__(self, primitive_groups: List[PrimitiveGroup], sizes: List[Tuple[flo
                 if y_variable:
                     attribute_names.append(y_variable)
                 self.association['attribute_names'] = attribute_names
-        super().__init__(width=width, height=height, type_='primitivegroupcontainer', name=name)
+        super().__init__(width=width, height=height, type_='primitivegroupcontainer', axis_on=axis_on, name=name)
 
 
 class ParallelPlot(Figure):
@@ -1399,7 +1402,7 @@ class ParallelPlot(Figure):
 
     def __init__(self, elements: List[Sample] = None, edge_style: EdgeStyle = None, disposition: str = None,
                  axes: List[str] = None, rgbs: List[Tuple[int, int, int]] = None, width: int = 750, height: int = 400,
-                 name: str = ''):
+                 axis_on: bool = True, name: str = ''):
         if elements is None:
             elements = []
         sampled_elements = []
@@ -1418,7 +1421,7 @@ def __init__(self, elements: List[Sample] = None, edge_style: EdgeStyle = None,
         self.disposition = disposition
         self.attribute_names = axes
         self.rgbs = rgbs
-        super().__init__(width=width, height=height, type_='parallelplot', name=name)
+        super().__init__(width=width, height=height, type_='parallelplot', axis_on=axis_on, name=name)
 
 
 class Histogram(Figure):
@@ -1446,7 +1449,7 @@ class Histogram(Figure):
 
     def __init__(self, x_variable: str, elements=None, axis: Axis = None, graduation_nb: float = None,
                  edge_style: EdgeStyle = None, surface_style: SurfaceStyle = None, width: int = 750, height: int = 400,
-                 name: str = ''):
+                 axis_on: bool = True, name: str = ''):
         if elements is None:
             elements = []
         sampled_elements = []
@@ -1466,7 +1469,7 @@ def __init__(self, x_variable: str, elements=None, axis: Axis = None, graduation
         self.graduation_nb = graduation_nb
         self.edge_style = edge_style
         self.surface_style = surface_style
-        super().__init__(width=width, height=height, type_='histogram', name=name)
+        super().__init__(width=width, height=height, type_='histogram', axis_on=axis_on, name=name)
 
 
 class MultiplePlots(Figure):
@@ -1486,7 +1489,8 @@ class MultiplePlots(Figure):
 
     def __init__(self, plots: List[PlotDataObject], sizes: List[Window] = None, elements: List[Sample] = None,
                  coords: List[Tuple[float, float]] = None, point_families: List[PointFamily] = None,
-                 initial_view_on: bool = None, width: int = 750, height: int = 400, name: str = ''):
+                 initial_view_on: bool = None, width: int = 750, height: int = 400, axis_on: bool = True,
+                 name: str = ''):
         if elements is None:
             elements = []
         sampled_elements = []
@@ -1506,7 +1510,7 @@ def __init__(self, plots: List[PlotDataObject], sizes: List[Window] = None, elem
         self.coords = coords
         self.points_sets = point_families
         self.initial_view_on = initial_view_on
-        super().__init__(width=width, height=height, type_='multiplot', name=name)
+        super().__init__(width=width, height=height, type_='multiplot', axis_on=axis_on, name=name)
 
 
 def plot_data_path(local: bool = False, version: str = None):

src/constants.ts

@@ -65,7 +65,8 @@ export const PG_CONTAINER_PLOT = {
         "type_": "text"
       }
     ],
-    "type_": "primitivegroup"
+    "type_": "primitivegroup",
+    "axis_on": false
 };
 
 export const EMPTY_MULTIPLOT = {

src/dataInterfaces.ts

@@ -74,7 +74,8 @@ export interface DataInterface {
     primitives?: any, //for now, needs a specific interface
     tooltip?: any, //for now: tooltip can be Tooltip Object or string,
     graduation_nb?: number,
-    type_?: string
+    type_?: string,
+    axis_on?: boolean
 }
 
 export interface MultiplotDataInterface {

src/remoteFigure.ts

@@ -79,6 +79,7 @@ export class RemoteFigure extends Rect {
       this.fixedObjects = new ShapeCollection(this.axes);
       this.relativeObjects = new GroupCollection();
       this.absoluteObjects = new GroupCollection();
+      this.setAxisVisibility(data);
     }
 
   get scale(): Vertex { return new Vertex(this.relativeMatrix.a, this.relativeMatrix.d)}
@@ -117,6 +118,8 @@ export class RemoteFigure extends Rect {
 
   protected unpackData(data: any): Map<string, any[]> { return RemoteFigure.deserializeData(data) }
 
+  protected setAxisVisibility(data: DataInterface): void { if (!data.axis_on) this.toggleAxesVisibility() }
+
   public serializeFeatures(): any {
     const elements = [];
     for (let i=0; i < this.nSamples; i++) {
@@ -428,8 +431,10 @@ export class RemoteFigure extends Rect {
 
   public togglePoints(): void {}
 
+  private toggleAxesVisibility(): void { this.axes.forEach(axis => axis.toggleView()) }
+
   public toggleAxes(): void {
-    this.axes.forEach(axis => axis.toggleView());
+    this.toggleAxesVisibility();
     this.draw();
   }