Mapspace API Reference

Class: ToolAttributeEvent

Mapspace.control. ToolAttributeEvent

Events emitted by controls with tools related to attributes.

new ToolAttributeEvent(type, tool, interactive [, opt_layer] [, opt_features] [, opt_name] [, opt_internalName])

Parameters:
Name Type Argument Description
type Mapspace.control.EventType

Event type.
tool string <nullable>

The name of the tool selected. If the tool is interactive then it can be the name of the tool when the tool is activated, or null if the tool is deactivated. For a tool that is not interactive it is the name of the tool.
interactive boolean

If the tool selected is interactive or not.
opt_layer Mapspace.layer.Vector <optional>

An optional layer the tool selected must affect, if any tool is selected.
opt_features Array.<ol.Feature> <optional>

An optional array of features the selected tool must affect, if any tool is selected.
opt_name string <optional>

An optional name for attribute that is affected.
opt_internalName string <optional>

An optional internal name for attribute that is affected. Usually this name is the same in opt_name but it can be different.
Source:
mapspace/events.js

Extends

Members

features :Array.<ol.Feature>

An optional array of features the selected tool must affect, if any tool is selected.

Inherited From:
Source:
mapspace/events.js

interactive :boolean

If the tool selected is interactive or not.

Inherited From:
Source:
mapspace/events.js

internalName :string

An optional internal name for attribute that is affected. Usually this name is the same in opt_name but it can be different.

Source:
mapspace/events.js

layer :Mapspace.layer.Vector

An optional layer the tool selected must affect, if any tool is selected.

Inherited From:
Source:
mapspace/events.js

name :string

An optional name for attribute that is affected.

Source:
mapspace/events.js

<nullable> tool :string

The name of the tool selected. If the tool is interactive then it can be the name of the tool when the tool is activated, or null if the tool is deactivated. For a tool that is not interactive it is the name of the tool.

Inherited From:
Source:
mapspace/events.js