logo
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_LAYERS_AOIS
  • FEATURES_CLICK
  • FIND_IMAGES_LOADED
  • FINISH_MEASURE
  • LAYER_AOIS
  • MAP_INITIALIZE
  • 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

  • LayerManager
  • MeasurementManager

Classes

  • Map

Geometry

Classes

  • Extent
  • Feature
  • Line
  • Location
  • MultiPolygon
  • Point
  • Polygon

Classes / Readers

  • GeoJSON
  • WKT

InfoBox

Classes

  • InfoBox

Layers

Classes / Internal

  • AOILayer
  • CollectionLayer

Classes

  • ArcGISLayer
  • BingLayer
  • GroupLayer
  • OSMLayer
  • VectorLayer
  • VectorTileLayer
  • VexcelLayer
  • WFSLayer
  • WMSLayer
  • WMTSLayer
  • XYZLayer

Classes / Base Layers

  • BaseGroupLayer
  • BaseTileLayer
  • BaseVectorLayer

Measurements

Classes / Tools

  • CircleTool
  • HeightTool
  • LineTool
  • PointTool
  • PolygonTool
  • RectangleTool
  • RelativeHeightTool

Classes

  • Measure

Services

Classes

  • UserService

Styles

Classes

  • Circle
  • Fill
  • Icon
  • RegularShape
  • Stroke
  • Style
  • Text

Utils

Classes

  • Transform

Class

CollectionLayer

CollectionLayer

For layer sources that provide pre-rendered, tiled images in grids that are organized by zoom levels for specific resolutions.

Vexcel Layers cannot be instantiated. Learn more about Vexcel Layers in our Vexcel aois, Vexcel find aois, and Vexcel Infrared tutorials.

Classes

CollectionLayer

Methods

# findAois(location) → {Array.<AOILayer>}

Find projects available for a location

Parameters:
Name Type Description
location Location

object with geographic coordinates [Lat,Lng]

List of child AOILayers that contains this location

Array.<AOILayer>

# findAoisByExtent(extent, epsg) → {Array.<AOILayer>}

Find projects available for a extent

Parameters:
Name Type Description
extent
epsg

List of child AOILayer that intersects with this extent

Array.<AOILayer>

# getAois() → {Array.<AOILayer>}

Return list of child layers

List of project XYZ Layers

Array.<AOILayer>

# getAttributions() → {string}

Gets the attributions of the layer.

Attributions of the layer.

string

# getCoverage() → {Geometry}

Return coverage polygon for this layer

Geometry

# getMaxZoom() → {number}

Return the maximum zoom level of the layer.

The maximum zoom level of the layer.

number

# getMinZoom() → {number}

Return the minimum zoom level of the layer.

The minimum zoom level of the layer.

number

# getOpacity() → {number}

Return the opacity of the layer (between 0 and 1).

The opacity of the layer.

number

# getVisible() → {boolean}

Return the visibility of the layer (true or false).

The visibility of the layer.

boolean

# hasAois() → {boolean}

Return if this VexcelLayer has child aois

boolean

# hasInfrared() → {boolean}

Return if this layer have infrared data

boolean

# infrared(enable)

Change infrared status

Parameters:
Name Type Description
enable boolean

# isEnabled() → {boolean}

Return if this layer have coverage at the current location

boolean

# setMaxZoom(maxZoom)

Set the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters:
Name Type Description
maxZoom number

The maximum zoom of the layer.

# setMinZoom(minZoom)

Set the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters:
Name Type Description
minZoom number

The minimum zoom of the layer.

# setOpacity(opacity)

Set the opacity of the layer, allowed values range from 0 to 1.

Parameters:
Name Type Description
opacity number

The opacity of the layer.

# setVisible(visible)

Set the visibility of the layer (true or false).

Parameters:
Name Type Description
visible boolean

The visibility of the layer.

Documentation generated by Vexcel Imaging