registerTool Method

In This Topic

Registers the visual tool type.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.UI.VisualTools.WebVisualToolFabricJS();

var value; // Type: any

// Parameters
var id; // Type: string
var createFunction; // Type: function

value = instance.registerTool(id, createFunction);

function registerTool(
   idThe ID of the visual tool type.
 : string, 
   createFunctionFunction, which allows to create required WebVisualToolJS object.
 : Function
) : any;

Parameters

id: The ID of the visual tool type.
createFunction: Function, which allows to create required WebVisualToolJS object.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.
	Thrown if element ID is empty string.
	Thrown if fabric contains standard registered tool with the same ID (WebVisualToolFabricJS.getAllStandardRegisteredIds).

Browser Compatibility

56+

45+

Reference

WebVisualToolFabricJS Class
WebVisualToolFabricJS Members

Send Feedback