Merge pull request bqplot#190 from ssunkara1/bug_fixes

Tooltip positioning bug fix. Pyplot hline and vline.

Author: dmadeka

bqplot/figure.py

@@ -122,10 +122,10 @@ class Figure(DOMWidget):
     animation_duration = Int().tag(sync=True, display_name='Animation duration')
 
     def _scale_x_default(self):
-        return LinearScale(min=0, max=1)
+        return LinearScale(min=0, max=1, allow_padding=False)
 
     def _scale_y_default(self):
-        return LinearScale(min=0, max=1)
+        return LinearScale(min=0, max=1, allow_padding=False)
 
     def save_png(self):
         self.send({"type": "save_png"})

bqplot/pyplot.py

@@ -346,6 +346,71 @@ def axes(mark=None, options={}, **kwargs):
     return axes
 
 
+def grids(fig=None, value='solid'):
+    """Sets the value of the grid_lines for the axis to the passed value.
+    The default value is `solid`.
+
+    Parameters
+    ----------
+    fig: Figure or None(default: None)
+        The figure for which the axes should be edited. If the value is None,
+        the current figure is used.
+    value: {'none', 'solid', 'dashed'}
+        The display of the grid_lines
+    """
+
+    if fig is None:
+        fig = current_figure()
+    for a in fig.axes:
+        a.grid_lines = value
+
+
+def hline(level, fig=None, preserve_domain=False, **kwargs):
+    """Draws a horizontal line at the given level.
+    
+    Parameters
+    ----------
+    level: float
+        The level at which to draw the horizontal line.
+    fig: Figure or None
+        The figure to which the horizontal line is to be added.
+        If the value is None, the current figure is used.
+    preserve_domain: boolean (default: False)
+        If true, the line does not affect the domain of the 'y' scale.
+    """
+    default_colors = kwargs.pop('colors', ['dodgerblue'])
+    default_width = kwargs.pop('stroke_width', 1)
+    if fig is None:
+        fig = current_figure()
+    sc_x = fig.scale_x
+    plot([0., 1.], [level, level], scales={'x': sc_x}, preserve_domain={'x': True,
+         'y': preserve_domain}, axes=False, colors=default_colors,
+         stroke_width=default_width, update_context=False)
+
+
+def vline(level, fig=None, preserve_domain=False, **kwargs):
+    """Draws a vertical line at the given level.
+
+    Parameters
+    ----------
+    level: float
+        The level at which to draw the vertical line.
+    fig: Figure or None
+        The figure to which the vertical line is to be added.
+        If the value is None, the current figure is used.
+    preserve_domain: boolean (default: False)
+        If true, the line does not affect the domain of the 'x' scale.
+    """
+    default_colors = kwargs.pop('colors', ['dodgerblue'])
+    default_width = kwargs.pop('stroke_width', 1)
+    if fig is None:
+        fig = current_figure()
+    sc_y = fig.scale_y
+    plot([level, level], [0., 1.], scales={'y': sc_y}, preserve_domain={'x': preserve_domain,
+         'y': True}, axes=False, colors=default_colors,
+         stroke_width=default_width, update_context=False)
+
+
 def _draw_mark(mark_type, options={}, axes_options={}, **kwargs):
     """Draw the mark of specified mark type.
 
@@ -364,6 +429,7 @@ def _draw_mark(mark_type, options={}, axes_options={}, **kwargs):
     """
     fig = kwargs.pop('figure', current_figure())
     scales = kwargs.pop('scales', {})
+    update_context = kwargs.pop('update_context', True)
 
     # Going through the list of data attributes
     for name in mark_type.class_trait_names(scaled=True):
@@ -375,7 +441,8 @@ def _draw_mark(mark_type, options={}, axes_options={}, **kwargs):
             # create a scale for this.
             continue
         elif name in scales:
-            _context['scales'][dimension] = scales[name]
+            if update_context:
+                _context['scales'][dimension] = scales[name]
         # Scale has to be fetched from the conext or created as it has not
         # been passed.
         elif dimension not in _context['scales']:
@@ -394,7 +461,8 @@ def _draw_mark(mark_type, options={}, axes_options={}, **kwargs):
             # scale type.
             scales[name] = compat_scale_types[0](**options.get(name, {}))
             # Adding the scale to the conext scales
-            _context['scales'][dimension] = scales[name]
+            if update_context:
+                _context['scales'][dimension] = scales[name]
         else:
             scales[name] = _context['scales'][dimension]
 
@@ -850,8 +918,15 @@ def current_figure():
 
 
 def get_context():
-    """Used for debug only. Return the current global context dictionary."""
-    return _context
+    """Used for debug only. Return a copy of the current global context dictionary."""
+    return {k: v for k, v in _context.items()}
+
+
+def set_context(context):
+    """Sets the current global context dictionary. All the attributes to be set
+    should be set. Otherwise, it will result in unpredictable behavior."""
+    global _context
+    _context = {k: v for k, v in context.items()}
 
 
 def _fetch_axis(fig, dimension, scale):

