logo
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_LAYERS_AOIS
  • FEATURES_CLICK
  • FIND_IMAGES_LOADED
  • FINISH_MEASURE
  • LAYER_AOIS
  • MAP_INITIALIZE
  • 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

  • LayerManager
  • MeasurementManager

Classes

  • Map

Geometry

Classes

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

Classes / Readers

  • GeoJSON
  • WKT

InfoBox

Classes

  • InfoBox

Layers

Classes / Internal

  • AOILayer
  • CollectionLayer

Classes

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

Classes / Base Layers

  • BaseGroupLayer
  • BaseTileLayer
  • BaseVectorLayer

Measurements

Classes / Tools

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

Classes

  • Measure

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 Init instance tutorials.

Constructor

# new UserService()

Classes

UserService

Methods

# getInstances(token) → {Array.<UserService~Instance>}

Service to get the instances for a user

Parameters:
Name Type Description
token string

user token

Instances array

Array.<UserService~Instance>

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

Service to get user info for a username and password This also return the instance list for this user

Parameters:
Name Type Attributes Default Description
username string
password string
application string <optional>
map-control

application to ask access

UserInfo

UserService~UserInfo

Type Definitions

Object

# Instance

Object with the instance data received by the api

Properties:
Name Type Description
id string

identifier for instance

name string

name for the instance

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

instances Array.<UserService~Instance>

list of UserService~Instance allowed for this user

Documentation generated by Vexcel Imaging