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

Module

Constants

Members

# inner constant 3DEvents

Events triggered by 3d availability event

Properties:
Name Type Description
STOP string

Data not available

DOWNLOADING string

Downloading data

FINISHED string

Finished downloading available data

# inner constant AreaUnits

Area Units

Properties:
Name Type Description
METRIC Array.<string>

Metric system

km2 string

Square kilometer

ha string

Hectare

m2 string

Square meters

IMPERIAL Array.<string>

Imperial values system

mi2 string

Square miles

ac string

Acre

yd2 string

Square yards

ft2 string

Square feet

# inner constant FeatureEvents

Events triggered by feature

Properties:
Name Type Description
FEATURE_CLICK string

Triggered when user clicks on a feature

FEATURE_HOVER string

Triggered when user hovers over a feature

# inner constant LengthUnits

Length Units

Properties:
Name Type Description
METRIC Array.<string>

Metric system

km string

Kilometer

m string

Meters

IMPERIAL Array.<string>

Imperial values system

mi string

Miles

yd string

Yards

ft string

Feet

# inner constant MapEvents

Events triggered by map object

Properties:
Name Type Description
POINTER_MOVE string

Triggered when a pointer is moved. Note that on touch devices this is triggered when the map is panned, so this is not the same as moving the mouse.

MOVE_END string

Triggered when map finishes moving

MOVE_START string

Triggered when map starts moving

TILES_START_LOAD string

Triggered when map starts to load tiles

TILES_END_LOAD string

Triggered when map finishes loading tiles

MAP_INITIALIZE string

Triggered when map finishes the initialization

CLICK string

Triggered when single click over the map

DBL_CLICK string

Triggered when double click over the map

FEATURES string

Trigger when click on a feature *

STATUS_3D_MEASURES string

Triggered when 3d measure status is updated

CHANGE_MEASURE string

Triggered after a measurement is created or edited with the measurement tools

FINISH_MEASURE string

Triggered when a measure is finished

START_MEASURE string

Triggered when a measure is started

NO_3D_IMAGES string

Triggered when no images to 3D mode

CENTER_DATE_IMAGE string

Triggered when center date image change

# inner constant MapOrientation

Map Orientations

Properties:
Name Type Description
V string

Vertical orientation

N string

North orientation

S string

South orientation

E string

East orientation

W string

West orientation

# inner constant MapVersion

Map version

Properties:
Name Type Description
V1 string

v1 maps

V2 string

v2 maps

# inner constant MeasurementTools

Tools for drawing geometries and taking measurements

Properties:
Name Type Description
POINT string

Tool for drawing points

LINE string

Tool for drawing lines

POLYGON string

Tool for drawing polygons

HEIGHT string

Tool for drawing height

RELATIVE_ELEVATION string

Tool for drawing relative elevation

RECTANGLE string

Tool for drawing boxes/rectanges

# inner constant MeasureSystem

Measurement Systems

Properties:
Name Type Description
METRIC string

Metric system

IMPERIAL string

Imperial system

# inner constant ObliqueProjections

Set how the vector layer will reprojects itself in oblique mode

Properties:
Name Type Description
NONE string

The layer won´t be reprojected in oblique mode.

DTM string

The layer will be reprojected in oblique mode using the dtm.

DSM string

The layer will be reprojected in oblique mode using the dsm.

# inner constant SlopeUnits

Slope Units

Properties:
Name Type Description
METRIC Array.<string>

Metric system

deg string

Degree

rad string

Radians

% string

Slope percentage

IMPERIAL Array.<string>

Imperial values system

rise/run string

Rise/run

% string

Slope percentage

# inner constant VexcelLayers

Predefined layer names for Vexcel imagery

Properties:
Name Type Description
URBAN string

Urban, Osprey cam, only for v2.0 maps

URBAN_G string

Urban G, Geomni data, only for v2.0 maps

URBAN_R string

Urban R, Condor data, only for v2.0 maps

GRAYSKY string

GraySky, Osprey cam, only for v2.0 maps

GRAYSKY_G string

GraySky G, Geomni data, only for v2.0 maps

WIDE_AREA string

Wide area, Condor cam, only for v2.0 maps

# inner constant ViewMode

View Modes

Properties:
Name Type Description
2D string

Ortho Mode

3D string

Oblique mode

Documentation generated by Vexcel Imaging