Global

Members

(readonly) Commands

Default IDs for Built-in Commands (can be used as upper or lowercase strings)
Properties:
Name Type Description
LAYERTREE
SEARCHPLACE
SEARCHPARCEL
TOOLBOX
LEGEND
VIEW_PREV
VIEW_NEXT
VIEW
ZOOM_BOX
ZOOM_SCALE
MEASURE_LINE
MEASURE_AREA
MEASURE_CLEAR
DRAW_POINTS
DRAW_LINES
DRAW_POLYGONS
MODIFY_FEATURES
DELETE_FEATURES
BUFFER_FEATURES
CUT_FEATURES
SNAP_TOGGLE
IMPORT_LAYER
EXPORT
GEOLOCATION

(readonly) LayerID

Default IDs for Built-in Layers
Properties:
Name Type Description
EDITABLE "editable-layer"
NON_EDITABLE "non-editable-layer"

(readonly) LayerTypes

Supported Layer Types
Properties:
Name Type Description
TMS Tile Map Service
Parameters:
  • "url": {String} URL containing {x}/{y}/{z} placeholders
XYZ Raster Tiles, see TMS
OSM OpenStreetMap Tiles, see TMS
WMTS Web Map Tile Service
Parameters:
  • "url": {String} Service host URL
  • "name": {String} Service layer name
WMS Web Map Service
Parameters:
  • "url": {String} Service host URL
  • "name": {String} Service layer name
  • "format": {String} Image MIME type
  • "tiled": {Boolean} Request tiled or full image
  • "username": {String} For basic auth if necessary
  • "password": {String} For basic auth if necessary
WMST Web Map Service Temporal
Parameters:
  • "url": {String} Service host URL
  • "name": {String} Service layer name
  • "format": {String} Image MIME type
  • "tiled": {Boolean} Request tiled or full image
  • "username": {String} For basic auth if necessary
  • "password": {String} For basic auth if necessary
GEOJSON GeoJSON
Parameters:
  • "data": {JSON} GeoJSON feature or collection
  • "url": {String} Request from URL if no data given
VTILES Vector Tiles
Parameters:
  • "url": {String} Service host URL
  • "extent": {Array} Data extent if not set by server
WFS Web Feature Service
Parameters:
  • "url": {String} Service host URL
  • "name": {String} Service layer type name
  • "format": {String} Response MIME type
  • "username": {String} For basic auth if necessary
  • "password": {String} For basic auth if necessary
GML Geography Markup Language
Parameters:
  • "data": {String} GML document
KML Keyhole Markup Language
Parameters:
  • "url": {String} KML document URL
GEOPACKAGE GeoPackage
Parameters:
  • "data": {Array} GeoPackage file content
SPATIALITE Spatialite
Parameters:
  • "data": {Array} Spatialite file content
SHAPEFILE Shapefile
Parameters:
  • "data": {Array} Shapefile file content
WKT Well Known Text
Parameters:
  • "data": {String} WKT content
HIDDEN Hidden Layer (not visible in Layer Tree, but may be used for feature queries etc.)

(readonly) Modules

Properties:
Name Type Description
menu Menu Bar
layertree Layer Tree Panel
map Map View
controls Map Controls
attribution Map Layer Attribution
legend Legend Panel
geolocation Geolocation Controls
info Feature Info Popup
searchplace Search Place Panel
searchparcel Search Parcel Panel
toolbox Toolbox Panel
import Import Layer Modal
export Export Map Modal
timeslider Time Slider Panel

util

General Purpose Pure Static Utility Functions