Mapspace API Reference

Namespace: Mapspace

Mapspace

This is the core namespace of the API, containing basic foundation definitions used through the rest of modules. The main clases are the Workspace, that represent a group of viewers related, and the Viewer, the base class for all the viewers.

This namespace contains also other util classes, as the collection classes that add common collection functionality (LruMap, Map, Set, WorkPool, WorkQueue, and WorkTask).

Source:
mapspace/bu.jsdoc

Classes

CameraOverlays
LruMap
LruSet
Map
Set
TaskEvent
TegTile
TileCache
VectorLayersCacheManager
Viewer
Viewer3D
ViewerClickEvent
ViewerLayerEvent
ViewerOverlayEvent
WorkPool
WorkQueue
Workspace
WorkspaceActiveViewerEvent
WorkspaceSyncOptionEvent
WorkTask

Namespaces

action
control
css
format
functions
geocoding
global
html
interaction
language
layer
math
nvdb
oblique
ortho
projection
promises
renderer
services
source
storage
street
street
threed
time
time
util

Members

<static> AddLayerDialog :Mapspace.control.AddLayerDialog

A kind-of singleton instance of Mapspace.control.AddLayerDialog.

Source:
mapspace/controls/addlayerdialog.js

<static> AddLayerDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.AddLayerDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/addlayerdialog.js

<static> ExportDialog :Mapspace.control.ExportDialog

A kind-of singleton instance of Mapspace.control.ExportDialog.

Source:
mapspace/controls/exportdialog.js

<static> ExportDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.ExportDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/exportdialog.js

<static> FeatureManagerDialog :Mapspace.control.FeatureManagerDialog

A kind-of singleton instance of Mapspace.control.FeatureManagerDialog.

Source:
mapspace/controls/featuremanagerdialog.js

<static> FeatureManagerDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.FeatureManagerDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/featuremanagerdialog.js

<static> FilterDialog :Mapspace.control.FilterDialog

A kind-of singleton instance of Mapspace.control.FilterDialog.

Source:
mapspace/controls/filterdialog.js

<static> FilterDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.FilterDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/filterdialog.js

<static> FindObliquesDialog :Mapspace.control.FindObliquesDialog

A kind-of singleton instance of Mapspace.control.FindObliquesDialog.

Source:
mapspace/controls/findobliquesdialog.js

<static> FindObliquesDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.FindObliquesDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/findobliquesdialog.js

<static> Globalization :Mapspace.language.Globalization

A kind-of singleton instance of Mapspace.language.Globalization.

Source:
mapspace/globalization.js

<static> Hammer :Mapspace.interaction.HammerGestures

A singleton instance of Mapspace.interaction.HammerGestures.

Source:
mapspace/interaction/hammergestures.js

<static> ImageProviderDialog :Mapspace.control.ImageProviderDialog

A kind-of singleton instance of Mapspace.control.ImageProviderDialog.

Source:
mapspace/controls/imageproviderdialog.js

<static> ImageProviderDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.ImageProviderDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/imageproviderdialog.js

<static> ImportDialog :Mapspace.control.ImportDialog

A kind-of singleton instance of Mapspace.control.ImportDialog.

Source:
mapspace/controls/importdialog.js

<static> ImportDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.ImportDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/importdialog.js

<static> LiDARSettingsDialog :Mapspace.control.LiDARSettingsDialog

A kind-of singleton instance of Mapspace.control.LiDARSettingsDialog.

Source:
mapspace/controls/lidarsettingsdialog.js

<static> LiDARSettingsDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.LiDARSettingsDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/lidarsettingsdialog.js

<static> PDFReportDialog :Mapspace.control.PDFReportDialog

A kind-of singleton instance of Mapspace.control.PDFReportDialog.

Source:
mapspace/controls/pdfreportdialog.js

<static> PDFReportDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.PDFReportDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/pdfreportdialog.js

<static> ProjectionCache :Mapspace.projection.ProjectionCache

A kind-of singleton instance of Mapspace.projection.ProjectionCache.

Source:
mapspace/projectioncache.js

<static> ProjectionDialog :Mapspace.control.ProjectionDialog

A kind-of singleton instance of Mapspace.control.ProjectionDialog.

Source:
mapspace/controls/projectiondialog.js

<static> ProjectionDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.ProjectionDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/projectiondialog.js

<static> QuickAccess :Mapspace.control.QuickAccess

A kind-of singleton instance of Mapspace.control.QuickAccess.

Source:
mapspace/controls/quickaccess.js

<static> QuickAccessListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.QuickAccess. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/quickaccess.js

<static> ResetPasswordDialog :Mapspace.control.ResetPasswordDialog

A kind-of singleton instance of Mapspace.control.ResetPasswordDialog.

Source:
mapspace/controls/resetpassworddialog.js

<static> ResetPasswordDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.ResetPasswordDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/resetpassworddialog.js

<static> SnappingOptionsDialog :Mapspace.control.SnappingOptionsDialog

A kind-of singleton instance of Mapspace.control.SnappingOptionsDialog.

Source:
mapspace/controls/snappingoptionsdialog.js

<static> SnappingOptionsDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.SnappingOptionsDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/snappingoptionsdialog.js

<static> SourceProxy :Mapspace.source.Proxy

A singleton instance of Mapspace.source.Proxy.

Source:
mapspace/source/sourceproxy.js

<static> strings :Object

The object containing all the strings in the API. Each key in the object is a Mapspace.Languages and each value is an Object containing a globalizationKey as key and a translated string as value.

Source:
mapspace/strings.js

<static> StyleManagerDialog :Mapspace.control.StyleManagerDialog

A kind-of singleton instance of Mapspace.control.StyleManagerDialog.

Source:
mapspace/controls/stylemanagerdialog.js

<static> StyleManagerDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.StyleManagerDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/stylemanagerdialog.js

<static> TimeRangeDialog :Mapspace.control.TimeRangeDialog

A kind-of singleton instance of Mapspace.control.TimeRangeDialog.

Source:
mapspace/controls/timerangedialog.js

<static> TimeRangeDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.TimeRangeDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/timerangedialog.js

<static> ToolsOptions :Mapspace.control.ToolsOptions

A kind-of singleton instance of Mapspace.control.ToolsOptions.

Source:
mapspace/controls/toolsoptions.js

<static> VectorLayersCache :Mapspace.VectorLayersCacheManager

A kind-of singleton instance of Mapspace.VectorLayersCacheManager.

Source:
mapspace/vectorlayerscache.js

<static> ViewerSettingsDialog :Mapspace.control.ViewerSettingsDialog

A kind-of singleton instance of Mapspace.control.ViewerSettingsDialog.

Source:
mapspace/controls/viewersettingsdialog.js

<static> ViewerSettingsDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.ViewerSettingsDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/viewersettingsdialog.js

<static> WellcomeDialog :Mapspace.control.WellcomeDialog

A kind-of singleton instance of Mapspace.control.WellcomeDialog.

Source:
mapspace/controls/wellcomedialog.js

<static> WellcomeDialogListenerKey :ol.EventsKey|boolean

A kind-of singleton instance that stores the ol.EventsKey with the handler for Mapspace.WellcomeDialog. As the dialog is also a singleton, this listener key must be reset each time the dialog is used.

Source:
mapspace/controls/wellcomedialog.js

Methods

<static> AddressInfoEvent(type, address, copyAddress, htmlAddress, geocodingType [, coordinate])

Parameters:
Name Type Argument Description
type Mapspace.ViewerEventType | Mapspace.control.AddressInfoEventType

Type of event.
address string

The address information.
copyAddress string

The address information formatted to be copied to clipboard.
htmlAddress string

The address information formatted as HTML content.
geocodingType Mapspace.GecodingType

Type of geocoding action.
coordinate Mapspace.Coordinate <optional>

An optional coordinate (in local projection) used to overlay a point icon in any viewer. Projection of the coordinate is different for each type of viewer:

  • Ortho viewer or Global viewer in ortho mode: Mercator Spheric
  • Oblique viewer or Global viewer in oblique mode: local projection of the oblique
  • Street viewer: local projection of the image
  • 3D viewer: lonlat
Source:
mapspace/events.js

<static> setDebugMode(mode)

Modifies debug mode.

Parameters:
Name Type Argument Description
mode number <nullable>

Mode.
Source:
mapspace/index.js

Type Definitions

AnnotationType

Type of annotations.

Name Value Description
Mapspace.AnnotationType.TEXT text Text.
Mapspace.AnnotationType.POINT point Point.
Mapspace.AnnotationType.POLYLINE polyline Polyline.
Mapspace.AnnotationType.POLYGON polygon Polygon.
Source:
mapspace/enums.js

AppFeaturesNames

Names of the different features contained in the Mapspace client app.

Name Value
Mapspace.AppFeaturesNames.BASELAYERTYPESWITCHER BaselayerTypeSwitcher
Mapspace.AppFeaturesNames.BRIGHTNESS Brightness
Mapspace.AppFeaturesNames.CONTRAST Contrast
Mapspace.AppFeaturesNames.DEBUGMODE DebugMode
Mapspace.AppFeaturesNames.DEBUGGRID DebugGrid
Mapspace.AppFeaturesNames.DEPTHMAP DepthMap
Mapspace.AppFeaturesNames.DOCINFO DocInfo
Mapspace.AppFeaturesNames.DTM Dtm
Mapspace.AppFeaturesNames.FEATUREINFO FeatureInfo
Mapspace.AppFeaturesNames.FEATURES Features
Mapspace.AppFeaturesNames.LAYERSWITCHERADDLOCALFILE LayerSwitcherAddLocalFile
Mapspace.AppFeaturesNames.LAYERSWITCHERZOOMEXTENT LayerSwitcherZoomExtent
Mapspace.AppFeaturesNames.LIDARPOINTSIZE LiDARPointSize
Mapspace.AppFeaturesNames.MEASUREMENT Measurement
Mapspace.AppFeaturesNames.NORTH North
Mapspace.AppFeaturesNames.OPENSTREETIMAGE OpenStreetImage
Mapspace.AppFeaturesNames.PROFILE3D Profile3d
Mapspace.AppFeaturesNames.SCALELINE ScaleLine
Mapspace.AppFeaturesNames.SCREENSHOT ScreenShot
Mapspace.AppFeaturesNames.SEARCH Search
Mapspace.AppFeaturesNames.SPINNER Spinner
Mapspace.AppFeaturesNames.SYNCMANAGER SyncManager
Mapspace.AppFeaturesNames.TIMESELECT TimeSelect
Mapspace.AppFeaturesNames.USERPLACE UserPlace
Mapspace.AppFeaturesNames.VIEWERINFO ViewerInfo
Mapspace.AppFeaturesNames.VIEWERINFOIMAGE ViewerInfoImage
Mapspace.AppFeaturesNames.VIEWERINFOANGLES ViewerInfoAngles
Mapspace.AppFeaturesNames.ZOOM Zoom
Mapspace.AppFeaturesNames.ZOOMSLIDER ZoomSlider
Mapspace.AppFeaturesNames.OBLIQUEDOWNLOAD ObliqueDownload
Mapspace.AppFeaturesNames.ORTHODOWNLOAD OrthoDownload
Source:
mapspace/enums.js

AppFeaturesTypes

Types or categories of features contained in the Mapspace client app.

Name Value Description
Mapspace.AppFeaturesTypes.ORTHO ortho App feature inside a Mapspace.ortho.Viewer or Mapspace.global.Viewer.
Mapspace.AppFeaturesTypes.OBLIQUE oblique App feature inside a Mapspace.oblique.Viewer or Mapspace.global.Viewer.
Mapspace.AppFeaturesTypes.STREET street App feature inside a Mapspace.street.Viewer.
Mapspace.AppFeaturesTypes.THREED threed App feature inside a Mapspace.threed.Viewer.
Mapspace.AppFeaturesTypes.PROFILE3D profile3d App feature inside a Mapspace.profile3d.Viewer.
Mapspace.AppFeatureTypes.TABLE table App feature inside a Mapspace.table.Viewer.
Mapspace.AppFeaturesTypes.GENERIC generic App feature inside any type of viewer or outside any viewer.
Source:
mapspace/enums.js

BaselayerType

Type of the baselayer, one of 'ortho' for ortographic images or 'oblique' for a ortorectified mosaic of oblique images.

Name Value
Mapspace.BaselayerType.ORTHO ortho
Mapspace.BaselayerType.OBLIQUE oblique
Source:
mapspace/enums.js

CameraOrientation

The angles that define the orientation of a camera. The values do not specify a given origin of angles, but usually yaw means angle with the local north and increasing eastward, pitch angle from the local east-north plane (with positive values above the plane), and roll angle about the local east axis.

Properties:
Name Type Description
yaw number

The yaw or heading in radians.
pitch number

The pitch.
roll number

The roll.
Source:
mapspace/typedefs.js

CameraOverlay

Object that stores info to overlay a camera position and rotation from a 3d viewer.

Properties:
Name Type Description
centerOverlay ol.Overlay

Center.
fovOverlay ol.Overlay

FOV angle.
position Mapspace.Coordinate

Position of the lower left corner.
rotation number

Rotation.
scale number

Scale.
visible boolean

If visible or not.
Source:
mapspace/typedefs.js

CameraOverlaysOptions

Options for a Mapspace.CameraOverlays object.

Properties:
Name Type Description
viewer Mapspace.Viewer

The viewer to show panorama overlays.
fovScale number | undefined

An optional scale to apply to FOV icon. By default is 1.0.
Source:
mapspace/typedefs.js

CameraProjection

Type of camera projection in 3D viewers.

Name Value
Mapspace.CameraProjection.ORTHOGRAPHIC orthographic
Mapspace.CameraProjection.PERSPECTIVE perspective
Source:
mapspace/enums.js

ClickButton

Mouse button type.

Name Value
Mapspace.ClickButton.RIGHT right
Mapspace.ClickButton.MIDDLE middle
Mapspace.ClickButton.LEFT left
Mapspace.ClickButton.OTHER other
Source:
mapspace/enums.js

ClickType

Types of clicks with a mouse.

Name Value
Mapspace.ClickType.CLICK click
Mapspace.ClickType.DBLCLICK dblclick
Source:
mapspace/enums.js

ColorConditions

An object that stores colors and conditions to apply those colors.

Properties:
Name Type Description
renderBy Mapspace.LiDARRenderType | undefined

Type of render. By default it is RGBCOLOR.
conditions Array.<?Array> | undefined

Each item in the array is an array of two values, first a boolean indicating if the value is visible and second with color value as a string. For example: [true, 'color("#804000")'] Each item can be also null.
Source:
mapspace/typedefs.js

ColorDefinition

A color definition for both the edge and the fill of a feature.

Properties:
Name Type Description
stroke string

The color of the edge.
fill string

The color for the fill.
Source:
mapspace/typedefs.js

colorsByName

HTML color enumeration

Source:
mapspace/enums.js

ControlDefinition

The minimum setup for a control, composed of one control and an array of actions.

Properties:
Name Type Description
control Mapspace.control.Control

The control of the control definition.
actions Array.<Mapspace.action.Action>

The actions of the control definition.
Source:
mapspace/typedefs.js

Coordinate

An array of any number of numbers representing an xy, xyz or zyzm coordinate. Example: [16, 48], [20.50, 47.60, 1225.0], [15, 60.5, 150.6, 12].

First number is always interpreted as X coordinate or longitude, second as Y or latitude, third, if exists, as Z, and fourth, if exists, as M. Fifth and following numbers are ignored because usually they do not have meaning in geographic apps.

The reference system is not provided in it, and must be known or stored in and appropiate class object.

Source:
mapspace/typedefs.js

CoplanarityType

Types of coplanarities that an array of coordinates may have.

Name Value Description
Mapspace.CoplanarityType.NONE none The points are not coplanar
Mapspace.CoplanarityType.VERTICAL vertical The points are in the vertical plane defined by the first two not-vertically overlapped points
Mapspace.CoplanarityType.HORIZONTAL horizontal The points are in the horizontal plane defined by the third value (height) of the first coordinate
Mapspace.CoplanarityType.ANY any The points are coplanar in any plane
Source:
mapspace/enums.js

DatesDefinition

Properties:
Name Type Description
layerName string

Name of the layers.
dataType string

Type of data.
dataSet string

Name of dataset.
year string

Year of the data.
Source:
mapspace/typedefs.js

DefaultSyncTypesForViewType

Default sync values for each viewer type.

  • Mapspace.DefaultSyncTypesForViewType.ORTHO: an object with default sync types for Mapspace.ortho.Viewer viewers.
  • Mapspace.DefaultSyncTypesForViewType.OBLIQUE: an object with default sync types for Mapspace.oblique.Viewer viewers.
  • Mapspace.DefaultSyncTypesForViewType.STREET: an object with default sync types for Mapspace.street.Viewer viewers.
  • Mapspace.DefaultSyncTypesForViewType.THREED: an object with default sync types for Mapspace.threed.Viewer viewers.
  • Mapspace.DefaultSyncTypesForViewType.GLOBAL: an object with default sync types for Mapspace.global.Viewer viewers.
  • Mapspace.DefaultSyncTypesForViewType.PROFILE3D: an object with default sync types for Mapspace.profile3d.Viewer viewers.
  • Mapspace.DefaultSyncTypesForViewType.TABLE: an object with default sync types for Mapspace.table.Viewer viewers.
Source:
mapspace/enums.js

ExportFilterType

Types of filters that can be done in the features when exporting to file.

Name Value
Mapspace.ExportFilterType.FILTER_ALL filterAll
Mapspace.ExportFilterType.FILTER_SELECTED filterSelected
Mapspace.ExportFilterType.FILTER_SAVEDINSTORAGE filterSavedInStorage
Source:
mapspace/enums.js

ExportOptions

The options for executing an export in a layer.

Properties:
Name Type Description
features Array.<ol.Feature> | undefined

Optional features to export. If it is undefined and filterType is FILTER_ALL all features in the layer are exported.
formats Array.<Mapspace.format.ExportFormatNames> | undefined

Optional array of formats to export to. If number of formats is greater than one then a ZIP file will be created containing the outputs. If undefined then default formats are send to output, always creating a ZIP file.
projection string | undefined

Optional output projection as a 'EPSG:XXX' code. If undefined default 'EPSG:4326' is used.
filename string | undefined

Optional file name (without extension) where store the export. If undefined a default filename is created using current date and time.
filterType Mapspace.ExportFilterType | undefined

Optional filter type to apply (FILTER_ALL or FILTER_SELECTED). If FILTER_ALL then the features option is ignored. By default is FILTER_ALL.
ruleIndex number | undefined

Optional rule index to apply as filter in case that the layer has a customStyleCollection and useStyleCollection is true. The rule is applied after the features and filterType options are resolved.
save boolean | undefined

Optional param. If true the file is saved and nothing is returned after exporting. If false the file is not saved and the binary content is returned. By default is true.
Source:
mapspace/typedefs.js

Extent

An array of numbers representing an extent in 2D: [minx, miny, maxx, maxy].

minx and maxx values represent X or longitude coordinates.

miny and maxy values represent Y or latitude coordinates.

The reference system is not provided in it, and must be known or stored in and appropiate class object.

Source:
mapspace/typedefs.js

ExternalProviderFeature

An object containing the information for a feature of an external provider as it is saved in Terratec services for temporary storage.

Properties:
Name Type Description
id string | undefined

The internal ID in Terratec storage service.
provider Mapspace.FeatureProviderStore | undefined

The name of the external provider.
status Mapspace.FeatureProviderStatus | undefined

The status of the feature in the storage service.
action Mapspace.FeatureServerActionType | undefined

The type of action performed in the feature relative to the original feature of the provider.
date string | undefined

Date of the last modification in the storage service in 'yyyy-MM-dd HH:mm:ss' format.
featureId string | undefined

A feature ID stored for the feature.
featureInfo Object | undefined

The object that is the JSON serialization of the feature.
geometry string | undefined

A WKT string representation of the geometry of the feature.
Source:
mapspace/typedefs.js

FeatureActionType

Types of actions that can be done with vector features. ADD means to retrieve a feature from the layer storage and add to the layer. IMPORT means add a feature from another source that is not the one that the layer uses for storage, for example, from a local file.

Name Value
Mapspace.FeatureActionType.SELECT select
Mapspace.FeatureActionType.REMOVE remove
Mapspace.FeatureActionType.MODIFYGEOMETRY modifygeometry
Mapspace.FeatureActionType.MODIFYSTYLE modifystyle
Mapspace.FeatureActionType.MODIFYATTRIBUTES modifyattributes
Mapspace.FeatureActionType.ADDATTRIBUTE addattribute
Mapspace.FeatureActionType.REMOVEATTRIBUTE removeattribute
Mapspace.FeatureActionType.ADD add
Mapspace.FeatureActionType.CREATE create
Mapspace.FeatureActionType.DUPLICATE duplicate
Mapspace.FeatureActionType.RENDER render
Mapspace.FeatureActionType.RESET reset
Mapspace.FeatureActionType.IMPORT import
Source:
mapspace/enums.js

FeatureChange

An object defining a change in a feature.

Properties:
Name Type Description
action Mapspace.FeatureActionType

The type of change. Can be:

  • Mapspace.FeatureActionType.MODIFYGEOMETRY: The geometry of the feature has changed.
  • Mapspace.FeatureActionType.MODIFYATTRIBUTES: One attribute has changed.
  • Mapspace.FeatureActionType.ADDATTRIBUTE: One attribute has been added.
  • Mapspace.FeatureActionType.REMOVEATTRIBUTE: One attribute has been deleted.
attribute string | undefined

The name of the attribute. If the change is in the geometry can be left as undefined.
oldValue string | number | boolean | Object | Array | ol.geom.Geometry

The old value before the change.
newValue string | number | boolean | Object | Array | ol.geom.Geometry

The new value after the change.
Source:
mapspace/typedefs.js

FeatureProvider

Names of different external providers for vector features that can be requested and loaded inside viewers.

Name Value Description
Mapspace.FeatureProvider.NONVDB nonvdb Norwegian NVDB road database
Source:
mapspace/enums.js

FeatureProviderStatus

Type of status of the external provider features.

Name Value
Mapspace.FeatureProviderStatus.EDITING editing
Mapspace.FeatureProviderStatus.NOVALID novalid
Mapspace.FeatureProviderStatus.SETTLING settling
Mapspace.FeatureProviderStatus.SENT sent
Mapspace.FeatureProviderStatus.RECEIVED received
Mapspace.FeatureProviderStatus.APPROVED approved
Mapspace.FeatureProviderStatus.REJECTED rejected
Mapspace.FeatureProviderStatus.CLOSED closed
Source:
mapspace/enums.js

FeatureProviderStore

Names of different external providers for vector features that can use Terratec services to temporarily store features.

Name Value Description
Mapspace.FeatureProviderStore.NONVDBEDITION nonvdbedition Norwegian NVDB road database
Source:
mapspace/enums.js

FeatureServerActionType

Types of actions that can be done with features from external providers when stored in Terratec services.

Name Value
Mapspace.FeatureServerActionType.CREATION creation
Mapspace.FeatureServerActionType.ERASURE erasure
Mapspace.FeatureServerActionType.MODIFICATION modification
Source:
mapspace/enums.js

FeatureTypeResolution

An object defining a minimum resolution for the visibility of a given feature type name. The features of this feature type only will be visible only if viewer resolution is above or equals the resolution property.

Properties:
Name Type Description
resolution number

Minimum resolution for the feature type to be visible.
featureType string

Feature type.
Source:
mapspace/typedefs.js

Filter

The array of conditions with a filter for a vector layer with features. If the filter has limits, they must be the first item in the array and be always an array of limit conditions. So to know if a filter has limits it can be easily checked finding if first item is an array and all its conditions in that first item are limits.

Source:
mapspace/typedefs.js

FilterCondition

An object defining one condition that must be satisfied. The condition is alphanumeric and defines one attribute, one operator, and one value that must be matched in a vector layer.

Properties:
Name Type Description
attribute string

The attribute. It could a name or an ID, anything that uniquely identifies the attribute.
operator string

The operator. Usual operators are =, !=, >, <,

= and <=.
value string | number | boolean

The value.
union Mapspace.FilterConditionUnionType | undefined

AND or OR. Inside an array of conditions, the first item in the array can have this value omitted.
limit boolean | undefined

If the condition must be considered a limit or not. By default is undefined, that means it is not a limit. A limit is any condition that do not refers to any attributes, but to a spatial condition or boundary that must be satisfied. Limit conditions are always concatenated with AND and union value is ignored in them.
Source:
mapspace/typedefs.js

FilterConditionUnionType

Types of logical union between Mapspace.FilterCondition inside an array of them.

Name Value
Mapspace.FilterConditionUnionType.AND AND
Mapspace.FilterConditionUnionType.OR OR
Source:
mapspace/enums.js

GeocodingType

Types of geocoding actions.

Name Value
Mapspace.GeocodingType.ADDRESS_SEARCH address_search
Mapspace.GeocodingType.REVERSE_GEOCODING reverse_geocoding
Mapspace.GeocodingType.NVDB_ROAD nvdb_road
Source:
mapspace/enums.js

GeometryFormatFunction()

Any function that receives a ol.geom.Geometry and a ol.proj.Units as params and returns a formatted string representation of the geometry.

Source:
mapspace/typedefs.js

GlobalizationEventType

Type of events for a Mapspace.Globalization singleton.

Name Value
Mapspace.GlobalizationEventType.LANGUAGECHANGED change:language
Source:
mapspace/enums.js

GlobalizationProperty

Properties of a Mapspace.language.Globalization that are tracked.

Name Value
Mapspace.GlobalizationProperty.LANGUAGE language
Source:
mapspace/enums.js

HeightReference

Different types of visualizing Z values in 3D viewers. This do not affects the real Z values in the geometries, that remain unchanged.

Name Value Description
Mapspace.HeightReference.NONE 0 Uses Z values as absolute values.
Mapspace.HeightReference.CLAMP_TO_GROUND 1 Ignore Z values and clamp to ground.
Mapspace.HeightReference.RELATIVE_TO_GROUND 2 Uses Z values as relative to ground.
Mapspace.HeightReference.RAISED_1 100 Raises Z values 1 m.
Mapspace.HeightReference.RAISED_2 200 Raises Z values 2 m.
Mapspace.HeightReference.RAISED_5 500 Raises Z values 5 m.
Mapspace.HeightReference.RAISED_10 1000 Raises Z values 10 m.
Mapspace.HeightReference.RAISED_20 2000 Raises Z values 20 m.
Mapspace.HeightReference.RAISED_50 5000 Raises Z values 50 m.
Mapspace.HeightReference.RAISED_100 10000 Raises Z values 100 m.
Source:
mapspace/enums.js

InteractiveToolNames

Names of tools that are interactive and require extra actions in the viewer after clicking on them.

Name Value
Mapspace.InteractiveToolNames.ANNOTATIONS_HORIZONTALPOLYGON drawhorizontalpolygon
Mapspace.InteractiveToolNames.ANNOTATIONS_POINT drawpoint
Mapspace.InteractiveToolNames.ANNOTATIONS_POLYLINE drawpolyline
Mapspace.InteractiveToolNames.ANNOTATIONS_POLYGON drawpolygon
Mapspace.InteractiveToolNames.ANNOTATIONS_TEXT drawtext
Mapspace.InteractiveToolNames.ANNOTATIONS_VERTICALPOLYGON drawverticalpolygon
Mapspace.InteractiveToolNames.FEATURES_EDIT_LINEAR_REFERENCE features_edit_linear_reference
Mapspace.InteractiveToolNames.FEATURES_EDIT_POINT_REFERENCE features_edit_point_reference
Mapspace.InteractiveToolNames.FEATURES_EDIT_RELATION features_edit_relation
Mapspace.InteractiveToolNames.FEATURES_CREATE features_create
Mapspace.InteractiveToolNames.FEATURES_CREATE_POINT features_create_point
Mapspace.InteractiveToolNames.FEATURES_CREATE_POLYLINE features_create_polyline
Mapspace.InteractiveToolNames.FEATURES_CREATE_POLYGON features_create_polygon
Mapspace.InteractiveToolNames.FEATURES_INFO features_info
Mapspace.InteractiveToolNames.FEATURES_MODIFYGEOMETRY features_modifygeometry
Mapspace.InteractiveToolNames.FEATURES_MODIFYGEOMETRYVERTICAL features_modifygeometryvertical
Mapspace.InteractiveToolNames.FEATURES_QUERY_POINT_REFERENCE features_query_point_reference
Mapspace.InteractiveToolNames.FEATURES_REDEFINE_SELECT features_redefine_select
Mapspace.InteractiveToolNames.FEATURES_SELECTBYCLICK features_selectbyclick
Mapspace.InteractiveToolNames.FEATURES_SELECTBYGEOM features_selectbygeom
Mapspace.InteractiveToolNames.FEATURES_SPLIT_POLYLINE_AT_POINT features_split_polyline_at_point
Mapspace.InteractiveToolNames.MEASUREMENTS_AREA measurearea
Mapspace.InteractiveToolNames.MEASUREMENTS_BEARING measurebearing
Mapspace.InteractiveToolNames.MEASUREMENTS_DIAGONAL_LENGTH measurediagonal_length
Mapspace.InteractiveToolNames.MEASUREMENTS_ELEVATION measureelevation
Mapspace.InteractiveToolNames.MEASUREMENTS_HEIGHT measureheight
Mapspace.InteractiveToolNames.MEASUREMENTS_GROUND_LENGTH measureground_length
Mapspace.InteractiveToolNames.MEASUREMENTS_GROUND_POLYLENGTH measureground_polylength
Mapspace.InteractiveToolNames.MEASUREMENTS_LENGTH measurelength
Mapspace.InteractiveToolNames.MEASUREMENTS_POINT measurepoint
Mapspace.InteractiveToolNames.MEASUREMENTS_POLYLENGTH measurepolylength
Mapspace.InteractiveToolNames.MEASUREMENTS_VERTICAL_AREA measurevertical_area
Mapspace.InteractiveToolNames.OPENSTREET openstreet
Mapspace.InteractiveToolNames.ORBIT orbit
Mapspace.InteractiveToolNames.ORTHODOWNLOAD orthodownload
Mapspace.InteractiveToolNames.REVERSEGEOCODING reversegeocoding
Mapspace.InteractiveToolNames.PROFILE3D_DEFINITION profile3d_definition
Mapspace.InteractiveToolNames.PROFILE3D_CLEAR 'profile3d_clear'
Source:
mapspace/enums.js

Languages

Languages codes.

Name Value Description
Mapspace.Languages.EN en English
Mapspace.Languages.EN_GB en-GB English (GB)
Mapspace.Languages.ES es Spanish
Mapspace.Languages.ES_ES es-ES Spanish (ES)
Mapspace.Languages.NO no Norwegian
Mapspace.Languages.NO_NO no-NO Norwegian (NO)
Mapspace.Languages.FI fi Finnish
Mapspace.Languages.FI_FI fi-FI Finnish (FI)
Mapspace.Languages.SV sv Swedish
Mapspace.Languages.SV_SV sv-SV Swedish (SV)
Source:
mapspace/enums.js

LayerCounts

Object that stores the number of features in a vector layer.

Properties:
Name Type Description
total number | undefined | null

Total number of features in the layer if all features in the layer are loaded without taking filters into account.
filtered number | undefined | null

Total number of features in the layer if all features in the layer are loaded taking filters into account.
measured number | undefined | null

Total measure for features in the layer if all features in the layer are loaded without taking filters into account. For points is the total number of features, for lines the total length and for polygons the total area. This value is only provided for WFS layers.
geometryType ol.geom.GeometryType | undefined | null

Main gemetry type of the layer.
rulesTotal Array.<number> | undefined | null

Total number of features per each style rule in the layer if all features in the layer are loaded without taking filters into account.
rulesFiltered Array.<number> | undefined | null

Total number of features per each style rule in the layer if all features in the layer are loaded taking filters into account.
filter string

Filter render. If no filter is used then an empty string.
Source:
mapspace/typedefs.js

LayerFilterFunctionType

Type of function to apply for filter information of a layer.

Name Value Description
Mapspace.LayerFilterFunctionType.ALLLAYERS alllayers The function will include all layers.
Mapspace.LayerFilterFunctionType.ALLVECTOR allvector The function will include all vector layers.
Mapspace.LayerFilterFunctionType.ALLVECTOREXCEPTPANORAMAS allvectorexceptpanoramas The function will include all vector layers except the Panoramas layer
Mapspace.LayerFilterFunctionType.ALLVECTOREXCEPTPANORAMASPOINTSLINES allvectorexceptpanoramaspointslines The function will include all vector layers, but for a Panoramas layer it will include only polygons.
Source:
mapspace/enums.js

LayerGroup

Object that stores the definition of a layer group. A layer group is the definition of a group of vector layers defined in a tree hierachy. It can contain both vector layers and sublayer groups.

Properties:
Name Type Description
id number

Layer group ID.
name string

Layer group name. This value is unique per client.
type Mapspace.LayerGroupItemType

This value must be always group.
level number | undefined

Layer group level.
path string | undefined

Layer group path. Contains the concatenation of layer group IDs separated by /.
creationDate string

Date of creation.
modificationDate string | undefined

Date of last change.
content Array.<(Mapspace.LayerGroupLayer|Mapspace.LayerGroup)>

Layer group content.
Source:
mapspace/typedefs.js

LayerGroupItemType

Types of items in a layer group.

Name Value
Mapspace.LayerGroupItemType.GROUP group
Mapspace.LayerGroupItemType.LAYER layer
Source:
mapspace/enums.js

LayerGroupLayer

Object that stores the definition of a layer inside a layer group. A layer group is the definition of a group of vector layers defined in a tree hierachy. It can contain both vector layers and sublayer groups.

Properties:
Name Type Description
id number

Layer ID.
name string

Layer name. This value is unique per client.
type Mapspace.LayerGroupItemType

This value must be always layer.
level number | undefined

Layer level.
creationDate string

Date of creation.
modificationDate string | undefined

Date of last change.
status Mapspace.TaskStatus

Layer status.
Source:
mapspace/typedefs.js

LayerType

Types of layers in a Mapspace.control.LayerSwitcher.

Name Value Description
Mapspace.LayerType.DEFAULT default Any usual layer
Mapspace.LayerType.GROUP group A group layer
Mapspace.LayerType.LIDARPROJECT lidarproject A LiDAR project (only one visible at a time)
Mapspace.LayerType.TERRAIN terrain A DTM (only one visible at a time)
Mapspace.LayerType.MESHPROJECT meshproject A 3D Mesh layer (only one visible at a time). If a LiDAR project has a DTM then it will be used as terrain when viewed.
Mapspace.LayerType.TILEDIMAGE tiledimage A tiled image
Source:
mapspace/enums.js

Layout

A collection of Mapspace.LayoutView with a name.

Properties:
Name Type Description
name string | undefined

The name of the layout.
views Array.<Mapspace.LayoutView> | undefined

The array of views of the layout.
Source:
mapspace/typedefs.js

LayoutDefinition

An object that describes a Mapspace.Layout with a minimum information. Each item in the array represents one column and each item inside each column one Mapspace.LayoutView of a given type of viewer.

For example: [[Mapspace.ViewType.ORTHO],[Mapspace.ViewType.OBLIQUE]] is the layout definition for a layout containing two columns, an ortho viewer in first column and an oblique viewer in the second.

Source:
mapspace/typedefs.js

LayoutPreset

A definition for the the visibility of views inside a Mapspace.Layout.

Properties:
Name Type Description
name string

The name of the preset.
visibilities Array.<boolean>

The array of visibility for each view in the layout.
Source:
mapspace/typedefs.js

LayoutView

Each of the views that compose a Mapspace.Layout column is the column in which the view lays. If two views must be in the same column then the value is the same.

Properties:
Name Type Description
column number

The column for the view. First column is zero.
viewer Mapspace.Viewer

The viewer for the view.
controls Array.<Mapspace.ControlDefinition> | undefined

An optional array of Mapspace.ControlDefinition that will be attached to the viewer.
syncOptions Array.<Mapspace.SyncProperties> | undefined

An optional array of Mapspace.SyncProperties with the syncing properties of the current viewer with respect to other viewers.
Source:
mapspace/typedefs.js

LiDARClassificationValue

A value that a LiDAR classification can have and the default color associated.

Properties:
Name Type Description
class_value number

The value. An integer from 0 to 255.
class_name string

The name of the class.
class_color string

Default color in hexadecimal, six characters without prefixing with '#'.
Source:
mapspace/typedefs.js

LiDARProjectMetadata

Mapspace LiDAR project metadata.

Properties:
Name Type Description
name string | undefined

Name of the project.
init_date string | undefined

Initial date.
end_date string | undefined

End date.
code string | undefined

Code of the project.
longitude number | undefined

Longitude of center of the project in WGS84 decimal degrees.
latitude number | undefined

Latitude of center of the project in WGS84 decimal degrees.
elevation number | undefined

Elevation of center of the project in meters.
layer string | undefined

Name of the Mapspace layer.
bbox string

The mandatory extent of the project as a WKT polygon or four values with coordinates in LonLat WGS84.
copyright string | undefined

The copyright of the project.
dtm3dlayer string | undefined

The name of the DTM for the project.
colorproperties Array.<Mapspace.LiDARProjectsInfoTypes>

Array of different types of informations the project contains.
classification Array.<Mapspace.LiDARClassificationValue> | undefined

The available classification, if any, for the project.
Source:
mapspace/typedefs.js

LiDARProjectsFeatureTypeNames

Typenames of feature classes in a LiDAR projects WFS layer.

Name Value Description
Mapspace.LiDARProjectsFeatureTypeNames.PROJECT lidarproject This feature type name corresponds in Mapspace WFS services to polygons.
Mapspace.LiDARProjectsFeatureTypeNames.BLOCK lidarblock This feature type name corresponds in Mapspace WFS services to polygons.
Source:
mapspace/enums.js

LiDARProjectsInfoTypes

Type of information that a LiDAR project stores.

Name Value Description
Mapspace.LiDARProjectsInfoTypes.RGB RGB RGB colors
Mapspace.LiDARProjectsInfoTypes.INTENSITY INTENSITY RGB colors meaning intensities
Mapspace.LiDARProjectsInfoTypes.HEIGHT HEIGHT RGB colors meaning heights
Mapspace.LiDARProjectsInfoTypes.CLASSIFICATION CLASSIFICATION Classification using batch table
Mapspace.LiDARProjectsInfoTypes.UNKNOWN UNKNOWN Information unknown
Source:
mapspace/enums.js

LiDARRenderType

Types of render for a LiDAR project.

Name Value Description
Mapspace.LiDARRenderType.RGBCOLOR RGB Color all points are rendered using their own colors.
Mapspace.LiDARRenderType.CLASSIFICATION Classification each point is rendered using the classification table of colors.
Source:
mapspace/enums.js

MAPSPACEBaseLayer

Ortho WMTS baselayer names. This names match WMTS GetCapabilities names and must not change or some actions will not work properly. The layer with ortho images is expected to have some properties that seamless oblique layers do not have.

Name Value
Mapspace.MAPSPACEBaseLayer.ORTHO Mapspace:ORTHO
Mapspace.MAPSPACEBaseLayer.NORTH Mapspace:NORTH
Mapspace.MAPSPACEBaseLayer.SOUTH Mapspace:SOUTH
Mapspace.MAPSPACEBaseLayer.EAST Mapspace:EAST
Mapspace.MAPSPACEBaseLayer.WEST Mapspace:WEST
Source:
mapspace/enums.js

MAPSPACEBaseLayerType

Type of the baselayer, one of 'ortho' for ortographic images or 'oblique' for a ortorectified mosaic of oblique images.

Name Value
Mapspace.MAPSPACEBaseLayerType.ORTHO ortho
Mapspace.MAPSPACEBaseLayerType.OBLIQUE oblique
Source:
mapspace/enums.js

MaterialDefinition

A collection of rules on how a ol.geom.Geometry and a ol.style.Style must be converted to a THREE.Object3D and a THREE.Material inside a Mapspace.street.Viewer or must be converted to a Cesium.Entity inside a Mapspace.threed.Viewer. Stores several materials to apply as the material depending on the type of geometry and also some options to set the type of Object3D to create.

Properties:
Name Type Description
points THREE.PointsMaterial | Mapspace.cesium.PointMaterial | undefined

A material to use with points. Points will be rendered as plane squares facing the camera in Street viewers and as circles facing the camera in 3D viewers. This property only will be used if points2DEdge, points2DFill and points3D are not defined.
points2DEdge THREE.MeshBasicMaterial | undefined

A material to use with points. Points will be rendered as 2D icons with a fixed orientation. This material is used for the edge of the icon. This property takes precedence over points property.
points2DFill THREE.MeshBasicMaterial | undefined

A material to use with points. Points will be rendered as 2D icons with a fixed orientation. This material is used for the fill of the icon. This property takes precedence over points property.
points3D THREE.MeshBasicMaterial | undefined

A material to use with points. Points will be rendered as 3D icons with a fixed orientation. This material is used for the fill of the icon. This property takes precedence over points property, points2DEdge and points2DFill.
points3DEdge THREE.MeshBasicMaterial | undefined

A material to use with points. Points will be rendered as 3D icons with a fixed orientation. This material is used for the edge (wireframe) of the icon. This property takes precedence over points property, points2DEdge and points2DFill.
lines THREE.LineMaterial | Mapspace.Cesium.PolylineMaterial | undefined

A material to use with lines or with the edge of polygons.
polygonsFill THREE.MeshBasicMaterial | Mapspace.cesium.PolygonMaterial | undefined

A material to be used for the fill of polygons.
ignoreHoles boolean | undefined

For polygon geometries sets if ignore interior rings for Polygon objects or not. This is because certain formats as Shapefile can give problems reading them. Default is false.
pointType Mapspace.PointIconType | undefined

For point geometries is the type of point icon that must be used. By default is CIRCLE. Be aware that this type of icon will be translated to the final 3D object depending on the point3DStyle. For example, if it is CIRCLE but point3DStyle is POINT then the final 3D object will be a square facing the camera, if point3DStyle is POINT2D then the final 3D object will a circle shape, and if point3DStyle is POINT3D then the final 3D object will be a sphere.

This is the list of the resulting 3D objects that will be created for each point type:

pointType point3DStyle = POINT point3DStyle = POINT2D point3DStyle = POINT3D
CIRCLE Square Circle Sphere
TRIANGLE Square Triangle Tetrahedron
SQUARE Square Square Cube
STAR Square Star Pentagrammic dipyramid
DIAMOND Square Diamond Octaedron
point3DStyle Mapspace.Point3DStyle | undefined

For point geometries sets how points will be converted to 3D objects. If POINT then the point will be converted into a square facing always the camera (billboard). If POINT2D then will be converted to a given shape restricted to the XZ plane. Finally, if POINT3D then will be converted a proper 3D object. By default is POINT.
pointSize number | undefined

For point geometries is size to use. This value is ignored if point3DStyle is POINT. The value must be in the same units as the geometry to convert. By default is 1.0.
visible boolean | undefined

For material definitions created from styles in a Mapspace.StyleCollection this property indicates if a given rule is visible. This property means that any 3D object that needs to use this material definition should be visible or not.
pointHeight Mapspace.HeightReference | undefined

Controls how points are positioned in height.
Source:
mapspace/typedefs.js

MeasurementFormatFunction()

Any function that receives a number of a measurement value and returns a formatted string representation of the measurement or a Mapspace.GeometryFormatFunction. Measurement units always are expected to be in International units: meters for lengths, squared meters for areas, and decimal degrees for angles.

Source:
mapspace/typedefs.js

MeasurementFormatFunction()

Any function that receives a number of a measurement value and returns a formatted string representation of the measurement or a Mapspace.GeometryFormatFunction. Measurement units always are expected to be in International units: meters for lengths, squared meters for areas, and decimal degrees for angles.

Source:
mapspace/typedefs.js

MeasurementStatus

Status of a measurement. This is normally used in Measurements created in a Street viewer.

Name Value Description
Mapspace.MeasurementStatus.VALID VALID This means that the measurement is valid and accurate.
Mapspace.MeasurementStatus.NO_VALID NO VALID This means that the measurement has been created with an aproximated system and is not accurate.
Source:
mapspace/enums.js

MeasurementType

Type of measurements.

Name Value Description
Mapspace.MeasurementType.POINT point Coordinates of a point in current output projection.
* Mapspace.MeasurementType.POINT_STREET_IMAGES point_street_images Coordinates of a point in current output projection obtained using several Street images.
Mapspace.MeasurementType.LENGTH length Straight distance between two points.
Mapspace.MeasurementType.GROUND_LENGTH ground_length Ground distance between two points.
Mapspace.MeasurementType.POLYLENGTH polylength Straight distance between several points.
Mapspace.MeasurementType.GROUND_POLYLENGTH ground_polylength Ground distance between several points.
Mapspace.MeasurementType.ELEVATION elevation Height in meters above sea level.
Mapspace.MeasurementType.AREA area Squared are in metric units.
Mapspace.MeasurementType.HEIGHT height Vertical distance from first point at ground to second point at top.
Mapspace.MeasurementType.VERTICAL_AREA vertical_area Squared area of vertical surface.
Mapspace.MeasurementType.BEARING bearing Angle between north and the line defined by two points, with the angle increasing in clockwise direction and zero at north direction.
Mapspace.MeasurementType.DIAGONAL_LENGTH diagonal_length Distance between a first point and a third point in a set of three points. Points can have same Z or not.
Source:
mapspace/enums.js

Mesh3DProjectMetadata

Mapspace Mesh3D project metadata.

Properties:
Name Type Description
name string | undefined

Name of the project.
init_date string | undefined

Initial date.
end_date string | undefined

End date.
code string | undefined

Code of the project.
longitude number | undefined

Longitude of center of the project in WGS84 decimal degrees.
latitude number | undefined

Latitude of center of the project in WGS84 decimal degrees.
elevation number | undefined

Elevation of center of the project in meters.
layer string | undefined

Name of the Mapspace layer.
bbox string

The mandatory extent of the project as a WKT polygon or four values with coordinates in LonLat WGS84.
copyright string | undefined

The copyright of the project.
dtm3dlayer string | undefined

The name of the DTM for the project.
Source:
mapspace/typedefs.js

Mesh3DProjectsFeatureTypeNames

Typenames of feature classes in a Mesh3D projects WFS layer.

Name Value Description
Mapspace.Mesh3DProjectsFeatureTypeNames.PROJECT mesh3dproject This feature type name corresponds in Mapspace WFS services to polygons.
Source:
mapspace/enums.js

Mesh3DProjectsInfoTypes

Type of information that a Mesh3D project stores.

Name Value Description
Mapspace.Mesh3DProjectsInfoTypes.RGB -32768 RGB colors
Mapspace.Mesh3DProjectsInfoTypes.INTENSITY -32767 RGB colors meaning intensities
Mapspace.Mesh3DProjectsInfoTypes.HEIGHT -32766 RGB colors meaning heights
Mapspace.Mesh3DProjectsInfoTypes.CLASSIFICATION -32765 Classification using batch table
Mapspace.Mesh3DProjectsInfoTypes.COLOR -32764 Plain colors
Mapspace.Mesh3DProjectsInfoTypes.UNKNOWN -32763 Information unknown
Source:
mapspace/enums.js

NotificationType

Type of notifications.

Name Value Description

Mapspace.NotificationType.INFO | info Mapspace.NotificationType.WARNING | warning Mapspace.NotificationType.ERROR | error Mapspace.NotificationType.SUCCESS | success

Source:
mapspace/enums.js

ObjectType

Type of objects when serializing.

Name Value Description
Mapspace.ObjectType.UNDEFINED undefined obj = undefined;
Mapspace.ObjectType.NULL null obj = null
Mapspace.ObjectType.OBJECT object obj = {name: 'John', surname: 'Smith'};
Mapspace.ObjectType.ARRAY array obj = [1, 5, 10];
Mapspace.ObjectType.INSTANCE instance obj = new Mapspace.control.Button(); [inherits from ol.Object] or obj = ol.tilegrid.TileGrid(); [do not inherits]
Mapspace.ObjectType.OTHER other obj = 'This is a string' [any other value]
Source:
mapspace/enums.js

ObliqueMetadata

Oblique image metadata for oblique viewers.

Properties:
Name Type Description
id string | undefined

Image ID.
positionx number | undefined

Coordinate X pixel of the last point that was requested to FindOblique service.
positiony number | undefined

Coordinate Y pixel of the last point that was requested to FindOblique service.
actual boolean | undefined

Actual.
id_dtm string | undefined

ID of DTM.
imagename string | undefined

Image name.
imagepath string | undefined

Image path.
imageext string | undefined

Image file extension.
shotlevel string | undefined

Shot level.
shottype string | undefined

Shot type.
shotorient string | undefined

Shot orientation.
shotdate string | undefined

Shot date.
gsd number | undefined

GSD.
imagerows number | undefined

Height in pixels of the image.
imagecols number | undefined

Width in pixels of the image.
ulx number | undefined

Upper left longitude.
uly number | undefined

Upper left latitude.
urx number | undefined

Upper right longitude.
ury number | undefined

Upper right latitude.
llx number | undefined

Lower left longitude.
lly number | undefined

Lower left latitude.
lrx number | undefined

Lower right longitude.
lry number | undefined

Lower right latitude.
flags number | undefined

Flags.
cameralat number | undefined

Latitude of the camera.
cameralon number | undefined

Longitude of the camera.
direction_yaw number | undefined

Yaw or positive angle in degrees between north and straight direction of the image.
bearing number | undefined

Bearing.
roll number | undefined

Roll.
declin number | undefined

Declination.
alt number | undefined

Altitude.
elevation number | undefined

Elevation.
fpx number | undefined

FPx.
fpy number | undefined

FPy.
focallen number | undefined

Focal length.
k1 number | undefined

K1.
k2 number | undefined

K2.
k3 number | undefined

K3.
ppx number | undefined

PPx.
ppy number | undefined

PPy.
camera string | undefined

Camera.
a1 number | undefined

a1.
a2 number | undefined

a2.
a3 number | undefined

a3.
b1 number | undefined

b1.
b2 number | undefined

b2.
b3 number | undefined

b3.
c1 number | undefined

c1.
c2 number | undefined

c2.
c3 number | undefined

c3.
ai1 number | undefined

ai1.
ai2 number | undefined

ai2.
ai3 number | undefined

ai3.
bi1 number | undefined

bi1.
bi2 number | undefined

bi2.
bi3 number | undefined

bi3.
ci1 number | undefined

ci1.
ci2 number | undefined

ci2.
ci3 number | undefined

ci3.
midpoint_x number | undefined

Midpoint longitude of the image.
midpoint_y number | undefined

Midpoint latitude of the image.
int00 number | undefined

int00.
int01 number | undefined

int01.
int10 number | undefined

int10.
int11 number | undefined

int11.
int20 number | undefined

int20.
int21 number | undefined

int21.
ext0 number | undefined

ext0.
ext1 number | undefined

ext1.
ext2 number | undefined

ext2.
ext3 number | undefined

ext3.
ext4 number | undefined

ext4.
ext5 number | undefined

ext5.
ext6 number | undefined

ext6.
ext7 number | undefined

ext7.
ext8 number | undefined

ext8.
Source:
mapspace/typedefs.js

Orientation

Orientation of the baselayer, one of 'ortho', 'north', 'south', 'east' or 'west'. ortho value has no meaning in oblique or panorama views.

Name Value
Mapspace.Orientation.ORTHO ortho
Mapspace.Orientation.NORTH north
Mapspace.Orientation.SOUTH south
Mapspace.Orientation.EAST east
Mapspace.Orientation.WEST west
Source:
mapspace/enums.js

OverlaysKeysAndNames

Name of availables overlays.

Name Value Description
Mapspace.OverlaysKeysAndNames.TELEATLAS Tele Atlas Teleatlas overlay.
Mapspace.OverlaysKeysAndNames.OPENSTREETMAPS Open Street Maps Open Street Maps overlay.
Source:
mapspace/enums.js

PanoramaMetadata

Panorama image metadata for a Street viewer.

Properties:
Name Type Description
id string | undefined

Image ID.
xcp number | undefined

Image longitude.
ycp number | undefined

Image latitude.
zcp number | undefined

Image elevation in meters from ellipsoid.
source_name string | undefined

Image source name.
shotDate string | undefined

Shot date.
direction_yaw number | undefined

Direction yaw.
tile_size number | undefined

Size of tiles.
zoom_levels number | undefined

Zoom levels.
min_zoom_level_size number | undefined

Number of tiles in first zoom level.
id_set number | undefined

ID of the set this image belong to.
dtmName string | undefined

Name of DTM.
dsmName string | undefined

Name of DSM.
omega number | undefined

Omega.
phi number | undefined

Phi.
kappa number | undefined

Kappa.
ext0 number | undefined

Transformation param ext0.
ext1 number | undefined

Transformation param ext1.
ext2 number | undefined

Transformation param ext2.
ext3 number | undefined

Transformation param ext3.
ext4 number | undefined

Transformation param ext4.
ext5 number | undefined

Transformation param ext5.
ext6 number | undefined

Transformation param ext6.
ext7 number | undefined

Transformation param ext7.
ext8 number | undefined

Transformation param ext8.
local_xcp number | undefined

Coordinate X in local projection.
local_ycp number | undefined

Coordinate Y in local projection.
local_zcp number | undefined

Coordinate Z in local projection.
equi_img_width number | undefined

Width in pixels of the image.
column_center number | undefined

Center pixel of the image.
row_center number | undefined

CEnter row pixel of the image.
pixel_angle number | undefined

Angle per pixel or angular resolution.
srid number | undefined

SRID code of the local projection.
camera_height number | undefined

Camera height from ground.
Source:
mapspace/typedefs.js

Point2D

Properties of a Mapspace.2dPoint that are tracked.

Name Value
Mapspace.Point2D.X x'
Mapspace.Point2D.Y y'
Source:
mapspace/enums.js

Point3D

Properties of a Mapspace.3dPoint that are tracked.

Name Value
Mapspace.Point3D.X x'
Mapspace.Point3D.Y y'
Mapspace.Point3D.Z z'
Source:
mapspace/enums.js

Point3DStyle

How a point is rendered in 3D space.

Name Value Description
Mapspace.Point3DStyle.POINT point' Rendered as a square facing always the camera (billboard)
Mapspace.Point3DStyle.POINT2D point2d' Rendered as a given shape restricted to the XZ plane.
Mapspace.Point3DStyle.POINT3D point3d' Rendered as a proper 3D object
Source:
mapspace/enums.js

PointIconType

Types of icons for points.

Name Value
Mapspace.PointIconType.CIRCLE circle
Mapspace.PointIconType.TRIANGLE triangle
Mapspace.PointIconType.SQUARE square
Mapspace.PointIconType.STAR star
Mapspace.PointIconType.DIAMOND diamond
Source:
mapspace/enums.js

PointSizeConditions

An object that stores point sizes and conditions to apply those sizes.

Properties:
Name Type Description
dynamic boolean | undefined

If true then the conditions apply. If conditions are not defined, then dynamic is ignored and a default size (1) is used. If false then points are rendered with the size defined in pointSize, or a default size (1) if not defined.
conditions Array.<Array> | undefined

Each item in the array is an array of two values, first a string with a condition expression, and second the point size as string. For example: ['${distance} > 100', '1']
pointSize number | undefined

A size for all the points. It only apply if dynamic is false. If dynamic is true then pointSize is ignored.
Source:
mapspace/typedefs.js

Profile3dType

Type of profile.

Name Value Description
Mapspace.Profile3dType.POLYGON polygon Polygon.
Source:
mapspace/enums.js

ProfilesForViewType

Profiles for each view type.

  • Mapspace.ProfilesForViewType.ORTHO: an array with profiles available for Mapspace.ortho.Viewer viewers.
  • Mapspace.ProfilesForViewType.OBLIQUE: an array with profiles available for Mapspace.oblique.Viewer viewers.
  • Mapspace.ProfilesForViewType.STREET: an array with profiles available for Mapspace.street.Viewer viewers.
  • Mapspace.ProfilesForViewType.THREED: an array with profiles available for Mapspace.threed.Viewer viewers.
  • Mapspace.ProfilesForViewType.PROFILE3D: an array with profiles available for Mapspace.profile3d.Viewer viewers.
  • Mapspace.ProfilesForViewType.TABLE: an array with profiles available for Mapspace.table.Viewer viewers.
Source:
mapspace/enums.js

ProfileTypes

ID of the different user profiles defined in the server.

Name Value
Mapspace.ProfileTypes.ORTHO_DATA 1
Mapspace.ProfileTypes.ORTHO_INFO 2
Mapspace.ProfileTypes.ORTHO_ENHANCED 3
Mapspace.ProfileTypes.ORTHO_MEASUREMENT 4
Mapspace.ProfileTypes.OBLIQUE_DATA 5
Mapspace.ProfileTypes.OBLIQUE_INFO 6
Mapspace.ProfileTypes.OBLIQUE_MEASUREMENT 7
Mapspace.ProfileTypes.STREET_DATA 8
Mapspace.ProfileTypes.STREET_INFO 9
Mapspace.ProfileTypes.STREET_MEASUREMENT 10
Mapspace.ProfileTypes.LIDAR_DATA 11
Mapspace.ProfileTypes.LIDAR_INFO 12
Mapspace.ProfileTypes.LIDAR_MEASUREMENT 13
Mapspace.ProfileTypes.V3DCM_DATA 14
Mapspace.ProfileTypes.V3DCM_INFO 15
Mapspace.ProfileTypes.V3DCM_MEASUREMENT 16
Mapspace.ProfileTypes.V3DCM_EDITION 17
Mapspace.ProfileTypes.GEOCODING_FREE 18
Mapspace.ProfileTypes.GEOCODING_PAID 19
Mapspace.ProfileTypes.POIS 20
Mapspace.ProfileTypes.DOC_INFO 21
Mapspace.ProfileTypes.MESH3D_DATA 22
Mapspace.ProfileTypes.MESH3D_INFO 23
Mapspace.ProfileTypes.MESH3D_MEASUREMENT 24
Mapspace.ProfileTypes.OBLIQUE_DOWNLOAD 25
Mapspace.ProfileTypes.WFSLAYER_UPLOAD 26
Mapspace.ProfileTypes.WFSLAYER_DATA 27
Mapspace.ProfileTypes.ORTHO_DOWNLOAD 28
Source:
mapspace/enums.js

ProjectionDefinition

Projection definition.

Properties:
Name Type Description
epsg string

The EPSG code without prefixing with 'EPSG:'.
name string | undefined

The colloquial name of the projection.
proj4 string | undefined

The string defining the projection for PROJ4.
projcs string | undefined

The PROJCS representation of the projection.
Source:
mapspace/typedefs.js

ProjectionInfo

Projection info following GeoJSON specs. This object matches the crs member.

http://wiki.geojson.org/GeoJSON_draft_version_6

Properties:
Name Type Description
type string

Can be 'name' and 'link' as in GeoJSON.
properties Object

If type is name then an object {name: (string)}. If type is link then an object {href: (string), type: (string)} or an object {content: (string), type: (string)}. For content the value can be any PROJ4, OGCWKT or ESRIWKT string directly in the object instead of a href. For type inside properties values should be: 'proj4', 'ogcwkt', 'esriwkt'.
Source:
mapspace/typedefs.js

ProvidersKeysAndNames

Name of diferent geocoding service providers.

Name Value Description
Mapspace.ProvidersKeysAndNames.GEOCODING.UBIEST Ubiest Ubiest geocoding provider.
Mapspace.ProvidersKeysAndNames.GEOCODING.OYM On Your Map On Your Map geocoding provider.
Mapspace.ProvidersKeysAndNames.GEOCODING.OSM Open Street Maps Open Street Maps geocoding provider.
Mapspace.ProvidersKeysAndNames.GEOCODING.TOMTOM TomTom TomTom geocoding provider.
Mapspace.ProvidersKeysAndNames.GEOCODING.NOSEARCH Sok Sok geocoding provider.
Mapspace.ProvidersKeysAndNames.GEOCODING.GOOGLE Google Google geocoding provider.
Mapspace.ProvidersKeysAndNames.GEOCODING.MAPSPACE MAPSPACE Mapspace geocoding provider.

Name of diferent routing service providers.

* Name Value Description
Mapspace.ProvidersKeysAndNames.ROUTING.UBIEST Ubiest Ubiest routing provider.
Mapspace.ProvidersKeysAndNames.ROUTING.OYM On Your Map On Your Map routing provider.
Mapspace.ProvidersKeysAndNames.ROUTING.TOMTOM TomTom TomTom routing provider.
Mapspace.ProvidersKeysAndNames.ROUTING.MAPSPACE MAPSPACE Mapspace routing provider.

Name of diferent map service providers.

Name Value Description
Mapspace.ProvidersKeysAndNames.MAP.UBIEST Ubiest Ubiest map provider.
Mapspace.ProvidersKeysAndNames.MAP.OYM On Your Map On Your Map map provider.
Mapspace.ProvidersKeysAndNames.MAP.OSM Open Street Maps Open Street Maps map provider.
Mapspace.ProvidersKeysAndNames.MAP.TOMTOM TomTom TomTom map provider.
Mapspace.ProvidersKeysAndNames.MAP.MAPSPACE MAPSPACE Mapspace map provider.

Name of diferent pois (point of interest) service providers.

Name Value Description
Mapspace.ProvidersKeysAndNames.POIS.GEOMOBILE Geomobile Geomobile pois provider
Mapspace.ProvidersKeysAndNames.POIS.INFOPORTUGAL Info Portugal Info Portugal pois provider

Name of diferent hosted pois (point of interest) service providers.

Name Value Description
Mapspace.ProvidersKeysAndNames.HOSTED_POIS.GEOMOBILE Geomobile Geomobile pois provider
Mapspace.ProvidersKeysAndNames.HOSTED_POIS.INFOPORTUGAL Info Portugal Info Portugal pois provider

Name of diferent vector query service providers.

Name Value Description
Mapspace.ProvidersKeysAndNames.VECTOR_QUERY.NONVDB Nasjonal vegdatabank Nasjonal vegdatabank vector query provider.

Name of diferent vector edition service providers.

Name Value Description
Mapspace.ProvidersKeysAndNames.VECTOR_EDITION.NONVDB Nasjonal vegdatabank Nasjonal vegdatabank vector edition provider.

Name of diferent vector edition demo service providers.

Name Value Description
Mapspace.ProvidersKeysAndNames.VECTOR_EDITION_DEMO.NONVDB Nasjonal vegdatabank Nasjonal vegdatabank vector edition demo provider.
Source:
mapspace/enums.js

ProvidersTypes

Name of diferent geocoding service providers.

Name Value Description
Mapspace.ProvidersTypes.GEOCODING GEOCODING Geocoding service type.
Mapspace.ProvidersTypes.ROUTING ROUTING Routing service type.
Mapspace.ProvidersTypes.MAP MAP Map service type.
Mapspace.ProvidersTypes.POIS POIS Pois service type.
Mapspace.ProvidersTypes.HOSTED_POIS HOSTED_POIS Hosted Pois service type.
Mapspace.ProvidersTypes.VECTOR_QUERY VECTOR_QUERY Vector query service type (just NVDB for now).
Mapspace.ProvidersTypes.VECTOR_EDITION VECTOR_EDITION Vector edition service type (just NVDB for now).
Mapspace.ProvidersTypes.VECTOR_EDITION_DEMO VECTOR_EDITION_DEMO Vector edition service type (just NVDB for now).
Source:
mapspace/enums.js

RampColor

Definition of a ramp color. Default definitions are in Mapspace.RampColors.

Properties:
Name Type Description
type Mapspace.RampType

Type of ramp.
name string

Name.
color1 string

Color in r,g,b,a format.
color2 string

Color in r,g,b,a format.
discrete boolean

If ramp is only for discrete values.
rampType Mapspace.RampColorType

Type of ramp color.
stops string

Stops list with colors. The format is stop1:stop2:etc. Each stop has a format fraction;r,g,b,a where fraction is [0,1] location of the stop.
Source:
mapspace/typedefs.js

RampColorType

Types of ramp colors. If GRADIENT the colors transitions from one value to the next. If DISCRETE colors break at each stop.

Name Value
Mapspace.RampColorType.GRADIENT gradient
Mapspace.RampColorType.DISCRETE discrete
Source:
mapspace/enums.js

RampType

Types of ramps with colors. If RANDOM the colors in the ramp are generated randomly. If GRADIENT the colors are generated following a color ramp.

Name Value
Mapspace.RampType.RANDOM random
Mapspace.RampType.GRADIENT gradient
Source:
mapspace/enums.js

ResponseFormat

Format used in the response. Possible values are:

Name Value Description
Mapspace.ResponseFormat.TXT txt result are values separated by commas (',').
Mapspace.ResponseFormat.XML xml result is a XML
Mapspace.ResponseFormat.JS js result is a JS function
Source:
mapspace/enums.js

ResponseFormatExtended

Format used in the response, extended version. Possible values are:

Name Value Description
Mapspace.ResponseFormatExtended.TXT txt result are values separated by commas (',').
Mapspace.ResponseFormatExtended.XML xml result is a XML
Mapspace.ResponseFormatExtended.JS js result is a JS function
Mapspace.ResponseFormatExtended.JSON json result is a JSON object
Source:
mapspace/enums.js

SchemaValidationError

An object containing one error found when validating a JSON object using a JSON schema.

Properties:
Name Type Description
instancePath string

Path in the JSON schema.
schemaPath string

Path in the JSON object that represents the JSON schema.
keyword string

Keyword fo the type of error.
params Object

The object that contains information about the restrictions that must apply.
message string

The error message.
Source:
mapspace/typedefs.js

SettingsDefinition

An object containing the definition for one setting of a viewer.

Properties:
Name Type Description
type Mapspace.SettingsType

Type of setting: 'textbox', 'checkbox', 'slider', 'color' or 'number.
name string

Name for the setting. This name is used to access the globalization info: name + 'Label' for a label, name + 'Placeholder' for a placeholder, name + 'InvalidFeedback' for a label in invalid feedback, name + 'ResetLabel' for the reset button in a slider.
initial string | number | boolean | undefined

Initial value. By default is 0.0 for 'slider' and 'number'. Be careful here in 'number' only steps with one decimal value are allowed or the validation will fail.
min number | undefined

Minimum value for 'slider' or 'number' settings. By default is 0.0. Be careful here in 'number' only steps with one decimal value are allowed or the validation will fail.
max number | undefined

Maximum value for 'slider' or 'number' settings. By default is 100.0. Be careful here in 'number' only steps with one decimal value are allowed or the validation will fail.
default number | undefined

Default value for 'slider' settings. By default is 0.0.
step number | undefined

Step for 'slider' and 'number' settings. By default is 1.0. Be careful here in 'number' only steps with one decimal value are allowed or the validation will fail.
required boolean

If setting is required or not to validate the dialog.
visible boolean | undefined

If the setting must be visible or not. By default is true but when permission is not allowed if could be changed to false.
Source:
mapspace/typedefs.js

SettingsType

Types of settings for a viewer.

Name Value
Mapspace.SettingsType.TEXTBOX textbox
Mapspace.SettingsType.CHECKBOX checkbox
Mapspace.SettingsType.SLIDER slider
Mapspace.SettingsType.COLOR color
Mapspace.SettingsType.NUMBER number
Source:
mapspace/enums.js

Size

An array of numbers representing a size: [width, height].

Source:
mapspace/typedefs.js

SnappingOptions

The snapping options of a Mapspace.layer.Vector;

Properties:
Name Type Description
layername string

The name of the layer to snap to.
vertexes boolean

If snap to vertexes or not.
edges boolean

If snap to edges or not.
tolerance number

Tolerance in pixels.
childs number

If the layer has parent/child relationship between objects, this sets the auto-snapping between parent and childs: 0 means no snap; 1 snap to absolute position of the parent; 2 snap to relative position of the parent.
snapz boolean

If auto-snap Z values to terrain when editing. In this case Z values are requested to Terratec services. If not set then Z values present in the geometry are remained unchanged.
Source:
mapspace/typedefs.js

SplitLineStringResult

The result of a LineString split.

Properties:
Name Type Description
lineString1 ol.geom.LineString

First LineString.
lineString2 ol.geom.LineString

Second LineString.
closest Mapspace.Coordinate

Coordinate of closest point to the one given for doing the split.
squaredDistance number

The squared distance between the point given for doing the split and the original LineString.
Source:
mapspace/typedefs.js

StreetProjectMetadata

Mapspace Street project metadata.

Properties:
Name Type Description
code string | undefined

Code of the project.
longitude number | undefined

Longitude WGS84 of the central point of the project.
latitude number | undefined

Latitude WGS84 of the central point of the project.
Source:
mapspace/typedefs.js

StyleCollection

Mapspace object that defines a set rules to apply to a vector layer for styling.

Properties:
Name Type Description
type Mapspace.StyleCollectionType | undefined

Type of styling. If CATEGORIZED then each rule has one value that each feature must match in the selected attribute. If GRADUATED then each rule has a range of numeric values that each feature must match in the selected attribute. By default is CATEGORIZED.
mode Mapspace.ValueClassificationMode | undefined

This value is only needed when type is GRADUATED. In that case if not present by default is EQUAL_INTERVAL.
attribute string

Attribute to use.
attributeType string | undefined

Type of attribute, either string, number, boolean, date or undefined. If undefined means that not all values can be asumed of a given type, and mixed can be found.
rules Array.<Mapspace.StyleRule>

Rules to apply.
Source:
mapspace/typedefs.js

StyleCollectionType

Types of stylings of vector layers when using a collection of styles.

Name Value
Mapspace.StyleCollectionType.CATEGORIZED categorized
Mapspace.StyleCollectionType.GRADUATED graduated
Source:
mapspace/enums.js

StyleRule

Mapspace definition for a rule that must be applied when styling a vector layer.

Properties:
Name Type Description
visible boolean | undefined

If the rule must be applied or not. By default is true.
style ol.style.Style

The style to apply when rule is met.
point3DStyle Mapspace.Point3DStyle

Point 3D style.
pointHeight Mapspace.HeightReference

Point height style.
values Array.<(number|string|boolean)>

Values that define the rule. This allows to define the rule in an easy way. If the array contains one value, then that means the rule is fulfilled if the selected attribute equals the value. If the array contains two values, they should be numbers, and that means the rule is fulfilled if the selected attribute is a number inside and not above the range of pair of numbers. If both are not numbers then they will be treated as Dates if there is a way. If not the Style rule is ignored.
legend string

A descriptive and short text of the rule to be shown in controls.
selected boolean | undefined

Optional value that means that the rule is selected in a list. By default is false.
Source:
mapspace/typedefs.js

SyncCheckStatus

Types of check status for sync options. Only if a sync option is OK is valid.

Name Value
Mapspace.SyncCheckStatus.OK ok
Mapspace.SyncCheckStatus.CENTEROFFSETLOOP centeroffsetloop
Mapspace.SyncCheckStatus.ASYNCVIEWERMULTIPLICITY asyncviewermultiplicity
Source:
mapspace/enums.js

SyncProperties

Syncing properties for a Mapspace.Viewer inside a Mapspace.LayoutView. If a property is undefined then equals false.

Properties:
Name Type Description
syncedViewIndex number

The index of the synced viewer.
center boolean | undefined

The synced viewer will match its center with this viewer. This matches Mapspace.SyncType.CENTER.
centerOffset boolean | undefined

The synced viewer will match any center offset with this viewer. If one of the viewers has a center with two coordinates, then the thrid coordinate is ignored in the sync. This matches Mapspace.SyncType.CENTEROFFSET.
rotation boolean | undefined

The synced viewer will match its rotation with this viewer. This matches Mapspace.SyncType.ROTATION.
resolution boolean | undefined

The synced viewer (never a street viewer) will match its resolution with this viewer. In the case of ortho - oblique synchronization resolution will be synced only when is inside the range of min and max resolutions of the oblique viewer. This matches Mapspace.SyncType.RESOLUTION.
FOV boolean | undefined

The synced viewer (never a street viewer) will show an overlay with the FOV of this viewer (always a street viewer). This matches Mapspace.SyncType.FOV.
streetImageSelected boolean | undefined

If the synced viewer is a street viewer it will try to open a new street image when the viewer with this sync options (never a street viewer) clicks on a street image in a street images layer (if this layer is in the viewer). If the synced viewer is not a street viewer it will show the selected street image in a street images layer (if this layer is in the viewer) that is currently opened in the viewer (always a street viewer) with this sync options. This matches Mapspace.SyncType.STREETIMAGESELECTED.
Source:
mapspace/typedefs.js

SyncType

Types of synchronizations. See the typedef Mapspace.SyncProperties for a detailed explanation.

Name Value
Mapspace.SyncType.CENTER center
Mapspace.SyncType.CENTEROFFSET centerOffset
Mapspace.SyncType.ROTATION rotation
Mapspace.SyncType.RESOLUTION resolution
Mapspace.SyncType.FOV FOV
Mapspace.SyncType.STREETIMAGESELECTED streetImageSelected
Mapspace.SyncType.PITCH pitch
Mapspace.SyncType.PROFILE3DSELECTED profile3dSelected
Source:
mapspace/enums.js

SyncTypesForViewType

Valid sync types for each view type.

Source:
mapspace/enums.js

TaskDownloadInfo

Object that contains information for a download task in Mapspace servers.

Properties:
Name Type Description
format string | undefined

Image format, like jpg.
width number | undefined

Image width in pixels.
height number | undefined

Image height in pixels.
userkey string | undefined

User key.
bgcolor string | undefined

Background color, like 0xFFFFFF.
bbox string | undefined

Bounding box in map coordinates, as a string representation of a Mapspace.Extent.
targetBbox string | undefined

Target bounding box in map coordinates, as a string representation of a Mapspace.Extent.
srs string | undefined

Bounding box projection as a code.
targetSrs string | undefined

Target bounding box projection as a code.
layer string | undefined

Mapspace server layer name.
time string | undefined

Viewer ime obtained with getTime.
name string | undefined

File name.
Source:
mapspace/typedefs.js

TaskInfo

Object that contains information for a given task in Mapspace servers. Depending the type of taks, some data can be present or not in the object.

Properties:
Name Type Description
id number | undefined

ID of the task.
type Mapspace.TaskType | undefined

Type of task.
status Mapspace.TaskStatus | undefined

Status of the task.
startdate string | undefined

Date string of creation of task.
editdate string | undefined

Date string of modification of task.
info Object | undefined

Object with information, mainly the name of the file with extension. This is required for tasks of type WFSLAYER. The name must have less than 64 chars.
layername string | undefined

Layername that the task has created, if any.
Source:
mapspace/typedefs.js

TaskStatus

Status values that a task can have.

Name Value Description
Mapspace.TaskStatus.NEW NEW Task is a new created one.
Mapspace.TaskStatus.UNSUPPORTED UNSUPPORTED Task is currently not supported.
Mapspace.TaskStatus.CANCELED CANCELED Task has been canceled.
Mapspace.TaskStatus.PROCESSING PROCESSING Task is in execution.
Mapspace.TaskStatus.FAILED FAILED Task has failed during creation or execution.
Mapspace.TaskStatus.DONE DONE Task has finished execution successfully.
Mapspace.TaskStatus.DELETED DELETED Task has been removed.
Source:
mapspace/enums.js

TaskStatusIds

Status id values that a task can have.

Name Value Description
Mapspace.TaskStatusIds.NEW -32768 Task is a new created one.
Mapspace.TaskStatusIds.UNSUPPORTED -32767 Task is currently not supported.
Mapspace.TaskStatusIds.CANCELED -32766 Task has been canceled.
Mapspace.TaskStatusIds.PROCESSING -32765 Task is in execution.
Mapspace.TaskStatusIds.FAILED -32764 Task has failed during creation or execution.
Mapspace.TaskStatusIds.DONE -32763 Task has finished execution successfully.
Mapspace.TaskStatusIds.DELETED -32762 Task has been removed.
Source:
mapspace/enums.js

TaskType

Types of tasks that can be executed in Mapspace servers.

Name Value Description
Mapspace.TaskType.DOWNLOADORTHO DOWNLOADORTHO Download of Ortho imagery
Mapspace.TaskType.WFSLAYER WFSLAYER Addition of a new WFS feature type (layer) to user account
Mapspace.TaskType.WFSSTATISTICSUPDATE WFSSTATISTICSUPDATE Update of WFS layer statistics
Source:
mapspace/enums.js

TegTileInfo

Object containing the information for a TEG tile.

Properties:
Name Type Description
id string

ID of tile.
llcoor Mapspace.Coordinate

Lower left coordinate.
ncols number

Number of columns.
nrows number

Number of rows.
minvalue number

Minimum value in tile.
values Array.<number>

Array of values.
bbox Mapspace.Extent

Bounding box.
tegId string

ID of the TEG this tile belongs to.
x_res number

Resolution in X.
y_res number

Resolution in Y.
Source:
mapspace/typedefs.js

TimerEventType

Types of events for a timer.

Name Value Description
Mapspace.TimerEventType.TIMEOUT timeout Triggered when a Timer has entered timeout.
Source:
mapspace/enums.js

ToolDefinition

Default options for a tool.

Properties:
Name Type Description
icon string | undefined

Name of the icon as in Mapspace.html.icons.
cursor string | undefined

It can be a cursor name from web browser, a name of a SVG icon in Mapspace.html.icons or a SVG string.
cursorHotspot string | undefined

It is a string with two numbers separared by a space with the XY ofsset for the cursor, if needed. For example, '12 22'.
pos number | undefined

Position of the tool in several ones.
viewerTypes Array.<Mapspace.ViewType> | undefined

Types of viewers in which this tool will be visible.
permissions Array.<(Mapspace.AppFeaturesTypes|Array.<Mapspace.AppFeaturesTypes>)> | undefined

The array of app feature types that the current user must have for each viewer in viewerTypes. Both viewerTypes and permissions must have the same number of items.
appFeatureName Mapspace.AppFeaturesNames | undefined

The name of the feature that the user must have to allow a permission to see and use the tool.
interactive boolean | undefined

If the tool is interactive and require extra actions in the viewer or not.
visibilityConditions Array.<boolean> | undefined

The array of boolean that indicate for each viewer if the visiblity of the tool depends on extra conditions apart from permissions. The length of the array must be the same that viewerTypes and permissions.
shortcutOnly boolean | undefined

If the tool is only visible in the shortcut buttonbar or not.
stopPropagation boolean | undefined

If the tool must stop propagation of events or not.
enabled Mapspace.control.FeatureButtonEnabledCondition | undefined

Type of condition to show the tool if it is a feature tool. 'some' = any items selected or not; 'selection' = only if any selection; 'one' = only if one selected.
button HTMLElement | undefined

The button element if created. This element is created inside the control that uses this options.
tooltip Mapspace.control.Tooltip | undefined

The tooltip of the button if created. This control is created inside the control that uses this.
menuItems Array.<Mapspace.control.MenuItemOptions> | undefined

An array of menu item options that can be used to show a dropdown menu.
Source:
mapspace/typedefs.js

ToolNames

Names of tools.

Name Value
Mapspace.ToolNames.ANNOTATIONS_CLEAR annotations_clear
Mapspace.ToolNames.ANNOTATIONS_HORIZONTALPOLYGON drawhorizontalpolygon
Mapspace.ToolNames.ANNOTATIONS_POINT drawpoint
Mapspace.ToolNames.ANNOTATIONS_POLYLINE drawpolyline
Mapspace.ToolNames.ANNOTATIONS_POLYGON drawpolygon
Mapspace.ToolNames.ANNOTATIONS_TEXT drawtext
Mapspace.ToolNames.ANNOTATIONS_USE_DEPTHMAP annotations_use_depthmap
Mapspace.ToolNames.ANNOTATIONS_VERTICALPOLYGON drawverticalpolygon
Mapspace.ToolNames.CHANGELAYER changelayer
Mapspace.ToolNames.DEPTHMAP depthmap
Mapspace.ToolNames.DOWNLOADIMAGE downloadimage
Mapspace.ToolNames.FEATURES_ADDATTRIBUTE features_addattribute
Mapspace.ToolNames.FEATURES_EDIT_LINEAR_REFERENCE features_edit_linear_reference
Mapspace.ToolNames.FEATURES_EDIT_POINT_REFERENCE features_edit_point_reference
Mapspace.ToolNames.FEATURES_EDIT_RELATION features_edit_relation
Mapspace.ToolNames.FEATURES_ADDVIEWER_AND_SELECT features_addviewer_and_select
Mapspace.ToolNames.FEATURES_COPYATTRIBUTE features_copyattribute
Mapspace.ToolNames.FEATURES_CREATE features_create
Mapspace.ToolNames.FEATURES_CREATE_POINT features_create_point
Mapspace.ToolNames.FEATURES_CREATE_POLYLINE features_create_polyline
Mapspace.ToolNames.FEATURES_CREATE_POLYGON features_create_polygon
Mapspace.ToolNames.FEATURES_DELETE features_delete
Mapspace.ToolNames.FEATURES_DELETEATTRIBUTE features_deleteattribute
Mapspace.ToolNames.FEATURES_DELETERELATION features_deleterelation
Mapspace.ToolNames.FEATURES_DOWNLOAD features_download
Mapspace.ToolNames.FEATURES_DUPLICATE features_duplicate
Mapspace.ToolNames.FEATURES_EXPORT features_export
Mapspace.ToolNames.FEATURES_FILTER features_filter
Mapspace.ToolNames.FEATURES_FLASH features_flash
Mapspace.ToolNames.FEATURES_INFO features_info
Mapspace.ToolNames.FEATURES_MARKFEATURES features_markfeatures
Mapspace.ToolNames.FEATURES_MARKATTRIBUTES features_markattributes
Mapspace.ToolNames.FEATURES_MODIFYSTYLE features_modifystyle
Mapspace.ToolNames.FEATURES_MODIFYGEOMETRY features_modifygeometry
Mapspace.ToolNames.FEATURES_MODIFYGEOMETRYVERTICAL features_modifygeometryvertical
Mapspace.ToolNames.FEATURES_MODIFYATTRIBUTES features_modifyattributes
Mapspace.ToolNames.FEATURES_PDF_REPORT features_pdf_report
Mapspace.ToolNames.FEATURES_QUERY_POINT_REFERENCE features_query_point_reference
Mapspace.ToolNames.FEATURES_REDEFINE_SELECT features_redefine_select
Mapspace.ToolNames.FEATURES_REDEFINE_ACCEPT_ALL features_redefine_accept_all
Mapspace.ToolNames.FEATURES_REDEFINE_ACCEPT features_redefine_accept
Mapspace.ToolNames.FEATURES_REDEFINE_REJECT_ALL features_redefine_reject_all
Mapspace.ToolNames.FEATURES_REDEFINE_REJECT features_redefine_reject
Mapspace.ToolNames.FEATURES_RESET features_reset
Mapspace.ToolNames.FEATURES_SAVE_ALL_POINT_REFERENCE features_save_all_point_reference
Mapspace.ToolNames.FEATURES_SELECTALL features_selectall
Mapspace.ToolNames.FEATURES_SELECTVISIBLE features_selectvisible
Mapspace.ToolNames.FEATURES_SELECTBYCLICK features_selectbyclick
Mapspace.ToolNames.FEATURES_SELECTBYGEOM features_selectbygeom
Mapspace.ToolNames.FEATURES_SELECTBYATTRIBUTES features_selectbyattributes
Mapspace.ToolNames.FEATURES_SELECTNONE features_selectnone
Mapspace.ToolNames.FEATURES_SHOWLIST features_showlist
Mapspace.ToolNames.FEATURES_SNAPPING features_snapping
Mapspace.ToolNames.FEATURES_SPLIT_POLYLINE_AT_POINT features_split_polyline_at_point
Mapspace.ToolNames.FEATURES_UPLOAD features_upload
Mapspace.ToolNames.FEATURES_ZOOM features_zoom
Mapspace.ToolNames.FEATURES_ZOOMONE features_zoomone
Mapspace.ToolNames.FINDOBLIQUES findobliques
Mapspace.ToolNames.IMAGE_NEXT image_next
Mapspace.ToolNames.IMAGE_PREVIOUS image_previous
Mapspace.ToolNames.IMAGE_PROVIDER image_provider
Mapspace.ToolNames.LAYER_ADD layer_add
Mapspace.ToolNames.LAYER_ADD_TO_SERVER layer_add_to_server
Mapspace.ToolNames.LAYER_ADD_VIEWERS layer_add_viewers
Mapspace.ToolNames.LAYER_ADD_RELATED layer_add_related
Mapspace.ToolNames.LAYER_AUTOHIDE layer_autohide
Mapspace.ToolNames.LAYER_CHANGE_EXPANDED layer_change_expanded
Mapspace.ToolNames.LAYER_CHANGE_VISIBLE layer_change_visible
Mapspace.ToolNames.LAYER_CREATE_GROUP layer_create_group
Mapspace.ToolNames.LAYER_DOWN layer_down
Mapspace.ToolNames.LAYER_EDIT layer_edit
Mapspace.ToolNames.LAYER_IMPORT layer_import
Mapspace.ToolNames.LAYER_EXPORT layer_export
Mapspace.ToolNames.LAYER_FILTER layer_filter
Mapspace.ToolNames.LAYER_REFRESH_SERVER_LIST layer_refresh_server_list
Mapspace.ToolNames.LAYER_REMOVE layer_remove
Mapspace.ToolNames.LAYER_REMOVE_FROM_SERVER layer_remove_from_server
Mapspace.ToolNames.LAYER_RENAME_IN_SERVER layer_rename_in_server
Mapspace.ToolNames.LAYER_STYLE layer_style
Mapspace.ToolNames.LAYER_SWIPE layer_swipe
Mapspace.ToolNames.LAYER_UP layer_up
Mapspace.ToolNames.LAYER_ZOOMEXTENT layer_zoomextent
Mapspace.ToolNames.MEASUREMENTS_AREA measurearea
Mapspace.ToolNames.MEASUREMENTS_BEARING measurebearing
Mapspace.ToolNames.MEASUREMENTS_CLEAR measurements_clear
Mapspace.ToolNames.MEASUREMENTS_DIAGONAL_LENGTH measurediagonal_length
Mapspace.ToolNames.MEASUREMENTS_ELEVATION measureelevation
Mapspace.ToolNames.MEASUREMENTS_HEIGHT measureheight
Mapspace.ToolNames.MEASUREMENTS_GROUND_LENGTH measureground_length
Mapspace.ToolNames.MEASUREMENTS_GROUND_POLYLENGTH measureground_polylength
Mapspace.ToolNames.MEASUREMENTS_LABELS measurements_labels
Mapspace.ToolNames.MEASUREMENTS_LENGTH measurelength
Mapspace.ToolNames.MEASUREMENTS_POINT measurepoint
Mapspace.ToolNames.MEASUREMENTS_POLYLENGTH measurepolylength
Mapspace.ToolNames.MEASUREMENTS_VERTICAL_AREA measurevertical_area
Mapspace.ToolNames.MEASUREMENTS_USE_DEPTHMAP measurements_use_depthmap
Mapspace.ToolNames.NVDB_WORKLIST_SELECT nvdb_worklist_select
Mapspace.ToolNames.NVDB_FILTER_MODIFIED nvdb_filter_modified
Mapspace.ToolNames.NVDB_CATALOG nvdb_catalog
Mapspace.ToolNames.NVDB_MARKFEATURES nvdb_markfeatures
Mapspace.ToolNames.NVDB_VALIDATE nvdb_validate
Mapspace.ToolNames.NVDB_SEND nvdb_send
Mapspace.ToolNames.NVDB_UPDATE_STATUS nvdb_update_status
Mapspace.ToolNames.NVDB_FINISH nvdb_finish
Mapspace.ToolNames.NVDB_COPY_ERRORS nvdb_copy_errors
Mapspace.ToolNames.NVDB_SET_KORRIGER nvdb_set_korriger
Mapspace.ToolNames.NVDB_EDIT_GEOMETRY nvdb_edit_geometry
Mapspace.ToolNames.NVDB_SHOW_VALIDATION nvdb_show_validation
Mapspace.ToolNames.NVDB_SHOW_STATUS nvdb_show_status
Mapspace.ToolNames.NVDB_CLEAR_ALL nvdb_clear_all
Mapspace.ToolNames.OPENSTREET openstreet
Mapspace.ToolNames.ORBIT orbit
Mapspace.ToolNames.ORTHODOWNLOAD orthodownload
Mapspace.ToolNames.PDF_REPORT pdf_report
Mapspace.ToolNames.PROFILE3D_DEFINITION profile3d_definition
Mapspace.ToolNames.PROFILE3D_EDITNAME profile3d_editname
Mapspace.ToolNames.PROFILE3D_CLEAR profile3d_clear
Mapspace.ToolNames.PROFILE3D_CLEAR_ALL profile3d_delete
Mapspace.ToolNames.REVERSEGEOCODING reversegeocoding
Mapspace.ToolNames.SETTINGS settings
Mapspace.ToolNames.SHOWLAYERS showlayers
Mapspace.ToolNames.SHOWTOOLS showtools
Mapspace.ToolNames.SHOWMEASUREMENTTOOLS showmeasurementtools
Mapspace.ToolNames.SHOWANNOTATIONTOOLS showannotationtools
Mapspace.ToolNames.SNAPSHOT snapshot
Mapspace.ToolNames.TIMEFILTER timefilter
Source:
mapspace/enums.js

URLParams

Object that stores the parameters of the URL, converted to a required set of values.

This object is returned by static method Mapspace.util#urlParser. Check it for information of the allowed input parameters.

Properties:
Name Type Description
userkey string | undefined

User key. As this value is mandatory if do not exist then the error property will notify it.
workspace string | undefined

The workspace to be loaded. This is mandatory. If not present, the error property will notify it.
x number | undefined

First coordinate for location. If a 'srs' property exists then the coordinate is in the projection set there, and if not then x is expected to be in 'EPSG:3857'. As this value is mandatory if do not exist then the error property will notify it.
y number | undefined

Second coordinate for location. If a 'srs' property exists then the coordinate is in the projection set there, and if not then y is expected to be in 'EPSG:3857'. As this value is mandatory if do not exist then the error property will notify it.
srs string | undefined

Projection for the x, y coordinates and projection for the output of the viewers. This is an optional param and if not present then x, y values will be expected as 'EPSG:3857', and 'EPSG:3857' will be used for the putput of the viewers. The string must use the pattern 'EPSG:xxx' where xxx is a valid EPSG ID for the projection.
rotation number | undefined

The initial rotation of the view in decimal degrees, where 0 means looking north, 90 looking west and so on. The range of values is [0, 360). This is an optional value and defaults to zero. For oblique viewers if there is a id param then rotation is ignored.
resolution number | undefined

The initial resolution of the view if it supports resolutions in meters per pixel. This is an optional value and defaults to a user value if not present.
viewers Array.<number> | undefined

Optional list of indexes (starting at 1) of visible viewers of the workspace. For example, [1,3] will only show the first and third viewer available in the workspace. If the number of available viewers is below the index, that index will be ignored.
viewmode string | undefined

Optional value, map or oblique. Opens a Map & Oblique viewer in an ortho or oblique mode.
error Array.<string> | undefined

An array of error messages notifying any problem or undefined if all the params are ok.
numParams number

Length of initial params retrieved from URL.
missinguserkey boolean

If the user key is missing or not.
Source:
mapspace/typedefs.js

UserData

User data from its own profile.

Properties:
Name Type Description
layoutId string

Layout ID.
maxAge number

Number of milliseconds for the cache data to live.
obliqueLayers string | undefined

A string with the priority in the search for oblique images.
lidarLayers string | undefined

A string with the priority in the search for LiDAR images.
mes3dLayers string | undefined

A string with the priority in the search for Mesh3D images.
geocodingProvider string

Name of the default geocoding provider.
geocodingProviders Array.<string> | undefined

Array with the list of the geocoding provider names.
routingProvider string

Name of the default routing provider.
routingProviders Array.<string> | undefined

Array with the list of routing provider names.
mapProvider string

Name of the default map overlay provider.
mapProviders Array.<string> | undefined

Array with the list of map overlay providers.
poiProvider string | undefined

Name of the default POI (points of interest) provider.
poiProviders Array.<string> | undefined

Array with the list of POIs providers names.
userToken string

User token of the user.
x number

Default x coordinate for the user. Be aware that this coordinates are always stored in the server in Spherical Mercator projection (EPSG: 3857), so there is a need to reproject this coordinate using ol.proj.toLonLat.
y number

Default y coordinate for the user. Be aware that this coordinates are always stored in the server in Spherical Mercator projection (EPSG: 3857), so there is a need to reproject this coordinate using ol.proj.toLonLat.
client string

Client name of the user.
login string

Login name of the user.
expDate number

Expiration date of the user.
Source:
mapspace/typedefs.js

UserLayer

Definition of a user layer. This is a collection of properties that defines one layer of data from Mapspace servers.

Properties:
Name Type Description
name string

Name of the user layer
description string

User layer description.
daterange Array.<string>

Date range for the user layer. This value is coded with the same pattern that observable variable TIME of viewers. Valid values are any string with pattern YYYYMMDD or with pattern YYYYMMDD-YYYYMMDD. First filters data before the date, and second filters data between the dates.
layer string

A string with the server layer name. Server layers are collections of related data stored in Mapspace servers.
type string

A string with the type of layer: 'WMTS', 'DTM', etc.
format string

A string with the format of the layer: 'Raster', '3D', etc.
overlay boolean | undefined

If the layer can be overlapped on top of others or not. If not present by default is false.
extent string

Extent of the layer as a geometry in WKT format (Polygon) with the coordinates in 'EPSG:4326'.
srid string

A string with the EPSG code.
Source:
mapspace/typedefs.js

UserWorkspaceActions

Ids of user workspace actions.

Name Value
Mapspace.UserWorkspaceActions.MEASUREMENT -32768
Mapspace.UserWorkspaceActions.ANNOTATION -32767
Mapspace.UserWorkspaceActions.EXPORTDATA -32766
Mapspace.UserWorkspaceActions.DOWNLOADING -32765
Mapspace.UserWorkspaceActions.SCREENSHOT -32764
Mapspace.UserWorkspaceActions.CREATEWORKSPACE -32763
Mapspace.UserWorkspaceActions.DELETEWORKSPACE -32762
Mapspace.UserWorkspaceActions.RENAMEWORKSPACE -32761
Mapspace.UserWorkspaceActions.SAVEWORKSPACE -32760
Source:
mapspace/enums.js

ValueClassificationMode

Types of classifications for values in an attribute of features.

Name Value
Mapspace.ValueClassificationMode.EQUAL_INTERVAL equal_interval
Mapspace.ValueClassificationMode.QUANTILE quantile
Mapspace.ValueClassificationMode.NATURAL_BREAKS natural_breaks
Mapspace.ValueClassificationMode.STANDARD_DEVIATION standard_deviation
Mapspace.ValueClassificationMode.PRETTY_BREAKS pretty_breaks
Source:
mapspace/enums.js

ValueClassificationModeNames

Typenames of classifications for values in an attribute of features.

Name Value
Mapspace.ValueClassificationModeNames.EQUAL_INTERVAL Equal Interval
Mapspace.ValueClassificationModeNames.QUANTILE Quantile (Equal Count)
Mapspace.ValueClassificationModeNames.NATURAL_BREAKS Natural Breaks (Jenks)
Mapspace.ValueClassificationModeNames.STANDARD_DEVIATION Standard Deviation
Mapspace.ValueClassificationModeNames.PRETTY_BREAKS Pretty Breaks
Source:
mapspace/enums.js

Viewer3DEventType

Type of events for a Mapspace.Viewer3D.

Name Value Description
Mapspace.Viewer3DEventType.FOVCHANGED fov:change The FOV has changed.
Mapspace.Viewer3DEventType.PITCHCHANGED pitch:change The pitch has changed.
Mapspace.Viewer3DEventType.ROLLCHANGED roll:change The roll has changed.
[DEPRECATED] Mapspace.Viewer3DEventType.LIDARPOINTSIZECHANGED change:lidarpointsize The LiDAR point size has changed.
[DEPRECATED] Mapspace.Viewer3DEventType.DYNAMICLIDARPOINTSIZECHANGED change:dynamiclidarpointsize The dynamic LiDAR point size property has changed.
Mapspace.Viewer3DEventType.GLOBECOLORCHANGED change:globecolor The globe color has changed
Mapspace.Viewer3DEventType.SKYCOLORCHANGED change:skycolor The sky color has changed
Mapspace.Viewer3DEventType.LAYERCHANGED layerchanged Triggered when a Mapspace layer changed
Mapspace.Viewer3DEventType.TERRAINVISIBLECHANGED change:terrainvisible Triggered when terrain visible property changed
Mapspace.Viewer3DEventType.TERRAINOCCLUSIONCHANGED change:terrainocclusion Triggered when terrain occlusion property changed
Mapspace.Viewer3DEventType.AUTOHIDEBASELAYERCHANGED change:autohidebaselayer Triggered when autohidebaselayer property changed
Mapspace.Viewer3DEventType.LIDARPROJECTOPENED lidarprojectopened A LiDAR project has been opened.
Mapspace.Viewer3DEventType.MESH3DPROJECTOPENED mesh3dprojectopened A Mesh 3D project has been opened.
Mapspace.Viewer3DEventType.THREEDDETAILCHANGED change:threeddetail Triggered when detail property changed.
Mapspace.Viewer3DEventType.PROJECTSEXTENTVISIBLEGHANGED change:projectsextentvisible Triggered when visility of projects extent changed.
Mapspace.Viewer3DEventType.OVERLAYCLICKED overlayclicked Triggered when an overlay item in the scene is clicked.
Source:
mapspace/enums.js

Viewer3DProperty

Properties of a Mapspace.Viewer3D.

Name Value Description
Mapspace.3DViewerProperty.FOV fov FOV
Mapspace.3DViewerProperty.PITCH pitch Pitch
Mapspace.3DViewerProperty.ROLL roll Roll
[DEPRECATED] Mapspace.Viewer3DProperty.LIDARPOINTSIZE lidarpointsize LiDAR point size
[DEPRECATED] Mapspace.Viewer3DProperty.DYNAMICLIDARPOINTSIZE dynamiclidarpointsize If LiDAR point size must set automatically based on distance
Mapspace.Viewer3DProperty.GLOBECOLOR globecolor Default color for the globe
Mapspace.Viewer3DProperty.SKYCOLOR skycolor Default color for the sky
Mapspace.Viewer3DProperty.LAYER layer Layer
Mapspace.Viewer3DProperty.TERRAINVISIBLE terrainvisible Show or hide terrain
Mapspace.Viewer3DProperty.TERRAINOCCLUSION terrainocclusion If the terrain must occlude primitives or not
Mapspace.Viewer3DProperty.PROJECTSEXTENTVISIBLE projectsextentvisible Show or hide projects extent
Mapspace.Viewer3DProperty.AUTOHIDEBASELAYER autohidebaselayer If the baselayer must be hidden automatically
Mapspace.Viewer3DProperty.THREEDDETAIL threeddetail Detail level to be loaded for far elements
Source:
mapspace/enums.js

Viewer360DroneTypeNames

Typenames of feature classes in a 360 WFS layer with Mapspace.Viewer360ModelType equal to drone.

Name Value Description
Mapspace.Viewer360DroneTypeNames.DRONE drone This feature type name corresponds in Mapspace WFS services to points.
Mapspace.Viewer360DroneTypeNames.DRONE_PROJECT drone_project This feature type name corresponds in Mapspace WFS services to point centroids.
Source:
mapspace/enums.js

Viewer360IndoorTypeNames

Typenames of feature classes in a 360 WFS layer with Mapspace.Viewer360ModelType equal to indoor.

Name Value Description
Mapspace.Viewer360IndoorTypeNames.INDOOR indoor This feature type name corresponds in Mapspace WFS services to points.
Mapspace.Viewer360IndoorTypeNames.INDOOR_PROJECT indoor_project This feature type name corresponds in Mapspace WFS services to point centroids.
Source:
mapspace/enums.js

Viewer360ModelType

Model types available for a 360 WFS layer.

Name Value Description
Mapspace.Viewer360ModelType.STREET street Model type with generic 360 images taken at Street.
Mapspace.Viewer360ModelType.INDOOR indoor Model type with indoor 360 images taken inside buildings.
Mapspace.Viewer360ModelType.DRONE drone Model type with drone 360 images taken from drones.
Source:
mapspace/enums.js

Viewer360StreetTypeNames

Typenames of feature classes in a 360 WFS layer with Mapspace.Viewer360ModelType equal to street.

Name Value Description
Mapspace.Viewer360StreetTypeNames.STREET panorama This feature type name corresponds in Mapspace WFS services to points.
Mapspace.Viewer360StreetTypeNames.STREET_LINE street_line This feature type name corresponds in Mapspace WFS services to lines.
Mapspace.Viewer360StreetTypeNames.STREET_BUFFER street_buffer This feature type name corresponds in Mapspace WFS services to buffered lines.
Mapspace.Viewer360StreetTypeNames.STREET_PROJECT street_project This feature type name corresponds in Mapspace WFS services to polygons.
Mapspace.Viewer360StreetTypeNames.STREET_PROJECT_CENTROID street_project_centroid This feature type name corresponds in Mapspace WFS services projects centroid.
Source:
mapspace/enums.js

ViewerAnimation

An animation configuration. This type of object is an internal object used by viewers.

Properties:
Name Type Description
sourceCenter Mapspace.Coordinate | undefined

Source center.
targetCenter ol.Coordinate | undefined

Target center.
sourceResolution number | undefined

Source resolution.
targetResolution number | undefined

Target resolution.
sourceRotation number | undefined

Source rotation.
targetRotation number | undefined

Target rotation.
sourcePitch number | undefined

Source pitch.
targetPitch number | undefined

Target pitch.
sourceZoom number | undefined

Source zoom.
targetZoom number | undefined

Target zoom.
anchor ol.Coordinate | undefined

Anchor point for rotations.
start number

Start time.
duration number

Duration in milliseconds. Default is 1000.
complete boolean

If animation is complete or not.
easing function

The easing function used during the animation (defaults to ol.easing.inAndOut). The function will be called for each frame with a number representing a fraction of the animation's duration. The function should return a number between 0 and 1 representing the progress toward the destination state.
callback function | undefined

To call when animation ends.
Source:
mapspace/typedefs.js

ViewerAnimationOption

An animation option. This type of object is the public object used by animate() function of viewers.

Properties:
Name Type Description
center Mapspace.Coordinate | undefined

The center of the viewer at the end of the animation..
resolution number | undefined

The resolution of the viewer at the end of the animation. If Ortho and Oblique viewers if zoom is also provided, this option will be ignored.
zoom number | undefined

The zoom level of the viewer at the end of the animation. In Ortho and Oblique viewers this takes precedence over resolution.
rotation number | undefined

Source rotation. The rotation of the viewer at the end of the animation. When it is zero the viewer has the north in the viewing direction. This rotation rotates the viewer clockwise, so 90.0 means rotate 90.0 degrees clockwise so west is in the viewing direction, and so on. The valid range is [0, 360).
pitch number | undefined

Source pitch in decimal degrees. Valid range is [-90, 90]. When pitch value is 0 the viewer is aligned with horizon, -90 value is the highest angle we can target of the image and 90 is the lowest.
anchor ol.Coordinate | undefined

Anchor point for rotations. Optional anchor to remained fixed during a rotation or resolution animation
duration number | undefined

Duration in milliseconds. Default is 1000.
easing function | undefined

The easing function used during the animation (defaults to ol.easing.inAndOut). The function will be called for each frame with a number representing a fraction of the animation's duration. The function should return a number between 0 and 1 representing the progress toward the destination state.
Source:
mapspace/typedefs.js

ViewerAnimationProperty

Properties of a Mapspace.Viewer that can be animated. Notice that some properties has no sense in certain types of viewers.

Name Value
Mapspace.ViewerAnimationProperty.CENTER center
Mapspace.ViewerAnimationProperty.RESOLUTION resolution
Mapspace.ViewerAnimationProperty.ZOOM zoom
Mapspace.ViewerAnimationProperty.ROTATION rotation
Mapspace.ViewerAnimationProperty.PITCH pitch
Source:
mapspace/enums.js

ViewerEventType

Types of events for a Mapspace.Viewer.

Name Value Description
Mapspace.ViewerEventType.TARGETCHANGED change:target Target changed
Mapspace.ViewerEventType.NAMECHANGED change:name Name changed
Mapspace.ViewerEventType.SIZECHANGED change:size Size changed
Mapspace.ViewerEventType.TIMECHANGED change:time Time filte changed
Mapspace.ViewerEventType.DEBUGMODECHANGED change:debugmode Debug mode changed
Mapspace.ViewerEventType.DEBUGGRIDCHANGED change:debuggrid Debug grid visibility changed
Mapspace.ViewerEventType.CENTERCHANGED change:center Center changed
Mapspace.ViewerEventType.ROTATIONCHANGED change:rotation Rotation changed
Mapspace.ViewerEventType.MAXRESOLUTIONCHANGED change:maxresolution Max. resolution changed
Mapspace.ViewerEventType.MINRESOLUTIONCHANGED change:minresolution Min. resolution changed
Mapspace.ViewerEventType.MAXZOOMCHANGED change:maxzoom Max. zoom changed
Mapspace.ViewerEventType.MINZOOMCHANGED change:minzoom Min.zoom changed
Mapspace.ViewerEventType.RESOLUTIONCHANGED change:resolution Resolution changed
Mapspace.ViewerEventType.RESOLUTIONSCHANGED change:resolutions Resolution list changed
Mapspace.ViewerEventType.ZOOMCHANGED change:zoom Zoom changed
Mapspace.ViewerEventType.LAYERGROUPCHANGED change:layergroup Layer group changed.
Mapspace.ViewerEventType.OUTPUTPROJECTIONCHANGED change:outputprojection Output projection changed
Mapspace.ViewerEventType.UNITSCHANGED change:units Units changed
Mapspace.ViewerEventType.CHANGEDCHANGED change:changed Changed state of viewer changed
Mapspace.ViewerEventType.STATECHANGED change:state Changed the state of the viewer
Mapspace.ViewerEventType.INTERACTEDCHANGED change:interacted The viewer change between interacted or not
Mapspace.ViewerEventType.INTERACTIVETOOLCHANGED change:interactivetool The viewer has changed the tool that is interactive and is currently active
Mapspace.ViewerEventType.ROTATORTYPECHANGED change:rotatorType The Rotator control that viewer must use by default has changed.
Mapspace.ViewerEventType.POSTRENDER postrender Last rendering ended.
Mapspace.ViewerEventType.MOVESTART movestart Viewer starts a change in any property that modifies current view
Mapspace.ViewerEventType.MOVEEND moveend Viewer finalizes the change in any property that modifies current view.
Mapspace.ViewerEventType.METADATALOADED metadataloaded Viewer has received metadata for a content shown in the viewer.
Mapspace.ViewerEventType.TASKSTART taskstart Viewer starts a long taks that requires a message to be shown.
Mapspace.ViewerEventType.TASKPROGRESS taskprogress Viewer continues progress in a long task
Mapspace.ViewerEventType.TASKEND taskend Viewer ends a long task that require to hide a message
Mapspace.ViewerEventType.TASKERROR taskerror Viewer ends a long task with an error
Mapspace.ViewerEventType.ATTRIBUTIONSCHANGED attributionschanged Attributions changed. Usually a viewer can change its attributions so many times that the better event type to check for changes is POSTRENDER event. A street viewer, on the opposite, changes attributions very few times, so this event is prefered.
Mapspace.ViewerEventType.SINGLECLICK singleclick A true single click with no dragging and no double click. Note that this event is delayed by 250 ms to ensure that it is not a double click.
Mapspace.ViewerEventType.ACTIVATED activated This event is only for viewers inside a Mapspace.global.Viewer and signals when a viewer inside the global viewer is activated
Mapspace.ViewerEventType.LAYERCOLLECTIONCHANGED layercollectionchanged The layer group reference has changed, or the collection with the layers has changed, or layers has been added or removed.
Mapspace.ViewerEventType.VISIBLECHANGED visiblechanged The visibility of the viewer has changed
Mapspace.ViewerEventType.VIEWERACTIVATED vieweractivated Viewer has been activated
Mapspace.ViewerEventType.VIEWERDEACTIVATED viewerdeactivated Viewer has been deactivated
Mapspace.ViewerEventType.ADDRESSINFORETRIEVED addressinforetrieved Viewer has retrieved an address information during a geocoding search or a reverse geocoding
Mapspace.ViewerEventType.USEDEPTHMAPCHANGED usedepthmapchanged The use of the depth map in Street viewers has changed
Source:
mapspace/enums.js

ViewerInfoOption

An option for visualizing information of a viewer. An array of this options can be passed as options to Mapspace.ortho.action.VieweInfo and other actions of the like.

Properties:
Name Type Description
type Mapspace.ViewerInfoType

The type of information of the viewer.
metadata string | undefined

If type = METADATA then the name of metadata.
label string | undefined

Label to show before the information. Default is empty.
defaultValue string | undefined

A default string to show in case current value is null.
visible boolean | undefined

If show or not this information.
linkedToPrevious boolean | undefined

If this info will be shown only if previous is shown. Default is false.
formatFunction function | undefined

Any function that receives some params and return a string for a final formatting of the info.
translateSubKey string | undefined

The subkey to retrieve the translation for the label. The key to search for a translation will be '#' where will be the globalizationKey of the control linked with the action.
Source:
mapspace/typedefs.js

ViewerInfoType

Types of information we can visualize of any viewer.

Name Value
Mapspace.ViewerInfoType.SEPARATOR separator
Mapspace.ViewerInfoType.MOUSEPOSITION mouseposition
Mapspace.ViewerInfoType.CENTER center
Mapspace.ViewerInfoType.ZOOM zoom
Mapspace.ViewerInfoType.RESOLUTION resolution
Mapspace.ViewerInfoType.ROTATION rotation
Mapspace.ViewerInfoType.PROJECTION projection
Mapspace.ViewerInfoType.FOV fov
Mapspace.ViewerInfoType.YAW yaw
Mapspace.ViewerInfoType.PITCH pitch
Mapspace.ViewerInfoType.ROLL roll
Mapspace.ViewerInfoType.METADATA metadata (This includes ImageID and any other kind of metadata)
Source:
mapspace/enums.js

ViewerLayerEventType

Types of events for a layer inside a Mapspace.Viewer.

Name Value Description
Mapspace.ViewerLayerEventType.LAYERNAMECHANGED layernamechanged The name of a layer has changed.
Mapspace.ViewerLayerEventType.LAYERVISIBILITYCHANGED layervisibilitychanged The visibility of a layer has changed.
Mapspace.ViewerLayerEventType.LAYERLABELSVISIBILITYCHANGED layerlabelsvisibilitychanged The visibility of the labels in the layer has changed.
Mapspace.ViewerLayerEventType.LAYERSTYLECHANGED layerstylechanged The style of a layer has changed or the style of any feature in a layer has changed.
Mapspace.ViewerLayerEventType.LAYERFEATURESCREATED layerfeaturescreated Features has been created in a layer. The difference with ADDED is that added are features not created by the user but in a load
Mapspace.ViewerLayerEventType.LAYERFEATURESADDED layerfeaturesadded Features has been added to a layer by loading them.
Mapspace.ViewerLayerEventType.LAYERFEATURESIMPORTED layerfeaturesimported Features has been imported to a layer. Importing is when extra content is added to a layer that was not in the layer and was never to be loaded, for example, loading from a local file in a server layer.
Mapspace.ViewerLayerEventType.LAYERFEATURESDELETED layerfeaturesdeleted Features has been deleted from a layer.
Mapspace.ViewerLayerEventType.LAYERFEATURESMODIFIED layerfeaturesmodified Features from a layer has been modified, either in the attributes or in the geometry.
Mapspace.ViewerLayerEventType.LAYERFEATURESREQUIREDSELECTED layerfeaturesrequiredselected This is not a proper event but a way to notify the viewer that some features of a layer must be selected. Useful for example to select features ugin saved lists or other not interactive system.
Mapspace.ViewerLayerEventType.LAYERSELECTIONCHANGED layerselectionchanged Features selected in a layer has changed.
Mapspace.ViewerLayerEventType.LAYERFEATURECLICKED layerfeatureclicked Click event for features.
Mapspace.ViewerLayerEventType.LAYEROVERLAYCLICKED layeroverlayclicked Click event for text overlay labels.
Source:
mapspace/enums.js

ViewerLocationOptions

Options for initialize or change location in any type of Mapspace.Viewer.

Properties:
Name Type Description
center Mapspace.Coordinate | undefined

The center in WGS84 lonlat.
offset Mapspace.Coordinate | undefined

The center offset to apply to current center in WGS84 lonlat.
rotation number | undefined

The rotation in decimal degrees ranging from 0 to less than 360, where 0 means looking north.
resolution number | undefined

The resolution of the viewer, if that has sense for the viewer, in meters per pixel.
fov number | undefined

The FOV of the viewer, if that has sense for the viewer, from 0 to 360 in decimal degrees.
pitch number | undefined

The pitch of the viewer, if that has sense for the viewer, from [-90, 90] in decimal degrees. When pitch value is 0 the viewer is aligned with horizon, -90 value looking up and 90 down.
imageid string | undefined

An image ID, if that has sense for the viewer. When both center and imageid exists then imageid takes precedence.
outputprojection string | undefined

The viewer output projection. The 'EPSG:code' string with the projection to use in any control linked to this viewer when showing coordinates.
pin boolean | undefined

If add a pin icon in the location. By default is false.
label boolean | string | undefined

If show a pin icon and a label in the localtion. By default is false. If it is true then executes a reverse geocoding in the location and label is the address found. If it is a string then no reverse geocoding is executed and the label is the string.
callback function | undefined

A function to call when the viewer finish the initialization or the change in location.
Source:
mapspace/typedefs.js

ViewerOptions

Options for Mapspace.Viewer.

Properties:
Name Type Description
name string | undefined

The name of the viewer.
target Element | string | undefined

The DOM target element where this viewer will be appended.
outputprojection string | undefined

The viewer output projection. The 'EPSG:code' string with the projection to use in any control linked to this viewer when showing coordinates.
debugmode boolean | undefined

If activate the debug mode or not. By default is false. This mode is only active when Mapspace.DEBUG global variable is set to true and the user has the required permissions. The mode shows several extra information on top of existing layers and offer a debug panel.
debuggrid boolean | undefined

If activate a debug grid or not. Bay default is false. This mode is only active when Mapspace.DEBUG global variable is set to true and the user has the required permissions. If debugmode is set to false then this mode is ignored. The mode shows the grid of tiles with IDs for the main tile layer.
Source:
mapspace/typedefs.js

ViewerProperty

Properties of a Mapspace.Viewer that are tracked.

Name Value Description
Mapspace.ViewerProperty.TARGET target Div element where viewer is loaded
Mapspace.ViewerProperty.NAME name Name of the viewer
Mapspace.ViewerProperty.SIZE size Size of the div where viewer is loaded
Mapspace.ViewerProperty.TIME time Time range for Mapspace services
Mapspace.ViewerProperty.DEBUGMODE debugmode If use a debug mode with the viewer or not
Mapspace.ViewerProperty.DEBUGGRID debuggrid If show a debug grid when debug mode is activated
Mapspace.ViewerProperty.DEBUGGRIDCOLOR debuggridcolor Color of the debug grid as a CSS color
Mapspace.ViewerProperty.CENTER center
Mapspace.ViewerProperty.ROTATION rotation
Mapspace.ViewerProperty.MAXRESOLUTION maxResolution
Mapspace.ViewerProperty.MINRESOLUTION minResolution
Mapspace.ViewerProperty.MAXZOOM maxZoom
Mapspace.ViewerProperty.MINZOOM minZoom
Mapspace.ViewerProperty.RESOLUTIONS resolutions
Mapspace.ViewerProperty.RESOLUTION resolution
Mapspace.ViewerProperty.ZOOM zoom
Mapspace.ViewerProperty.ZOOMFACTOR zoomFactor
Mapspace.ViewerProperty.LAYERGROUP layergroup
Mapspace.ViewerProperty.CONTROLS controls
Mapspace.ViewerProperty.OUTPUTPROJECTION outputprojection
Mapspace.ViewerProperty.UNITS units
Mapspace.ViewerProperty.CHANGED changed If the viewer has changed from last save
Mapspace.ViewerProperty.STATE state The Mapspace.ViewerState of viewer
Mapspace.ViewerProperty.AUTOLOADFEATURESINWFS autoLoadFeaturesInWFS If features of WFS user vector layers must be loaded automatically after changing the view extent of the viewer
Mapspace.ViewerProperty.AUTOSHOWFEATUREPANEL autoshowfeaturepanel If a Mapspace.control.SidePanel must be opened after a selection is done in the vector features of the viewer
Mapspace.ViewerProperty.INTERACTIVETOOL interactivetool The name of the tool that is interactive and is currently active in the viewer or null if basic pan & zoom interaction is active after a selection is done in the viewer
Mapspace.ViewerProperty.AUTOSELECTSTREETIMAGE autoSelectStreetImage If point features of Street images must appear as selected when a Street image is opened
Mapspace.ViewerProperty.AUTOADDNVDBREFTOSTREETIMAGE autoAddNVDBRefToStreetImage If NVDB road reference must be added to attributes of point features of Street images
Mapspace.ViewerProperty.SNAPSHOTOPTIONS snapshotOptions Different data that will be added to snapshots of the viewer.
Mapspace.ViewerProperty.ROTATORTYPE rotatorType The type of Rotator control for the viewer that must be used as default one when a workspace is deserialized.
Mapspace.ViewerProperty.AUXILIARYLINES auxiliarylines If show auxiliary lines in the viewer or not
Source:
mapspace/enums.js

ViewerState

States of a Mapspace.Viewer.

Name Value Description
Mapspace.ViewerState.IDLE idle The viewer is in the idle or normal state
Mapspace.ViewerState.BUSY busy THe viewer is in a long task requesting to server
Source:
mapspace/enums.js

ViewType

Types of views that a Mapspace.Viewer can contain.

Name Value
Mapspace.ViewType.EMPTY empty
Mapspace.ViewType.ORTHO ortho
Mapspace.ViewType.STREET street
Mapspace.ViewType.OBLIQUE oblique
Mapspace.ViewType.THREED threed
Mapspace.ViewType.GLOBAL global
Mapspace.ViewType.PROFILE3D profile
Mapspace.ViewType.TABLE table
Source:
mapspace/enums.js

WorkList

Object that contains the definition of a collection of features from one or several vector layers.

Properties:
Name Type Description
name string

The name of the work list.
locked boolean | undefined

If the features in the work list must be locaked when added to it or not.
content Object.<string, Array.<string>> | undefined

An object that contains the list of features in the work list. Each key in the object must be an identifier that can be used to identify a layer. The values must be arrays of strings with identifiers of the features.
Source:
mapspace/typedefs.js

WorkspaceEventType

Types of events for a Mapspace.Workspace.

Name Value Description
Mapspace.WorkspaceEventType.TARGETCHANGED change:target
Mapspace.WorkspaceEventType.LAYOUTCHANGED change:layout
Mapspace.WorkspaceEventType.SIZECHANGED change:size
Mapspace.WorkspaceEventType.CHANGEDCHANGED change:changed Changed state of workspace changed
Mapspace.WorkspaceEventType.PRESETCHANGED presetchanged
Mapspace.WorkspaceEventType.VIEWERNAMECHANGED viewernamechanged Triggers when a viewer name changes
Mapspace.WorkspaceEventType.OUTPUTPROJECTIONCHANGED outputprojectionchanged
Mapspace.WorkspaceEventType.UNITSCHANGED unitschanged
Mapspace.WorkspaceEventType.VIEWERACTIVATED vieweractivated Triggers when a viewers become the active
Mapspace.WorkspaceEventType.VIEWERDEACTIVATED viewerdeactivated Triggers when a viewer stops as active
Mapspace.WorkspaceEventType.SAVED saved Triggers after a workspace has been saved
Mapspace.WorkspaceEventType.RENAMED renamed Triggers after a workspace has been renamed and saved
Source:
mapspace/enums.js

WorkspaceLoadMode

Different modes to load a Mapspace.Workspace.

Name Value
Mapspace.WorkspaceLoadMode.BYNAME byname
Mapspace.WorkspaceLoadMode.MOSTUPDATED mostupdated
Mapspace.WorkspaceLoadMode.DEFAULT default
Source:
mapspace/enums.js

WorkspaceOptions

Options for Mapspace.Workspace.

Properties:
Name Type Description
name string | undefined

Name of the workspace.
description string | undefined

Description.
webversion string | undefined

Web version this workspace is compatible with.
apiversion string | undefined

API version this workspace is compatible with.
language string | undefined

The default language.
date string | undefined

Date of last modification.
layout Mapspace.Layout | undefined

The initial layout for the workspace.
layoutPresets Array.<Mapspace.LayoutPreset> | undefined

An array of Mapspace.LayoutPreset that define named options for the visibility of the views.
layoutVisibilities Array.<boolean> | undefined

An array that define what views are initially visible.
controls Array.<Mapspace.ControlDefinition> | undefined

An array of control definitions that will be added to the workspace, not attached to any viewer.
target Element | string | undefined

The DOM target element where this workspace will be appended.
availableProjections Array.<ProjectionDefinition> | undefined

Projection definitions.
outputProjection string | undefined

EPSG code of the selected projection, prefixing with 'EPSG:'.
units ol.proj.Units | undefined

Units 1for measurements that are not coordinates. By default is meters.
Source:
mapspace/typedefs.js

WorkspaceProperty

Properties of a Mapspace.Workspace that are tracked.

Name Value Description
Mapspace.WorkspaceProperty.TARGET target Div element where we load the workspace
Mapspace.WorkspaceProperty.LAYOUT layout Layout of workspace
Mapspace.WorkspaceProperty.SIZE size Size of workspace
Mapspace.WorkspaceProperty.CHANGED changed If the workspace has changed or not
Source:
mapspace/enums.js

WorkspaceSyncOptionEventType

Types of sync option events for a Mapspace.Workspace.

Name Value
Mapspace.WorkspaceSyncOptionEventType.SYNCOPTIONADDED syncoptionadded'
Mapspace.WorkspaceSyncOptionEventType.SYNCOPTIONREMOVED syncoptionremoved'
Mapspace.WorkspaceSyncOptionEventType.SYNCOPTIONCHANGED syncoptionchanged'
Source:
mapspace/enums.js