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

Home

2.0.1

Vexcel Map API

Introduction

Vexcel Map API makes it easy to add a dynamic map to any web page. Leverage Vexcel Map API to load alternate vector data, add geometric overlays, get geographic information (e.g. elevation, coordinates), switch between view orientations, and more.

This documentation is designed for those familiar with JavaScript programming. Use this documentation to learn more about available functionality and start developing with the Vexcel Map API.

View our Getting Started tutorial to start developing with the Vexcel Map API.

Versions

If you are not ready for the latest version of Vexcel Map API, that's alright! We keep versioned documents so you have access to correct information regardless of the API version you choose to use. However, please consider upgrading to the latest version so you can benefit from the latest features and bug fixes.

We follow industry standards when versioning our API, denoted by v{major}.{minor}.{patch}. A major version consists of new features and large architectural changes. Major versions may include some breaking changes and require our users to update the version they are using. A minor version may include new features as well, but will mitigate breaking changes and allow backwards compatability. A patch may be deployed, which will fix bugs and improve performance.

  • Current Version: v2.0.1 released 2025-04-10 — docs, & tutorials
    • Script: https://app.vexcelgroup.com/map/v2.0.1/public/Vexcel.js
    • Styles: https://app.vexcelgroup.com/map/v2.0.1/public/css/styles.css
  • Latest Major Version: v2 released 2025-04-10 — docs, & tutorials
    • Script: https://app.vexcelgroup.com/map/v2/public/Vexcel.js
    • Styles: https://app.vexcelgroup.com/map/v2/public/css/styles.css

For older versions you can check the full changelog here.

Documentation generated by Vexcel Imaging