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

BaseLayer

BaseLayer

Abstract base layer

Classes

BaseLayer

Methods

# getMaxZoom() → {number}

Gets the maximum zoom level of the layer.

The maximum zoom level of the layer.

number

# getMinZoom() → {number}

Gets the minimum zoom level of the layer.

The minimum zoom level of the layer.

number

# getOpacity() → {number}

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

The opacity of the layer.

number

# getVisible() → {boolean}

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

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.

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

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

# setVisible(visible)

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

Parameters:
Name Type Description
visible boolean

The visibility of the layer.

Documentation generated by Vexcel Imaging