Article Categories
- All Categories
-
Data Structure
-
Networking
-
RDBMS
-
Operating System
-
Java
-
MS Excel
-
iOS
-
HTML
-
CSS
-
Android
-
Python
-
C Programming
-
C++
-
C#
-
MongoDB
-
MySQL
-
Javascript
-
PHP
-
Economics & Finance
How to create a JSON representation of a Line object using FabricJS?
In this tutorial, we are going to learn about how to create a JSON representation of a Line object using FabricJS. A Line element is one of the basic elements provided in FabricJS. It is used for creating straight lines. Because line elements are geometrically one-dimensional and do not contain an interior, they are never filled. We can create a line object by creating an instance of fabric.Line, specifying the x and y coordinates of the line and adding it to the canvas. In order to create a JSON representation of a Line object, we use the toJSON method.
Syntax
toJSON(propertiesToInclude: Array): Object
Parameters
-
propertiesToInclude ? This parameter accepts an Array which contains any properties we might want to additionally include in the output. This parameter is optional.
Using the toJSON Method
Let's see a code example to see the logged output when the toJSON method is used. In this case, a JSON representation of the line instance will be returned.
<!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>Using the toJSON method</h2>
<p>
You can open console from dev tools and see that the logged output contains the JSON representation of the line instance
</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 Line object
var line = new fabric.Line([200, 100, 100, 40], {
stroke: "blue",
strokeWidth: 20,
});
// Add it to the canvas
canvas.add(line);
// Using the toJSON method
console.log("JSON representation of the Line instance is: ", line.toJSON());
</script>
</body>
</html>
JSON representation of the Line instance is: {
"type": "line",
"version": "5.1.0",
"originX": "left",
"originY": "top",
"left": 100,
"top": 40,
"width": 100,
"height": 60,
"fill": "rgb(0,0,0)",
"stroke": "blue",
"strokeWidth": 20,
"strokeDashArray": null,
"strokeLineCap": "butt",
"strokeDashOffset": 0,
"strokeLineJoin": "miter",
"strokeUniform": false,
"strokeMiterLimit": 4,
"scaleX": 1,
"scaleY": 1,
"angle": 0,
"flipX": false,
"flipY": false,
"opacity": 1,
"shadow": null,
"visible": true,
"backgroundColor": "",
"fillRule": "nonzero",
"paintFirst": "fill",
"globalCompositeOperation": "source-over",
"skewX": 0,
"skewY": 0,
"x1": 200,
"y1": 100,
"x2": 100,
"y2": 40
}
Using toJSON Method to Add Additional Properties
Let's see a code example to see how we can include additional properties by using the toJSON method. In this case, we have added a custom property called "name". We can pass the specific property to the fabric.Line instance as second argument in options object and pass same key to the toJSON method.
<!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>Using toJSON method to add additional properties</h2>
<p>
You can open console from dev tools and see that the logged output contains added property called name
</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 Line object with name key
// passed in options object
var line = new fabric.Line([200, 100, 100, 40], {
stroke: "blue",
strokeWidth: 20,
name: "Line instance",
});
// Add it to the canvas
canvas.add(line);
// Using the toJSON method
console.log(
"JSON representation of the Line instance is: ",
line.toJSON(["name"])
);
</script>
</body>
</html>
JSON representation of the Line instance is: {
"type": "line",
"version": "5.1.0",
"originX": "left",
"originY": "top",
"left": 100,
"top": 40,
"width": 100,
"height": 60,
"fill": "rgb(0,0,0)",
"stroke": "blue",
"strokeWidth": 20,
"strokeDashArray": null,
"strokeLineCap": "butt",
"strokeDashOffset": 0,
"strokeLineJoin": "miter",
"strokeUniform": false,
"strokeMiterLimit": 4,
"scaleX": 1,
"scaleY": 1,
"angle": 0,
"flipX": false,
"flipY": false,
"opacity": 1,
"shadow": null,
"visible": true,
"backgroundColor": "",
"fillRule": "nonzero",
"paintFirst": "fill",
"globalCompositeOperation": "source-over",
"skewX": 0,
"skewY": 0,
"x1": 200,
"y1": 100,
"x2": 100,
"y2": 40,
"name": "Line instance"
}
Key Points
- The toJSON method returns a complete JSON representation of the Line object
- The JSON includes all standard properties like coordinates, styling, and transformation properties
- Custom properties can be included by passing them in the propertiesToInclude array parameter
- This JSON representation can be used for serialization, saving canvas state, or recreating objects later
Conclusion
The toJSON method in FabricJS provides a convenient way to serialize Line objects into JSON format. This is particularly useful for saving canvas state or transmitting object data, and supports including custom properties as needed.
548 Views