examples/Basic Plotting/Pyplot.ipynb

@@ -90,6 +90,39 @@
     "plt.show()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Horizontal and Vertical Lines"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": false
+   },
+   "outputs": [],
+   "source": [
+    "## adding a horizontal line at y=0\n",
+    "plt.hline(0)\n",
+    "plt.show()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": [
+    "## adding a vertical line at x=4 with stroke_width and colors being passed.\n",
+    "plt.vline(4., stroke_width=2, colors=['orangered'])\n",
+    "plt.show()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -255,6 +288,25 @@
     "plt.show()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Adding grid lines"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "collapsed": true
+   },
+   "outputs": [],
+   "source": [
+    "plt.grids()\n",
+    "plt.show()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -346,7 +398,7 @@
     "\n",
     "## preserving the x scale and changing the y scale\n",
     "plt.scales(scales={'x': plt.Keep})\n",
-    "plt.plot(x, y_data_2, colors=['lightgreen'], axes_options={'y': {'side': 'right', 'color': 'lightgreen'}})\n",
+    "plt.plot(x, y_data_2, colors=['orange'], axes_options={'y': {'side': 'right', 'color': 'orange'}})\n",
     "plt.show()"
    ]
   },
@@ -623,6 +675,10 @@
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython2",
    "version": "2.7.11"
+  },
+  "widgets": {
+   "state": {},
+   "version": "1.0.0"
   }
  },
  "nbformat": 4,

js/src/Mark.js

@@ -247,7 +247,8 @@ define(["jupyter-js-widgets", "d3", "underscore"],
                 var ref_el = d3.select(document.body).select("#notebook").node();
                 var ref_mouse_pos = d3.mouse(ref_el);
 
-                var mouse_pos = d3.mouse(this.parent.el);
+                var parent_node = this.parent.el.parentElement;
+                var mouse_pos = d3.mouse(parent_node);
                 if(mouse_events === undefined || mouse_events === null ||
                    (!(mouse_events))) {
                         this.tooltip_div.style("pointer-events", "none");
@@ -263,14 +264,14 @@ define(["jupyter-js-widgets", "d3", "underscore"],
                     //node
                     var parent_rect = this.parent.el.getBoundingClientRect();
                     var tooltip_div_rect = this.tooltip_div.node().getBoundingClientRect();
-                    this.tooltip_div.style("left", (this.parent.el.offsetLeft + 5 + parent_rect.width * 0.5 -
-                                                    tooltip_div_rect.width * 0.5) + "px")
-                        .style("top", (this.parent.el.offsetTop + 5 + parent_rect.height * 0.5 -
-                                                    tooltip_div_rect.height * 0.5) + "px");
+                    this.tooltip_div.style("left", (parent_node.offsetLeft + 5 + parent_rect.width * 0.5 -
+                                                    tooltip_div_rect.width * 0.5 - ref_el.scrollLeft) + "px")
+                        .style("top", (parent_node.offsetTop + 5 + parent_rect.height * 0.5 -
+                                                    tooltip_div_rect.height * 0.5 - ref_el.scrollTop) + "px");
                 }
                 else {
-                    this.tooltip_div.style("left", (mouse_pos[0] + this.parent.el.offsetLeft + 5) + "px")
-                        .style("top", (mouse_pos[1] + this.parent.el.offsetTop + 5) + "px");
+                    this.tooltip_div.style("left", (mouse_pos[0] + parent_node.offsetLeft - ref_el.scrollLeft + 5) + "px")
+                        .style("top", (mouse_pos[1] + parent_node.offsetTop - ref_el.scrollTop + 5) + "px");
                 }
             }
         },

js/src/MarketMap.js

@@ -599,16 +599,17 @@ define(["jupyter-js-widgets", "d3", "./Figure", "underscore"],
             var ref_el = d3.select(document.body).select("#notebook").node();
             var ref_mouse_pos = d3.mouse(ref_el);
 
-            var mouse_pos = d3.mouse(this.el);
+            var parent_node = this.el.parentElement;
+            var mouse_pos = d3.mouse(parent_node);
             var that = this;
             var tooltip_div = this.tooltip_div;
             tooltip_div.transition()
                 .style("opacity", 0.9)
                 .style("display", null);
 
             // the +5s are for breathing room for the tool tip
-            tooltip_div.style("left", (mouse_pos[0] + this.el.offsetLeft + 5) + "px")
-                .style("top", (mouse_pos[1] + this.el.offsetTop + 5) + "px");
+            tooltip_div.style("left", (mouse_pos[0] + parent_node.offsetLeft - ref_el.scrollLeft + 5) + "px")
+                .style("top", (mouse_pos[1] + parent_node.offsetTop - ref_el.scrollTop + 5) + "px");
 
             tooltip_div.select("table").remove();
             if(! this.tooltip_view) {