Mapspace API Reference

Class: WorkspaceManager

Mapspace.control. WorkspaceManager

A control that creates a workspace manager, a control that shows the list of current available workspaces and options to manage them.

new WorkspaceManager( [options])

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

Control options.
Source:
mapspace/controls/workspacemanager.js
Fires:
  • Mapspace.control.event:WorkspaceManagerEvent
  • 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:
Overrides:
Source:
mapspace/controls/control.js

controldefs :Array.<Mapspace.ControlDefinition>

Array of control definitions this control contains.

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

definition :Mapspace.WorkspaceOptions

Object that stores the definition of selected workspace in the listbox.

Source:
mapspace/controls/workspacemanager.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

selectedWorkspaceName :string

Name of selected workspace in listbox.

Source:
mapspace/controls/workspacemanager.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

addWorkspace(name, date)

Adds a workspace to the list of workspaces.

Parameters:
Name Type Description
name string

Name of the workspace.
date string

Date of last modification.
Source:
mapspace/controls/workspacemanager.js

clearControl()

Clears all the HTML elements under the control element and clear listeners.

Source:
mapspace/controls/workspacemanager.js

clearProjections()

Clear the list of projections.

Source:
mapspace/controls/workspacemanager.js

clearWorkspaces()

Clear the list of workspaces.

Source:
mapspace/controls/workspacemanager.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

containsWorkspace()

Returns a boolean to indicate if a workspace name already is in the current list.

Source:
mapspace/controls/workspacemanager.js
Returns:
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

getBaselayersForViewer(index)

Returns the baselayers checked for the current selected workspace and the given viewer.

Parameters:
Name Type Description
index number

Viewer index.
Source:
mapspace/controls/workspacemanager.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

getOverlaysForViewer(index)

Returns the overlays checked for the current selected workspace and the given viewer.

Parameters:
Name Type Description
index number

Viewer index.
Source:
mapspace/controls/workspacemanager.js

getProjections()

Gets the list of projections.

Source:
mapspace/controls/workspacemanager.js
Returns:
Type
Array.<Mapspace.ProjectionDefinition>

getSelectedProjection()

Returns the selected projection.

Source:
mapspace/controls/workspacemanager.js
Returns:
Type
Mapspace.ProjectionDefinition

getSelectedProjectionIndex()

Returns the index of the current selected projection.

Source:
mapspace/controls/workspacemanager.js
Returns:
Type
number

getSnapshotOptionsForViewer(index)

Returns the snapshot options checked for the current selected workspace and the given viewer.

Parameters:
Name Type Description
index number

Viewer index.
Source:
mapspace/controls/workspacemanager.js

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

getWorkspaceSelected()

Gets the name of workspace that is selected or undefined if none.

Source:
mapspace/controls/workspacemanager.js
Returns:
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

removeWorkspace(name)

Removes a workspace from the list of workspaces.

Parameters:
Name Type Description
name string

Name of the workspace.
Source:
mapspace/controls/workspacemanager.js

selectWorkspace()

Emulates a click in workspace list for current workspace.

Source:
mapspace/controls/workspacemanager.js
Returns:
Type
string | undefined

setCurrentWorkspace(name)

Refreshes the control with the given workspace.

Parameters:
Name Type Description
name Mapspace.Workspace

The current workspace.
Source:
mapspace/controls/workspacemanager.js

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

setSelectedProjectionIndex(index)

Sets the index of current selected projection and fires the appropiate event.

Parameters:
Name Type Description
index number

The index.
Source:
mapspace/controls/workspacemanager.js

setSelectedUnits(units)

Sets the selected units.

Parameters:
Name Type Description
units ol.proj.Units

Units.
Source:
mapspace/controls/workspacemanager.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:
Overrides:
Source:
mapspace/controls/control.js

setWorkspaceSelected(name)

Sets the given workspace as selected in the list, if there is one workspace with the given name. If not, it does not change current selected workspace. This function do not executes a click in the selection.

Parameters:
Name Type Description
name string

Workspace name.
Source:
mapspace/controls/workspacemanager.js

<abstract> unselectTool()

If this control is a tool the unselects the tool.

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

updateControl(element)

Updates the control.

Parameters:
Name Type Description
element HTMLElement

The element of the control.
Source:
mapspace/controls/workspacemanager.js

updateLanguage()

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

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

updateProjections(projections)

Updates the list of projections in the control.

Parameters:
Name Type Description
projections Array.<Mapspace.ProjectionDefinition> | undefined

The list of projections or undefined to refresh with values currently in this.projections.
Source:
mapspace/controls/workspacemanager.js

updateProjectionTooltip(value)

Updates the projection description to tooltip.

Parameters:
Name Type Description
value string

The projection description to show.
Source:
mapspace/controls/workspacemanager.js

updateWorkspace(name, date [, name2])

Updates the date for the given workspace.

Parameters:
Name Type Argument Description
name string

Name of the workspace.
date string

Date of the last modification.
name2 string <optional>

New name of the workspace.
Source:
mapspace/controls/workspacemanager.js