How to lock the horizontal scaling of a Rectangle using FabricJS?


In this tutorial, we are going to learn how to lock the horizontal scaling of a Rectangle using FabricJS. Just as we can specify the position, colour, opacity and dimension of a rectangle object in the canvas, we can also specify whether we want to stop scaling an object horizontally. This can be done by using the lockScalingX property.

Syntax

new fabric.Rect({ lockScalingX : Boolean }: Object)

Parameters

  • Options (optional) − This parameter is an Object which provides additional customizations to our rectangle. Using this parameter, properties such as colour, cursor, stroke width, and a lot of other properties can be changed related to the object of which lockScalingX is a property.

Options Keys

  • lockScalingX − This property accepts a Boolean value. If we assign it a True value, then the object's horizontal scaling will be locked.

Example 1

Default behaviour of a Rectangle object in the canvas

Let’s see a code example to understand the default behaviour of a Rectangle object when lockScalingX property is not used. Scaling the object in both horizontal and vertical directions is feasible.

<!DOCTYPE html>
<html>
<head>
   <!-- Adding the Fabric JS Library-->
   <script src="https://cdnjs.cloudflare.com/ajax/libs/fabric.js/510/fabric.min.js"></script>
</head>
<body>
   <h2>Default behaviour of a Rectangle object in the canvas</h2>
   <p>You can scale the rectangle in horizontal and vertical directions to verify that scaling in both directions is possible.</p>
   <canvas id="canvas"></canvas>
   <script>
      // Initiate a canvas instance
      var canvas = new fabric.Canvas("canvas");
      canvas.setWidth(document.body.scrollWidth);
      canvas.setHeight(250);

      // Initiate a rectangle object
      var rect = new fabric.Rect({
         left: 155,
         top: 90,
         width: 170,
         height: 70,
         fill: "white",
         padding: 9,
         stroke: "#483d8b",
         strokeWidth: 5,
      });

      // Add it to the canvas
      canvas.add(rect);
   </script>
</body>
</html>

Example 2

Passing lockScalingX as key with ‘true’ value

In this example, we will see how we can cease the ability of a rectangle object to scale horizontally using the lockScalingX property. As we can see, although we can scale the rectangle object vertically, we are not allowed to perform the same action horizontally.

<!DOCTYPE html>
<html>
<head>
   <!-- Adding the Fabric JS Library-->
   <script src="https://cdnjs.cloudflare.com/ajax/libs/fabric.js/510/fabric.min.js"></script>
</head>
<body>
   <h2>Passing lockScalingX as key with a True value</h2>
   <p>You can see a not-allowed cursor if you try to scale the rectangle in the
horizontal direction.</p>
   <canvas id="canvas"></canvas>
   <script>
      // Initiate a canvas instance
      var canvas = new fabric.Canvas("canvas");
      canvas.setWidth(document.body.scrollWidth);
      canvas.setHeight(250);

      // Initiate a rectangle object
      var rect = new fabric.Rect({
         left: 155,
         top: 90,
         width: 170,
         height: 70,
         fill: "white",
         padding: 9,
         stroke: "#483d8b",
         strokeWidth: 5,
         lockScalingX: true,
      });

      // Add it to the canvas
      canvas.add(rect);
   </script>
</body>
</html>

Updated on: 29-Jun-2022

288 Views

Kickstart Your Career

Get certified by completing the course

Get Started
Advertisements