Merge pull request #69 from martinRenou/deprecate_size

Deprecate size and use width, height

Author: martinRenou

docs/source/advanced.rst

@@ -16,7 +16,7 @@ A way to work around this is to perform your drawings in a callback that gets ca
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(100, 50))
+    canvas = Canvas(width=100, height=50)
 
     def perform_drawings():
         canvas.font = '32px serif'

docs/source/basic_usage.rst

@@ -4,13 +4,13 @@ Basic usage
 Create Canvas
 -------------
 
-You need to provide the size of the ``Canvas`` (width, height) in the constructor.
+You can provide the width and height of the ``Canvas`` in pixels in the constructor.
 
 .. code:: Python
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200))
+    canvas = Canvas(width=200, height=200)
     canvas
 
 You can also create a multi-layer canvas. This is useful when you have a background
@@ -21,7 +21,7 @@ that does not need to update much while other objects moves a lot on the screen.
     from ipycanvas import MultiCanvas
 
     # Create a multi-layer canvas with 4 layers
-    multi_canvas = MultiCanvas(4, size=(200, 200))
+    multi_canvas = MultiCanvas(4, width=200, height=200)
     multi_canvas[0] #  Access first layer (background)
     multi_canvas[3] #  Access last layer
     multi_canvas
@@ -33,6 +33,16 @@ that does not need to update much while other objects moves a lot on the screen.
     - observe some of its attributes and call functions when they change
     - link some of its attributes to other widget attributes
 
+Resize Canvas
+-------------
+
+You can dynamically resize the ``Canvas`` and ``MultiCanvas``, note that this will clear the canvas.
+
+.. code:: Python
+
+    canvas.width = 300
+    canvas.height = 600
+
 Clear Canvas
 ------------
 
@@ -42,7 +52,7 @@ The ``Canvas`` and ``MultiCanvas`` classes have a ``clear`` method which allows
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200))
+    canvas = Canvas(width=200, height=200)
 
     # Perform some drawings...
 
@@ -65,7 +75,7 @@ send them in a single batch at the end.
 
     from ipycanvas import Canvas, hold_canvas
 
-    canvas = Canvas(size=(200, 200))
+    canvas = Canvas(width=200, height=200)
 
     with hold_canvas(canvas):
         # Perform drawings...

docs/source/drawing_images.rst

