Navigation:  WebOffice Standard Reference > WebOffice Category > Tools > Web Integration - Custom Tool 1 - 4 and 19 - 24 >

Sketch Custom Tool

Previous pageReturn to chapter overviewNext page

The Sketch Custom Tool provides an interface for client side drawing with/without construction. Functions included in the custom tool are:

content height:
sets the height for the content of the custom tool

callback:
sets a javascript function that gets called when the user clicks the commit button in the drawing form

show/hide tool form

start draw:
start the drawing functionality

osupports points, lines and polygons

osupports a predefined array of vertices

draw state:
gets the current state of drawing and returns a javascript object with the following properties:

ogeometrytype (point, line or polygon)

ogeometry (the vertices of the geometry as an array of [x,y] arrays in geo coordinates

opixelgeometry (the vertices of the geometry as an array of [x,y] arrays in pixel coordinates

ofinished (boolean; true signifies the user has finished geometry editing)

oconstruction (boolean; true if the tool is in construction mode)

 

Note: When using a sketch custom tool, a new tool form will be opened. Other tools cannot be either activated or used.

 

Sketch Custom Tool Configuration - no further parameters have to be defined

Sketch Custom Tool Configuration - no further parameters have to be defined

 

Note: For more information, please see the lowermost part of the file scriptAPI.txt, located in C:\Tomcat\webapps\<WebOffice Application>\pub\custom_tools.