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

AOILayer

AOILayer

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

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

Extends

  • XYZLayer

Classes

AOILayer

Methods

# getAttributions() → {string}

Gets the attributions of the layer.

Overrides:
  • XYZLayer#getAttributions

Attributions of the layer.

string

# getMaxZoom() → {number}

Gets the maximum zoom level of the layer.

Overrides:
  • XYZLayer#getMaxZoom

The maximum zoom level of the layer.

number

# getMetadata() → {AOILayer~Metadata}

Get the metadata for this aoi

Object with aoi info

AOILayer~Metadata

# getMinZoom() → {number}

Gets the minimum zoom level of the layer.

Overrides:
  • XYZLayer#getMinZoom

The minimum zoom level of the layer.

number

# getOpacity() → {number}

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

Overrides:
  • XYZLayer#getOpacity

The opacity of the layer.

number

# getVisible() → {boolean}

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

Overrides:
  • XYZLayer#getVisible

The visibility of the layer.

boolean

# setMaxZoom(maxZoom)

Sets 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.

Overrides:
  • XYZLayer#setMaxZoom

# setMinZoom(minZoom)

Sets 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.

Overrides:
  • XYZLayer#setMinZoom

# setOpacity(opacity)

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

Parameters:
Name Type Description
opacity number

The opacity of the layer.

Overrides:
  • XYZLayer#setOpacity

# setVisible(visible)

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

Parameters:
Name Type Description
visible boolean

The visibility of the layer.

Overrides:
  • XYZLayer#setVisible

Type Definitions

Object

# Metadata

AOI Metadata

Properties:
Name Type Attributes Description
Min GSD string <optional>

min gsd for this aoi

Max GSD string <optional>

max gsd for this aoi

Min Capture date string <optional>

min date for this aoi

Max Capture date string <optional>

max date for this aoi

AOI string <optional>

aoi name

AOI Max Zoom string <optional>

aoi max zoom

layer string <optional>

layer name

Object

# Metadata

AOI Metadata

Properties:
Name Type Attributes Description
Min GSD string <optional>

min gsd for this aoi

Max GSD string <optional>

max gsd for this aoi

Min Capture date string <optional>

min date for this aoi

Max Capture date string <optional>

max date for this aoi

AOI string <optional>

aoi name

AOI Max Zoom string <optional>

aoi max zoom

layer string <optional>

layer name

Documentation generated by Vexcel Imaging