Class: tool

ajs.maps.gmapdraw. tool

This class is the superclass for all gmapdraw tools, extended by all specific tools.

DO NOT INSTANTIATE THIS CLASS DIRECLTY, use its children instead.

new tool

Google maps drawing tool class.

Parameters:
Name Type Description
id Number The identifier of the child class
map ajs.maps.gmapdraw.map The gmapdraw map instance which handles the tool
ctrl String | Element The id attribute or the element itself which controls the tool when clicking over it
tool_name String The drawing tool name
Source:
  • gmapdraw.js, line 780

Methods

activate

Activates the tool

Source:
  • gmapdraw.js, line 866
Returns:
void

addItem

Adds an item to the items

Parameters:
Name Type Description
item Object a google map shape
Source:
  • gmapdraw.js, line 940
Returns:
void

deactivate

Removes the tool

Parameters:
Name Type Argument Default Description
remove_ctrl Boolean <optional>
 false Whether or not to remove the tool control if the default one
Source:
  • gmapdraw.js, line 886
Returns:
void

getToolName

Returns the tool name

Source:
  • gmapdraw.js, line 966
Returns:
The tool name
Type
String

<protected> options

Returns the class options

Source:
  • gmapdraw.js, line 816
Returns:
The class options object
Type
Object

prepareTool

Prepares the current drawing tool

Source:
  • gmapdraw.js, line 931
Returns:
void

<protected> protectedProp

Returns the class protected properties

Source:
  • gmapdraw.js, line 826
Returns:
The class protected properties object
Type
Object

<protected> removeController

Removes the default tool controller

Source:
  • gmapdraw.js, line 857
Returns:
void

<protected> setController

Sets the tool controller

Parameters:
Name Type Argument Default Description
ctrl String/Element <optional>
 null The id attribute or the element itself which serves as the tool controller, if null the default controller is used.
Source:
  • gmapdraw.js, line 837
Returns:
void

setDrawing

Sets the current drawing tool

Source:
  • gmapdraw.js, line 921
Returns:
void

setMaxItemsAllowed

Sets the maximum number of items that the tool may draw

Parameters:
Name Type Description
max The maximum number of drawable items
Source:
  • gmapdraw.js, line 949
Returns:
void

setNextShape

Sets the value of the next shape property (a new click starts a new shape if true)

Parameters:
Name Type Description
next_shape Whether or not next click has to start a new shape
Source:
  • gmapdraw.js, line 958
Returns:
void