Namespace: olturf

Classes

Toolbar

Namespaces

toolbars

Type Definitions

---

Callback(name, inputs, output)

Function that handles processing the output of the olturf controls.

Parameters:

Name	Type	Description
name	string	Name of control to process
inputs	object	Inputs passed to the control's corresponding turf function
output	*	Output returned by the turf function

---

Handler

olturf custom callback handler.

Type:

• object

Properties:

Name	Type	Description
callback	olturf.Callback	Function to handle processing turf commands.

---

Options

olturf constructor options.

Type:

• object

Properties:

Name	Type	Argument	Default	Description
controls	Array.<string>	<optional>	olturf.toolbars.all	List of names of control to enable.
handler	olturf.Handler	<optional>	'undefined'	Optional function that handles processing the output of the olturf controls. This is useful to bypass the default handler and provide custom processing of the results. The default handler adds features to the map or displays a message with any values returned by the turf function.
prefix	string	<optional>	'olturf'	Prefix to apply to control element IDs. Only needed to make IDs unique if multiple instances of an olturf toolbar are used on the same page.
style	string	<optional>	'olturf-toolbar'	The name of the class to apply to the toolbar.