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

Tutorials

  • Getting Started
    • Setup
  • Initialization
    • Init with token
    • Init with username/password
    • Init with constrained zoom levels
    • Init empty map
    • Init with multiple maps
    • Init in 3D mode
    • Init with image 3D mode
    • Init map with a restricted extent
  • Layers
    • XYZ Tile
    • WMS Tile
    • WMTS Tile
    • Bing Layer
    • Vector Layer
    • Vector Tiles
    • WFS Layer
    • ArcGIS Feature
    • Group Layer
  • Third party
    • Bing
    • Google
    • Google side by side
    • Cesium
  • Controls
    • Basics
    • Map modes
    • Map orientations
    • Layer control
    • Zoom control
    • Map Bar Control
    • Map Button
    • Map Toggle
    • Vexcel image metadata
    • Vexcel find collection
    • Vexcel show collection
    • Vexcel Infrared
    • Brightness and Contrast Control
  • Geometries
    • Point
    • Line
    • Polygon
    • MultiPolygon
    • WKT reader
    • GeoJSON reader
    • Feature click
    • Feature hover
  • Vector styles
    • Polygon styles
    • Point styles
    • Point shapes styles
    • Text styles
    • Feature styles
  • Measures
    • 2D mode
    • 3D mode
    • Change units
    • Edit
    • Tooltips
    • Custom Tooltips
  • InfoBox
    • InfoBox fixed
    • InfoBox on click
    • InfoBox feature
  • Utils
    • Transform

Tutorial

Setup

This document will walk you through getting a basic map set up and displaying inside a div.

Create Map Div

Getting started with Vexcel API is easy. Simply start by adding a div element to an HTML5 document. This div element will contain our map, so we will give it an id of 'map'. We have to add a fixed height for the map element.

Index.html

        
    

Add Vexcel Map API Reference

Add Vexcel Map API Reference using a script tag. This url will ensure that you are accessing the most recently released functionality. If you prefer to use a specific version, replace 'latest' in the url with your chosen version (e.g. '2.0.1'). Also you need to add a reference to css styles.

        
    

Your HTML document should now look like this:

Index.html

        
    

Login and Load Map

You can login either with an API token or with a username and password. In this walkthrough, we will assume that you have already recieved a token. Using a script tag or a separate Javascript file, loading Vexcel Map imagery into your div tag takes minimal effort.

        
    

Embedding this script into a script tag looks like this.

Index.html

        
    

Customize Your Map

Now that you've gained access to Vexcel Map API and have designated a div to hold available imagery, the options are limitless! Add a control bar with zoom buttons and orientation controls; overlay custom points, polygons, and lines; programmatically toggle between 2D and 3D imagery; and more.

Documentation generated by Vexcel Imaging