Constructor

# new Map(opts)

Generate object with options. You must provide at least one of the following parameters: token, apiKey, geoKey, or impersonationKey.

Parameters:

Name	Type	Attributes	Default	Description
`opts`	`object`			Map core options.
`target`	`string`			Div name where interactive map will reside
`token`	`number`	<optional>		The authentication token, required if no other authentication method is provided.
`apiKey`	`number`	<optional>		The authentication api key, required if no other authentication method is provided.
`geoKey`	`number`	<optional>		The authentication geo key, required if no other authentication method is provided.
`impersonationKey`	`number`	<optional>		The authentication impersonation key, required if no other authentication method is provided.
`instanceId`	`target`	<optional>		Instance Id. IMPORTANT. If no ID is informed, the used instance will be the first instance assigned to the user ordered alphabetically.
`center`	`Array.<number>`	<optional>		The initial center for the view.
`zoom`	`number`	<optional>		Zoom level for the view.
`maxZoom`	`number`	<optional>		The maximum zoom level used to determine the resolution constraint.
`minZoom`	`number`	<optional>		The minimum zoom level used to determine the resolution constraint.
`mode`	`string`	<optional>	"2D"	Initial mode in which the map will be initialized
`orientation`	`string`	<optional>	"N"	Initial orientation in which the map will be initialized
`aois`	`boolean`	<optional>	false	Load aois for VexcelLayers
`init`	`Map~InitOpts`	<optional>	{layers:true,center:true,zoom:true,callback:null}	Object to establish which instance config it´s applied.
`restrictedExtent`	`Extent`	<optional>		The extent that the map will be restricted to.

Tutorials:

Fires:

Example

Create basic map. Always need at least a target container and token

const map = new Vexcel.Map({
      target: "map",
      token: API_KEY,
      });

Classes

Map

Methods

# addControl(control)

Add custom control to the map

Parameters:

Name	Type	Description
`control`	`object`	element to add to the map

# addInfoBox(infobox)

Add the given infobox to the map. If the infobox has a location we show in the map if not you can show when you need with the function InfoBox~show

Parameters:

Name	Type	Description
`infobox`	`InfoBox`	Infobox.

# changeMode(mode) → {Promise.<Map~ResponsePromise>}

Change map mode 2d/3d Select the collection in the top and change mode When change to 2d we force North orientation When change to 3d we persist the view orientation

Parameters:

Name	Type	Description
`mode`	`string`	value from ViewMode

Returns:

Type: Promise.<Map~ResponsePromise>

# changeOrientation(orientation) → {Promise.<Map~ResponsePromise>}

Change map orientation ViewerConstants.ViewerModes

Parameters:

Name	Type	Description
`orientation`	`string`	value from MapOrientation

Returns:

Type: Promise.<Map~ResponsePromise>

# getApiService() → {IApiService}

Get api service object that manage api requests

Returns:

Type: IApiService

# getApiVersion() → {string}

Get api version

Returns:

Type: string

# getLayerManager() → {LayerManager}

Get layer manager object that manage map layers

Returns:

Type: LayerManager

# getLocation() → {Location}

Gets the geographic coordinates of center of the view.

Returns:

location object with [lat,lng] for the center of the image

Type: Location

# getMode() → {module:Constants~ViewMode}

Return map mode, define is we are in 2d (Vertical) or 3d (Oblique)

Returns:

mode for current view

Type: module:Constants~ViewMode

# getViewExtent() → {Extent}

Get the extent for the current view state.

See:

Extent

Returns:

Type: Extent

# getZoom() → {number}

Get the current zoom level. This method may return non-integer zoom levels if the view does not constrain the resolution, or if an interaction or animation is underway.

Returns:

zoom Zoom level

Type: number

# orthoEstimateDates()

Get image date

# removeControl(control)

Remove custom control from the map

Parameters:

Name	Type	Description
`control`	`object`	element to add to the map

# setLocation(location)

Centers the map in the given point.

Parameters:

Name	Type	Description
`location`	`Location`

# setMaxZoom(maxZoom)

The maximum zoom level used to determine the resolution constraint

Parameters:

Name	Type	Description
`maxZoom`	`number`	maximum zoom level

