Mapspace API Reference

Class: TaskEvent

Mapspace. TaskEvent

Events emitted when a long task action occurs.

new TaskEvent(type, id [, title] [, message] [, progress], notificationType)

Parameters:
Name Type Argument Description
type string

Event type.
id number

Unique number that identifies and correlate several events to the same task.
title string <optional>

Optional title or title globalization subkey for the control Mapspace.control.Notifier or any other control consuming the event triggered.
message string <optional>

Optional message or message globalization subkey for the control Mapspace.control.Notifier or any other control consuming the event triggered.
progress number <optional>

Optional percentage progress of the task.
notificationType Mapspace.NotificationType <nullable>

Optional type of the notification.
Source:
mapspace/events.js

Extends

Members

id :number

The unique number.

Source:
mapspace/events.js

message :string

Optional message or message globalization key.

Source:
mapspace/events.js

<nullable> notificationType :Mapspace.NotificationType

Optional type of the notification.

Source:
mapspace/events.js

progress :number

Optional percentage progress of the task.

Source:
mapspace/events.js

title :string

Optional title or title globalization key.

Source:
mapspace/events.js