diff --git a/Examples.ipynb b/Examples.ipynb index 8e43afd..02a3b32 100644 --- a/Examples.ipynb +++ b/Examples.ipynb @@ -23,7 +23,7 @@ }, { "cell_type": "code", - "execution_count": 1, + "execution_count": 2, "metadata": { "collapsed": false }, @@ -36,7 +36,7 @@ }, { "cell_type": "code", - "execution_count": 2, + "execution_count": 1, "metadata": { "collapsed": false }, @@ -1647,6 +1647,798 @@ " figure.plot(x, y)" ] }, + { + "cell_type": "code", + "execution_count": 8, + "metadata": { + "collapsed": false + }, + "outputs": [ + { + "data": { + "application/javascript": [ + "/* Put everything inside the global mpl namespace */\n", + "window.mpl = {};\n", + "\n", + "mpl.get_websocket_type = function() {\n", + " if (typeof(WebSocket) !== 'undefined') {\n", + " return WebSocket;\n", + " } else if (typeof(MozWebSocket) !== 'undefined') {\n", + " return MozWebSocket;\n", + " } else {\n", + " alert('Your browser does not have WebSocket support.' +\n", + " 'Please try Chrome, Safari or Firefox ≥ 6. ' +\n", + " 'Firefox 4 and 5 are also supported but you ' +\n", + " 'have to enable WebSockets in about:config.');\n", + " };\n", + "}\n", + "\n", + "mpl.figure = function(figure_id, websocket, ondownload, parent_element) {\n", + " this.id = figure_id;\n", + "\n", + " this.ws = websocket;\n", + "\n", + " this.supports_binary = (this.ws.binaryType != undefined);\n", + "\n", + " if (!this.supports_binary) {\n", + " var warnings = document.getElementById(\"mpl-warnings\");\n", + " if (warnings) {\n", + " warnings.style.display = 'block';\n", + " warnings.textContent = (\n", + " \"This browser does not support binary websocket messages. \" +\n", + " \"Performance may be slow.\");\n", + " }\n", + " }\n", + "\n", + " this.imageObj = new Image();\n", + "\n", + " this.context = undefined;\n", + " this.message = undefined;\n", + " this.canvas = undefined;\n", + " this.rubberband_canvas = undefined;\n", + " this.rubberband_context = undefined;\n", + " this.format_dropdown = undefined;\n", + "\n", + " this.image_mode = 'full';\n", + "\n", + " this.root = $('
');\n", + " this._root_extra_style(this.root)\n", + " this.root.attr('style', 'display: inline-block');\n", + "\n", + " $(parent_element).append(this.root);\n", + "\n", + " this._init_header(this);\n", + " this._init_canvas(this);\n", + " this._init_toolbar(this);\n", + "\n", + " var fig = this;\n", + "\n", + " this.waiting = false;\n", + "\n", + " this.ws.onopen = function () {\n", + " fig.send_message(\"supports_binary\", {value: fig.supports_binary});\n", + " fig.send_message(\"send_image_mode\", {});\n", + " fig.send_message(\"refresh\", {});\n", + " }\n", + "\n", + " this.imageObj.onload = function() {\n", + " if (fig.image_mode == 'full') {\n", + " // Full images could contain transparency (where diff images\n", + " // almost always do), so we need to clear the canvas so that\n", + " // there is no ghosting.\n", + " fig.context.clearRect(0, 0, fig.canvas.width, fig.canvas.height);\n", + " }\n", + " fig.context.drawImage(fig.imageObj, 0, 0);\n", + " };\n", + "\n", + " this.imageObj.onunload = function() {\n", + " this.ws.close();\n", + " }\n", + "\n", + " this.ws.onmessage = this._make_on_message_function(this);\n", + "\n", + " this.ondownload = ondownload;\n", + "}\n", + "\n", + "mpl.figure.prototype._init_header = function() {\n", + " var titlebar = $(\n", + " '
');\n", + " var titletext = $(\n", + " '
');\n", + " titlebar.append(titletext)\n", + " this.root.append(titlebar);\n", + " this.header = titletext[0];\n", + "}\n", + "\n", + "\n", + "\n", + "mpl.figure.prototype._canvas_extra_style = function(canvas_div) {\n", + "\n", + "}\n", + "\n", + "\n", + "mpl.figure.prototype._root_extra_style = function(canvas_div) {\n", + "\n", + "}\n", + "\n", + "mpl.figure.prototype._init_canvas = function() {\n", + " var fig = this;\n", + "\n", + " var canvas_div = $('
');\n", + "\n", + " canvas_div.attr('style', 'position: relative; clear: both; outline: 0');\n", + "\n", + " function canvas_keyboard_event(event) {\n", + " return fig.key_event(event, event['data']);\n", + " }\n", + "\n", + " canvas_div.keydown('key_press', canvas_keyboard_event);\n", + " canvas_div.keyup('key_release', canvas_keyboard_event);\n", + " this.canvas_div = canvas_div\n", + " this._canvas_extra_style(canvas_div)\n", + " this.root.append(canvas_div);\n", + "\n", + " var canvas = $('');\n", + " canvas.addClass('mpl-canvas');\n", + " canvas.attr('style', \"left: 0; top: 0; z-index: 0; outline: 0\")\n", + "\n", + " this.canvas = canvas[0];\n", + " this.context = canvas[0].getContext(\"2d\");\n", + "\n", + " var rubberband = $('');\n", + " rubberband.attr('style', \"position: absolute; left: 0; top: 0; z-index: 1;\")\n", + "\n", + " var pass_mouse_events = true;\n", + "\n", + " canvas_div.resizable({\n", + " start: function(event, ui) {\n", + " pass_mouse_events = false;\n", + " },\n", + " resize: function(event, ui) {\n", + " fig.request_resize(ui.size.width, ui.size.height);\n", + " },\n", + " stop: function(event, ui) {\n", + " pass_mouse_events = true;\n", + " fig.request_resize(ui.size.width, ui.size.height);\n", + " },\n", + " });\n", + "\n", + " function mouse_event_fn(event) {\n", + " if (pass_mouse_events)\n", + " return fig.mouse_event(event, event['data']);\n", + " }\n", + "\n", + " rubberband.mousedown('button_press', mouse_event_fn);\n", + " rubberband.mouseup('button_release', mouse_event_fn);\n", + " // Throttle sequential mouse events to 1 every 20ms.\n", + " rubberband.mousemove('motion_notify', mouse_event_fn);\n", + "\n", + " rubberband.mouseenter('figure_enter', mouse_event_fn);\n", + " rubberband.mouseleave('figure_leave', mouse_event_fn);\n", + "\n", + " canvas_div.on(\"wheel\", function (event) {\n", + " event = event.originalEvent;\n", + " event['data'] = 'scroll'\n", + " if (event.deltaY < 0) {\n", + " event.step = 1;\n", + " } else {\n", + " event.step = -1;\n", + " }\n", + " mouse_event_fn(event);\n", + " });\n", + "\n", + " canvas_div.append(canvas);\n", + " canvas_div.append(rubberband);\n", + "\n", + " this.rubberband = rubberband;\n", + " this.rubberband_canvas = rubberband[0];\n", + " this.rubberband_context = rubberband[0].getContext(\"2d\");\n", + " this.rubberband_context.strokeStyle = \"#000000\";\n", + "\n", + " this._resize_canvas = function(width, height) {\n", + " // Keep the size of the canvas, canvas container, and rubber band\n", + " // canvas in synch.\n", + " canvas_div.css('width', width)\n", + " canvas_div.css('height', height)\n", + "\n", + " canvas.attr('width', width);\n", + " canvas.attr('height', height);\n", + "\n", + " rubberband.attr('width', width);\n", + " rubberband.attr('height', height);\n", + " }\n", + "\n", + " // Set the figure to an initial 600x600px, this will subsequently be updated\n", + " // upon first draw.\n", + " this._resize_canvas(600, 600);\n", + "\n", + " // Disable right mouse context menu.\n", + " $(this.rubberband_canvas).bind(\"contextmenu\",function(e){\n", + " return false;\n", + " });\n", + "\n", + " function set_focus () {\n", + " canvas.focus();\n", + " canvas_div.focus();\n", + " }\n", + "\n", + " window.setTimeout(set_focus, 100);\n", + "}\n", + "\n", + "mpl.figure.prototype._init_toolbar = function() {\n", + " var fig = this;\n", + "\n", + " var nav_element = $('
')\n", + " nav_element.attr('style', 'width: 100%');\n", + " this.root.append(nav_element);\n", + "\n", + " // Define a callback function for later on.\n", + " function toolbar_event(event) {\n", + " return fig.toolbar_button_onclick(event['data']);\n", + " }\n", + " function toolbar_mouse_event(event) {\n", + " return fig.toolbar_button_onmouseover(event['data']);\n", + " }\n", + "\n", + " for(var toolbar_ind in mpl.toolbar_items) {\n", + " var name = mpl.toolbar_items[toolbar_ind][0];\n", + " var tooltip = mpl.toolbar_items[toolbar_ind][1];\n", + " var image = mpl.toolbar_items[toolbar_ind][2];\n", + " var method_name = mpl.toolbar_items[toolbar_ind][3];\n", + "\n", + " if (!name) {\n", + " // put a spacer in here.\n", + " continue;\n", + " }\n", + " var button = $('');\n", - " button.click(method_name, toolbar_event);\n", - " button.mouseover(tooltip, toolbar_mouse_event);\n", - " nav_element.append(button);\n", - " }\n", - "\n", - " // Add the status bar.\n", - " var status_bar = $('');\n", - " nav_element.append(status_bar);\n", - " this.message = status_bar[0];\n", - "\n", - " // Add the close button to the window.\n", - " var buttongrp = $('
');\n", - " var button = $('');\n", - " button.click(function (evt) { fig.handle_close(fig, {}); } );\n", - " button.mouseover('Stop Interaction', toolbar_mouse_event);\n", - " buttongrp.append(button);\n", - " var titlebar = this.root.find($('.ui-dialog-titlebar'));\n", - " titlebar.prepend(buttongrp);\n", - "}\n", - "\n", - "mpl.figure.prototype._root_extra_style = function(el){\n", - " var fig = this\n", - " el.on(\"remove\", function(){\n", - "\tfig.close_ws(fig, {});\n", - " });\n", - "}\n", - "\n", - "mpl.figure.prototype._canvas_extra_style = function(el){\n", - " // this is important to make the div 'focusable\n", - " el.attr('tabindex', 0)\n", - " // reach out to IPython and tell the keyboard manager to turn it's self\n", - " // off when our div gets focus\n", - "\n", - " // location in version 3\n", - " if (IPython.notebook.keyboard_manager) {\n", - " IPython.notebook.keyboard_manager.register_events(el);\n", - " }\n", - " else {\n", - " // location in version 2\n", - " IPython.keyboard_manager.register_events(el);\n", - " }\n", - "\n", - "}\n", - "\n", - "mpl.figure.prototype._key_event_extra = function(event, name) {\n", - " var manager = IPython.notebook.keyboard_manager;\n", - " if (!manager)\n", - " manager = IPython.keyboard_manager;\n", - "\n", - " // Check for shift+enter\n", - " if (event.shiftKey && event.which == 13) {\n", - " this.canvas_div.blur();\n", - " event.shiftKey = false;\n", - " // Send a \"J\" for go to next cell\n", - " event.which = 74;\n", - " event.keyCode = 74;\n", - " manager.command_mode();\n", - " manager.handle_keydown(event);\n", - " }\n", - "}\n", - "\n", - "mpl.figure.prototype.handle_save = function(fig, msg) {\n", - " fig.ondownload(fig, null);\n", - "}\n", - "\n", - "\n", - "mpl.find_output_cell = function(html_output) {\n", - " // Return the cell and output element which can be found *uniquely* in the notebook.\n", - " // Note - this is a bit hacky, but it is done because the \"notebook_saving.Notebook\"\n", - " // IPython event is triggered only after the cells have been serialised, which for\n", - " // our purposes (turning an active figure into a static one), is too late.\n", - " var cells = IPython.notebook.get_cells();\n", - " var ncells = cells.length;\n", - " for (var i=0; i= 3 moved mimebundle to data attribute of output\n", - " data = data.data;\n", - " }\n", - " if (data['text/html'] == html_output) {\n", - " return [cell, data, j];\n", - " }\n", - " }\n", - " }\n", - " }\n", - "}\n", - "\n", - "// Register the function which deals with the matplotlib target/channel.\n", - "// The kernel may be null if the page has been refreshed.\n", - "if (IPython.notebook.kernel != null) {\n", - " IPython.notebook.kernel.comm_manager.register_target('matplotlib', mpl.mpl_figure_comm);\n", - "}\n" - ], - "text/plain": [ - "" - ] - }, - "metadata": {}, - "output_type": "display_data" - }, { "data": { "text/html": [ @@ -16668,18 +16684,12 @@ "# Using groups to define subplots\n", "with replot.Figure() as figure:\n", " figure.plot(np.cos, (-10, 10), group=\"a\")\n", - " figure.plot(np.sin, (-10, 10), group=\"ç\")\n", - " \n", - "# this is equivalent to setting an auto grid\n", - "with replot.Figure() as figure:\n", - " figure.plot(np.cos, (-10, 10), group=\"a\")\n", - " figure.plot(np.sin, (-10, 10), group=\"ç\")\n", - " figure.set_grid(auto=True)" + " figure.plot(np.sin, (-10, 10), group=\"ç\")" ] }, { "cell_type": "code", - "execution_count": 17, + "execution_count": 6, "metadata": { "collapsed": false }, @@ -19852,7 +19862,7 @@ }, { "cell_type": "code", - "execution_count": 21, + "execution_count": 7, "metadata": { "collapsed": false }, @@ -20645,7 +20655,7 @@ }, { "cell_type": "code", - "execution_count": 25, + "execution_count": 8, "metadata": { "collapsed": false }, @@ -21435,12 +21445,12 @@ " figure.plot(np.cos, (-10, 10))\n", " figure.plot(np.cos, (-10, 10))\n", " figure.plot(np.cos, (-10, 10))\n", - " figure.set_grid(auto={\"ignore_groups\": True})" + " figure.set_grid(ignore_groups=True)" ] }, { "cell_type": "code", - "execution_count": 26, + "execution_count": 9, "metadata": { "collapsed": false }, @@ -22231,12 +22241,12 @@ " figure.plot(np.cos, (-10, 10), group=\"a\")\n", " figure.plot(np.cos, (-10, 10), group=\"b\")\n", " figure.plot(np.cos, (-10, 10), group=\"c\")\n", - " figure.set_grid(auto={\"ignore_groups\": True})" + " figure.set_grid(ignore_groups=True)" ] }, { "cell_type": "code", - "execution_count": 27, + "execution_count": 10, "metadata": { "collapsed": false }, @@ -23024,13 +23034,12 @@ " figure.plot(np.cos, (-10, 10), group=\"a\")\n", " figure.plot(np.cos, (-10, 10), group=\"b\")\n", " figure.plot(np.cos, (-10, 10))\n", - " figure.plot(np.sin, (-10, 10))\n", - " figure.set_grid(auto=True)" + " figure.plot(np.sin, (-10, 10))" ] }, { "cell_type": "code", - "execution_count": 28, + "execution_count": 11, "metadata": { "collapsed": false }, @@ -24594,14 +24603,14 @@ "with replot.Figure() as figure:\n", " figure.plot(np.cos, (-10, 10), group=\"a\")\n", " figure.plot(np.cos, (-10, 10), group=\"b\")\n", - " figure.set_grid(auto={\"height\": 2})\n", + " figure.set_grid(height=2)\n", " \n", "# Gridify example, forced width\n", "# … or the width\n", "with replot.Figure() as figure:\n", " figure.plot(np.cos, (-10, 10), group=\"a\")\n", " figure.plot(np.cos, (-10, 10), group=\"b\")\n", - " figure.set_grid(auto={\"width\": 2})" + " figure.set_grid(width=2)" ] }, { diff --git a/replot/__init__.py b/replot/__init__.py index 605e481..10851e6 100644 --- a/replot/__init__.py +++ b/replot/__init__.py @@ -129,7 +129,9 @@ class Figure(): figure = self._render() figure.show() - def set_grid(self, grid_description=None, auto=False): + def set_grid(self, grid_description=None, + height=None, width=None, ignore_groups=False, + auto=False): """ Apply a grid layout on the figure (subplots). Subplots are based on \ defined groups (see ``group`` keyword to \ @@ -138,12 +140,17 @@ class Figure(): :param grid_description: A list of rows. Each row is a string \ containing the groups to display (can be seen as ASCII art). \ Can be a single string in case of a single row. + :param height: An optional ``height`` for the grid, implies \ + ``auto=True``. + :param width: An optional ``height`` for the grid, implies \ + ``auto=True``. + :param ignore_groups: (optional, implies ``auto=True``) By default, \ + ``set_grid`` will use groups to organize plots in different \ + subplots. If you want to put every plot in a different \ + subplot, regardless of their groups, you can set this \ + to ``True``. :param auto: Whether the grid should be guessed automatically from \ - groups or not (optional). Can be a boolean or a dict having \ - the possible ``height`` (int), ``width`` (int) and \ - ``ignore_groups`` (boolean) fields to force the height or \ - width of the resulting grid, or force every plot to go in \ - a separate subplot, regardless of its group. + groups or not (optional). .. note:: Groups are a single unicode character. If a group does not \ contain any plot, the resulting subplot will simply be empty. @@ -156,11 +163,8 @@ class Figure(): "DEC"]) """ # Handle auto gridifying - if auto is not False: - if isinstance(auto, dict): - self._set_auto_grid(**auto) - else: - self._set_auto_grid() + if auto or height is not None or width is not None or ignore_groups: + self._set_auto_grid(height, width, ignore_groups) return # Default parameters @@ -206,9 +210,9 @@ class Figure(): :param height: An optional ``height`` for the grid. :param width: An optional ``height`` for the grid. - :param ignore_groups: By default, ``gridify`` will use groups to \ + :param ignore_groups: By default, ``set_grid`` will use groups to \ organize plots in different subplots. If you want to put \ - every plot in a different subplot, without dealing with \ + every plot in a different subplot, regardless of their \ groups, you can set this to ``True``. """ if ignore_groups: