logo
API Documentation
Tutorials
Getting Started Initialization Layers Third party Controls Geometries Vector styles Measures InfoBox Utils
Releases

Documentation

Modules

  • Constants

Events

  • FEATURE_CLICK
  • FEATURE_HOVER
  • CENTER_DATE_IMAGE
  • CHANGE_MEASURE
  • CLICK
  • COMPLETE_COLLECTIONS
  • FEATURES_CLICK
  • FIND_IMAGES_LOADED
  • FINISH_MEASURE
  • MAP_INITIALIZE
  • MAP_STATUS_EVENT
  • MOVE_END
  • NO_3D_IMAGES
  • POINTER_MOVE
  • START_MEASURE
  • TILES_END_LOAD
  • TILES_START_LOAD
  • FEATURE_CLICK
  • FEATURE_HOVER

General

Classes / Controls

  • Bar
  • Button
  • Swipe
  • Toggle

Classes / Managers

  • CollectionManager
  • OverlayManager

Classes

  • Map

Classes / View

  • MapStatusView

Geometry

Classes

  • Extent
  • Feature
  • Line
  • Location
  • MultiPolygon
  • Point
  • Polygon

Classes / Readers

  • GeoJSON
  • WKT

InfoBox

Classes

  • InfoBox

Layers

Classes

  • ArcGISLayer
  • BingLayer
  • GroupLayer
  • ImageryLayer
  • OSMLayer
  • VectorLayer
  • VectorTileLayer
  • WFSLayer
  • WMSLayer
  • WMTSLayer
  • XYZLayer

Classes / Base Layers

  • BaseLayer
  • BaseVectorLayer

Measurements

Classes / Tools

  • CircleTool
  • HeightTool
  • LineTool
  • PointTool
  • PolygonTool
  • RectangleTool
  • RelativeHeightTool

Classes

  • Measure

Objects

Classes

  • Collection
  • CollectionStatus
  • Image
  • LayerCollections
  • LayerCollectionsStatus
  • MapStatus

Services

Classes

  • UserService

Styles

Classes

  • Circle
  • Fill
  • Icon
  • RegularShape
  • Stroke
  • Style
  • Text

Utils

Classes

  • Transform

Class

UserService

UserService()

Service to get info for users to initialize the map properly

Learn more about the User Service in our Init with username/password and start-maps tutorials.

Constructor

# new UserService()

Classes

UserService

Methods

# getMaps(token, versionopt) → {Array.<UserService~Map>}

Retrieves maps available for a user.

Parameters:
Name Type Attributes Default Description
token string

The user's authentication token.

version string | null <optional>
null

The expected map version. If omitted, all maps are returned. Should be a value from MapVersion

  • An array of map instances.
Array.<UserService~Map>

# getUserInfo(username, password, mapVersionopt, applicationopt) → {UserService~UserInfo}

Retrieves user information based on the provided credentials. Additionally, it returns the list of maps associated with the user.

Parameters:
Name Type Attributes Default Description
username string

The username of the user.

password string

The user's password.

mapVersion string | null <optional>
null

The map version to request. If not specified, all maps are returned. Should be a value from MapVersion

application string <optional>
"map-control"

The application requesting access.

  • The user information.
UserService~UserInfo

Type Definitions

Object

# Map

Object with the map data received by the api

Properties:
Name Type Description
id string

identifier for map

name string

name for the map

version string

version for the map. Should be a value from MapVersion

Object

# UserInfo

Object with the user data received by the api

Properties:
Name Type Description
username string

Triggered after the map is moved.

token string

key to initialize and authorize this user

maps Array.<UserService~Map>

list of maps allowed for this user

Documentation generated by Vexcel Imaging