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

Class

OverlayManager

OverlayManager

The Overlay Manager class provides interaction with the map's layers and allows you to add, remove, or find layers as needed.

Classes

OverlayManager

Methods

# addLayer(layer)

Adds the given layer to the map. This layer will display on top of any existing layers.

Parameters:
Name Type Description
layer BaseLayer

Layer to add

# addLayers(layers)

Adds the given layers to the map. Added layers will display on top of any existing layers.

Parameters:
Name Type Description
layers Array.<BaseLayer>

Array of layers to add

# getDrawingLayer() → {VectorLayer}

Returns the vector layer used for vector drawing.

Drawing layer

VectorLayer

# getLayerById(id) → {BaseLayer}

Gets the layer with the same id as the specified in the 'id' parameter.

Parameters:
Name Type Description
id number

The id of the layer to be returned.

Layer

BaseLayer

# getLayers() → {Array.<BaseLayer>}

Retrieves an array with all layers of the map.

Array of layers

Array.<BaseLayer>

# getMarkerLayer() → {VectorLayer}

Returns the vector layer used for showing markers

VectorLayer

# removeLayer(layer)

Removes the given layer from the map.

Parameters:
Name Type Description
layer BaseLayer

Layer to remove

# removeLayers(layers)

Removes the given layers from the map.

Parameters:
Name Type Description
layers Array.<BaseLayer>

Layers to remove

Documentation generated by Vexcel Imaging