# setMinZoom(minZoom)

The minimum zoom level used to determine the resolution constraint

Parameters:

Name	Type	Description
`minZoom`	`number`	minimum zoom level

# setViewExtent(extent)

Fit to extent, move the map to fit this extent

Parameters:

Name	Type	Description
`extent`	`Extent`

See:

Extent

# setZoom(zoom)

Zoom to a specific zoom level

Parameters:

Name	Type	Description
`zoom`	`number`	Zoom level

Type Definitions

# InitOpts

Properties:

Name	Type	Attributes	Default	Description
`layers`	`boolean`	<optional>	true	Layers visible at start.
`center`	`boolean`	<optional>	true	Use center defined in instance config. Use over map config.
`zoom`	`boolean`	<optional>	true	Use zoom defined in instance config. Use over map config.
`callback`	`function`	<optional>		Callback called when the map finish the initialization.

Type: Object

# MapStatus

Map status with the relevant info for location zoom extent

Properties:

Name	Type	Attributes	Description
`extent`	`Array.<number>`	<optional>	Extent for map view
`center`	`number`	<optional>	Coordinates for map center
`zoom`	`object`	<optional>	Zoom level

Type: Object

# ResponsePromise

Response promise

Properties:

Name	Type	Attributes	Description
`msg`	`string`	<optional>	status message
`status`	`number`	<optional>	status code
`layer`	`object`	<optional>	layer

Events

Type: object

# CENTER_DATE_IMAGE

Event triggered when center image change

Type: object

# CHANGE_MEASURE

Event triggered after creating or editing a new measurement with the measurement tools

Parameters:

Name	Type	Description
`(object}`		event - Internal event

Properties:

Name	Type	Description
`measure`	`Measure`	Measure object

Type: object

# CLICK

Event Triggered when user single clicks on the map. This event is not triggered if drawing tools are enabled or if the user clicks on a feature on the map.

Properties:

Name	Type	Description
`location`	`Location`	Location of the coordinates for this event
`drawing`	`boolean`	Return if any of drawing/measurement tools are enabled

# COMPLETE_LAYERS_AOIS

Event triggered when map loads all AOIs for a Vexcel layers

Type: object

# FEATURES_CLICK

Event Triggered when user clicks on a space on the map occupied by multiple features. Only fired if there is more than one feature

Properties:

Name	Type	Description
`location`	`Location`	Location for point clicked
`features`	`Array.<Feature>`	List of features when you click

Example

Listener in map to listen on features click

core.addListener(Vexcel.Events.MapEvents.FEATURES_CLICK, (e) => {
        e.features.map(feat => console.log(JSON.stringify(feat)));
    });
  }
});

Type: object

# FIND_IMAGES_LOADED

Event triggered after map loads images for the center of the map in the viewport

Properties:

Name	Type	Description
`images`	`Array.<object>`	List of images loaded for the center of the map
`point`	`Array.<number>`	Point of the center of the image
`epsg`	`string`	Epsg code for point coordinates

Type: object

# FINISH_MEASURE

Event triggered after finish a new measurement with the measurement tools

Parameters:

Name	Type	Description
`(object}`		event - Internal event

Properties:

Name	Type	Description
`measure`	`Measure`	Measure object

# LAYER_AOIS

Event triggered when map loads AOIs for a Vexcel layer

Type: object

# MAP_INITIALIZE

Event triggered after map is initialized and layers are loaded

Properties:

Name	Type	Description
`map`	`Map`	Map object
`status`	`Map~MapStatus`	Object with the status of the map

Type: object

# MOVE_END

Event Triggered after the map is moved.

Type: object

# NO_3D_IMAGES

Event triggered when no images to 3D mode

Type: object

# POINTER_MOVE

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

Properties:

Name	Type	Description
`location`	`Location`	Location for point

Type: object

# START_MEASURE

Event triggered after start a new measurement with the measurement tools

Parameters:

Name	Type	Description
`(object}`		event - Internal event

Properties:

Name	Type	Description
`measure`	`Measure`	Measure object

# TILES_END_LOAD

Event triggered when the map finishes loading the tiles

# TILES_START_LOAD

Event triggered when the map starts loading the tiles