@@ -17,7 +17,7 @@ You can draw from an `Image <https://ipywidgets.readthedocs.io/en/stable/example
     sprite1 = Image.from_file('sprites/smoke_texture0.png')
     sprite2 = Image.from_file('sprites/smoke_texture1.png')
 
-    canvas = Canvas(size=(300, 300))
+    canvas = Canvas(width=300, height=300)
 
     canvas.fill_style = '#a9cafc'
     canvas.fill_rect(0, 0, 300, 300)
@@ -36,7 +36,7 @@ You can draw from another ``Canvas`` widget. This is the fastest way of drawing
 
 .. code:: Python
 
-    canvas2 = Canvas(size=(600, 300))
+    canvas2 = Canvas(width=600, height=300)
 
     # Here ``canvas`` is the canvas from the previous example
     canvas2.draw_image(canvas, 0, 0)
@@ -70,7 +70,7 @@ You can directly draw a NumPy array of pixels on the ``Canvas``, it must be a 3-
 
     image_data = np.stack((red_channel, blue_channel, green_channel), axis=2)
 
-    canvas = Canvas(size=(image_data.shape[0], image_data.shape[1]))
+    canvas = Canvas(width=image_data.shape[0], height=image_data.shape[1])
     canvas.put_image_data(image_data, 0, 0)
 
     canvas
@@ -92,13 +92,13 @@ Drawing from another ``Canvas`` is by far the fastest of the three solutions pre
     from ipycanvas import Canvas, hold_canvas
 
     # Create temporary Canvases
-    canvas_sprite1 = Canvas(size=(100, 100))
+    canvas_sprite1 = Canvas(width=100, height=100)
     canvas_sprite1.draw_image(Image.from_file('sprites/smoke_texture0.png'), 0, 0)
 
-    canvas_sprite2 = Canvas(size=(100, 100))
+    canvas_sprite2 = Canvas(width=100, height=100)
     canvas_sprite2.draw_image(Image.from_file('sprites/smoke_texture1.png'), 0, 0)
 
-    canvas_sprite3 = Canvas(size=(100, 100))
+    canvas_sprite3 = Canvas(width=100, height=100)
     canvas_sprite3.draw_image(Image.from_file('sprites/smoke_texture2.png'), 0, 0)
 
     sprites = [canvas_sprite1, canvas_sprite2, canvas_sprite3]
@@ -110,7 +110,7 @@ Drawing from another ``Canvas`` is by far the fastest of the three solutions pre
 
 .. code:: Python
 
-    canvas = Canvas(size=(800, 600))
+    canvas = Canvas(width=800, height=600)
 
     with hold_canvas(canvas):
         for _ in range(2_000):

docs/source/drawing_shapes.rst

@@ -33,7 +33,7 @@ You can also clear a certain canvas rectangle area:
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200))
+    canvas = Canvas(width=200, height=200)
 
     canvas.fill_rect(25, 25, 100, 100)
     canvas.clear_rect(45, 45, 60, 60)
@@ -57,7 +57,7 @@ You can also clear a certain canvas rectangle area:
     y = np.array(np.random.rayleigh(250, n_particles), dtype=np.int32)
     size = np.random.randint(1, 3, n_particles)
 
-    canvas = Canvas(size=(800, 500))
+    canvas = Canvas(width=800, height=500)
 
     canvas.fill_style = 'green'
     canvas.fill_rects(x, y, size)
@@ -82,7 +82,7 @@ There are four methods that draw circles on the canvas:
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200))
+    canvas = Canvas(width=200, height=200)
 
     canvas.fill_style = 'red'
     canvas.stroke_style = 'blue'
@@ -117,7 +117,7 @@ Here are the functions used to perform these steps:
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(100, 100))
+    canvas = Canvas(width=100, height=100)
 
     # Draw simple triangle shape
     canvas.begin_path()
@@ -162,7 +162,7 @@ Stroke arcs
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200))
+    canvas = Canvas(width=200, height=200)
 
     # Draw smiley face
     canvas.begin_path()
@@ -186,7 +186,7 @@ Fill bezier curves
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200))
+    canvas = Canvas(width=200, height=200)
 
     # Cubic curves example
     canvas.begin_path()
@@ -211,7 +211,7 @@ Change the fill rule
     from math import pi
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(100, 100))
+    canvas = Canvas(width=100, height=100)
 
     canvas.begin_path()
     canvas.arc(50, 50, 30, 0, pi * 2, True)
@@ -239,7 +239,7 @@ You can also change the global transparency.
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200))
+    canvas = Canvas(width=200, height=200)
 
     canvas.fill_style = 'red'
     canvas.stroke_style = 'blue'
@@ -266,7 +266,7 @@ You can easily draw shadows by tweaking the following attributes:
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200))
+    canvas = Canvas(width=200, height=200)
 
     canvas.shadow_color = 'green'
     canvas.shadow_offset_x = 2
@@ -305,7 +305,7 @@ Sets the width of lines drawn in the future.
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(400, 280))
+    canvas = Canvas(width=400, height=280)
     canvas.scale(2)
 
     for i in range(10):
@@ -332,7 +332,7 @@ Sets the appearance of the ends of lines.
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(320, 360))
+    canvas = Canvas(width=320, height=360)
 
     # Possible line_cap values
     line_caps = ['butt', 'round', 'square']
@@ -377,7 +377,7 @@ Sets the appearance of the "corners" where lines meet.
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(320, 360))
+    canvas = Canvas(width=320, height=360)
 
     # Possible line_join values
     line_joins = ['round', 'bevel', 'miter']
@@ -419,7 +419,7 @@ Sets the current line dash pattern.
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(400, 280))
+    canvas = Canvas(width=400, height=280)
     canvas.scale(2)
 
     line_dashes = [

docs/source/drawing_text.rst

@@ -13,7 +13,7 @@ There are two methods that draw text on the canvas:
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(400, 50))
+    canvas = Canvas(width=400, height=50)
 
     canvas.font = '32px serif'
     canvas.fill_text('Drawing from Python is cool!', 10, 32)
@@ -25,7 +25,7 @@ There are two methods that draw text on the canvas:
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(400, 50))
+    canvas = Canvas(width=400, height=50)
 
     canvas.font = '32px serif'
     canvas.stroke_text('Hello There!', 10, 32)

docs/source/retrieve_images.rst

@@ -17,7 +17,7 @@ You can dump the current ``Canvas`` or ``MultiCanvas`` image to a PNG file using
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200), sync_image_data=True)
+    canvas = Canvas(width=200, height=200, sync_image_data=True)
 
     # Perform some drawings...
 
@@ -29,7 +29,7 @@ Note that this won't work if executed in the same Notebook cell. Because the Can
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200), sync_image_data=True)
+    canvas = Canvas(width=200, height=200, sync_image_data=True)
 
     # Perform some drawings...
 
@@ -48,7 +48,7 @@ You can get the image data of the ``Canvas`` or ``MultiCanvas`` using the ``get_
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200), sync_image_data=True)
+    canvas = Canvas(width=200, height=200, sync_image_data=True)
 
     # Perform some drawings...
 
@@ -61,7 +61,7 @@ Note that this won't work if executed in the same Notebook cell. Because the Can
 
     from ipycanvas import Canvas
 
-    canvas = Canvas(size=(200, 200), sync_image_data=True)
+    canvas = Canvas(width=200, height=200, sync_image_data=True)
 
     # Perform some drawings...
 

examples/MultiCanvas.ipynb

@@ -24,7 +24,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m = MultiCanvas(n_canvases=3, size=(200, 200))"
+    "m = MultiCanvas(n_canvases=3, width=200, height=200)"
    ]
   },
   {
@@ -121,6 +121,13 @@
    "source": [
     "draw_square(m[0], 0, 200, 'orange')"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -139,7 +146,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.3"
+   "version": "3.8.1"
   }
  },
  "nbformat": 4,

examples/binary_image.ipynb

@@ -78,7 +78,7 @@
    "source": [
     "scale = 1.5\n",
     "\n",
-    "canvas = Canvas(size=(scale * data.shape[0], scale * data.shape[1]))\n",
+    "canvas = Canvas(width=scale*data.shape[0], height=scale*data.shape[1])\n",
     "canvas"
    ]
   },
@@ -142,7 +142,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.3"
+   "version": "3.8.1"
   }
  },
  "nbformat": 4,

examples/conways_game_of_life.ipynb

@@ -93,7 +93,7 @@
    "source": [
     "n_pixels = 10\n",
     "\n",
-    "multi = MultiCanvas(2, size=(x.shape[1] * n_pixels, x.shape[0] * n_pixels))\n",
+    "multi = MultiCanvas(2, width=x.shape[1]*n_pixels, height=x.shape[0]*n_pixels)\n",
     "multi[0].fill_style = '#FFF0C9'\n",
     "multi[0].fill_rect(0, 0, multi.size[0], multi.size[1])\n",
     "\n",
@@ -145,7 +145,7 @@
    "outputs": [],
    "source": [
     "multi[0].fill_style = '#D0FFB3'\n",
-    "multi[0].fill_rect(0, 0, multi.size[0], multi.size[1])"
+    "multi[0].fill_rect(0, 0, multi.width, multi.height)"
    ]
   }
  ],
@@ -165,7 +165,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.3"
+   "version": "3.8.1"
   }
  },
  "nbformat": 4,