How to lock the horizontal scaling of Textbox using FabricJS?


In this tutorial, we are going to learn how to lock the horizontal scaling of a Textbox using FabricJS. Just as we can specify the position, colour, opacity and dimension of a textbox 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.Textbox(text: String, { lockScalingX : Boolean }: Object)

Parameters

  • text − This parameter accepts a String which is the text string that we want to display inside our textbox.

  • options (optional) − This parameter is an Object which provides additional customizations to our textbox. 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 Textbox object in the canvas

Let’s see a code example to understand the default behaviour of a Textbox 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 Textbox object in the canvas</h2> <p>You can scale the textbox in horizontal and vertical directions to verifythat scaling is possible in both directions.</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 textbox object var textbox = new fabric.Textbox("Stars can’t shine without darkness.", { width: 400, left: 110, top: 70, fill: "violet", strokeWidth: 2, stroke: "pink", textAlign: "center", }); // Add it to the canvas canvas.add(textbox); </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 textbox object to scale horizontally using the lockScalingX property. As we can see, although we can scale the textbox 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 "true" value</h2> <p>You can see a "not-allowed" cursor if you try to scale the textbox in the X-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 textbox object var textbox = new fabric.Textbox("Stars can't shine without darkness.", { width: 400, left: 110, top: 70, fill: "violet", strokeWidth: 2, stroke: "pink", textAlign: "center", lockScalingX: true, }); // Add it to the canvas canvas.add(textbox); </script> </body> </html>

Updated on: 02-Aug-2022

281 Views

Kickstart Your Career

Get certified by completing the course

Get Started
Advertisements