Mapspace API Reference

Class: Notifier

Mapspace.control. Notifier

Control to show notifications. It is based on bootstrap-notify.js plugin. See http://bootstrap-notify.remabledesigns.com/.

new Notifier( [options])

Parameters:
Name Type Argument Description
options Mapspace.control.ControlOptions <optional>

Control options.
Source:
mapspace/controls/notifier.js
Fires:
  • ol.Object.Event#event:change:enabled

Extends

Members

classNames :string|undefined

The class names to add to the default ones that the control will create.

Inherited From:
Source:
mapspace/controls/control.js

controldefs :Array.<Mapspace.ControlDefinition>

Array of control definitions this control contains.

Inherited From:
Source:
mapspace/controls/control.js

<nullable> element :Element

This is the HTML element where the control is drawn. Do not modify this property directly. Use only in the constructor.

Inherited From:
Source:
mapspace/controls/control.js

globalizationKey :string|undefined

This is the string that identifies in Mapspace.strings this control for globalization purposes.

Inherited From:
Source:
mapspace/controls/control.js

<nullable> target :Element

This is the HTML element where the control is appended. Do not modify this property directly. Use constructor or setTarget to set this value.

Inherited From:
Source:
mapspace/controls/control.js

Methods

addControlDefinition(controldef)

Adds a control definition to the control. By default the control in the control definition is changed its target to the element of this control. Override this behaviour in inherited classes to change the target to another one.

Parameters:
Name Type Description
controldef *

Control definition.
Inherited From:
Source:
mapspace/controls/control.js

addControlDefinitions(controldefs)

Adds an array of control definitions to the control. Controls in the control definition array shouldn't have a target set.

Parameters:
Name Type Description
controldefs Array.<Mapspace.control.ControlDefinition>

Array of control definitions to add.
Inherited From:
Source:
mapspace/controls/control.js

closeAll(type)

Closes and removes all notifications of one type or all.

Parameters:
Name Type Description
type Mapspace.NotificationType | undefined

The type of notifications. If no one is provided then all notifications are removed and closed.
Source:
mapspace/controls/notifier.js

closeByID(id)

Closes and removes a notification given by its ID.

Parameters:
Name Type Description
id string

ID of the notification to close and remove.
Source:
mapspace/controls/notifier.js

containsControlDefinition(controldef)

Checks if a control definition is already added.

Parameters:
Name Type Description
controldef Mapspace.ControlDefinition

Control definition to check.
Inherited From:
Source:
mapspace/controls/control.js
Returns:

True if it is added.

Type
boolean

fade(fadeIn)

Fades this control in or out. This method ignores the fadeOut property of the control. You must care to check if this control can be faded or not checking that value and also if this control lies inside an active viewer.

Parameters:
Name Type Description
fadeIn boolean

If the control must fade in, otherwise it will fade out.
Inherited From:
Source:
mapspace/controls/control.js

getControlDefinitions()

Return the array of control definitions this control has inside.

Inherited From:
Source:
mapspace/controls/control.js
Returns:
Type
Array.<Mapspace.ControlDefinition>

getEnabled()

Return whether the control is currently enabled. When a control is not enabled can be clicked, cannot be dragged, but none of those interactions produce any event.

Inherited From:
Source:
mapspace/controls/control.js
Returns:

true if the control is enabled, false otherwise.

Type
boolean

getFadeInEnabled()

Returns if the control can be faded in. By default is true.

Inherited From:
Source:
mapspace/controls/control.js
Returns:
Type
boolean

getFadeOutMode()

Returns the mode this control can be faded when it is in an active viewer. This value can be changed through the fadeOut option in the creation of the control. By default it is 'NEVER'. This default value can be overrided in derived classes.

Inherited From:
Source:
mapspace/controls/control.js
Returns:
Type
Mapspace.control.FadeOutMode

getTranslation(id)

Returns the translation for a given property ID. The Mapspace.strings object contains pairs of key and values. Each key follows the pattern: globalizationKey#propertyID.

Parameters:
Name Type Description
id string

The property ID.
Inherited From:
Source:
mapspace/controls/control.js
Returns:

The translation or undefined if not found.

Type
string | undefined

hasClassName(className)

Returns if the control has a class name

Parameters:
Name Type Description
className string

The class name.
Inherited From:
Source:
mapspace/controls/control.js

isTool()

Returns true if this control is a tool. A tool is a control that contains one or several options in a list (for example a Mapspace.control.ViewerTools) that are linked to a viewer and only one of them can be active at a time. Tools are usually related to interactions in a way that only one interaction can be active at a time in a viewer.

Inherited From:
Source:
mapspace/controls/control.js
Returns:
Type
boolean

setEnabled(enabled)

Sets the control to enabled or not. When a control is not enabled can be clicked, cannot be dragged, but none of those interactions produce any event.

Parameters:
Name Type Description
enabled boolean

Enabled.
Inherited From:
Source:
mapspace/controls/control.js

setFadeInEnabled(enabled)

Sets if the control can be faded in. By default is true.

Parameters:
Name Type Description
enabled boolean
Inherited From:
Source:
mapspace/controls/control.js

setTarget(target)

This function is used to set a target element for the control.

Parameters:
Name Type Description
target Element | string | Mapspace.Viewer

Target.
Inherited From:
Source:
mapspace/controls/control.js

show(title, message, type, options)

Shows a notification.

Parameters:
Name Type Description
title string

Title or title globalization subkey. At first this param is checked as a globalization subkey and if no value is found then it is used as title. The param is combined with globalizationKey of the control to get the final key to search for. For example, if globalizationKey of the control is 'mapspace-notifier' (the default value), to search for 'mapspace-notifier#overlapping-title' use 'overlapping-title' as param.
message string | undefined

Optional Message or message globalization subkey. At first this param is checked as a globalization subkey and if no value is found then it is used as message. The param is combined with globalizationKey of the control to get the final key to search for. For example, if globalizationKey of the control is 'mapspace-notifier' (the default value), to search for 'mapspace-notifier#overlapping-msg' use 'overlapping-msg'.
type Mapspace.NotificationType | undefined

Type of notification. Default is Mapspace.NotificationType.INFO.
options Mapspace.control.NotificationOptions | undefined

Options for the notification.
Source:
mapspace/controls/notifier.js
Returns:

A number ID identifying the notification.

Type
number

<abstract> unselectTool()

If this control is a tool the unselects the tool.

Inherited From:
Source:
mapspace/controls/control.js

updateByID(id, command, update)

Updates a notification given by its ID. For example:

var c = new Mapspace.control.Notifier({
  target: 'container'
});
var id = c.show('Overlaying...');
c.updateByID(id, {
  title: 'Overlaying at 50%...',
  progress: 50
});
c.updateByID(id, 'progress', 100);
Parameters:
Name Type Description
id string

ID of the notification to update.
command string | Object

One of these: 'type', 'title', 'message', or 'progress' to change any of those attributes of the notification. If an object then keys are names of attributes and update param will be ignored. Title and message attributes can be values or globalization subkeys.
update string | number | undefined

The value.
Source:
mapspace/controls/notifier.js

updateLanguage()

Updates the control for the current language in the Mapspace.Globalization singleton.

Inherited From:
Overrides:
Source:
mapspace/controls/control.js