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

Measure

Measure

Measure object that extends from Feature.

Learn more about Measurements in our 2D mode and 3D mode tutorials.

  • Measure#event:FEATURE_CLICK
  • Feature#event:FEATURE_CLICK
  • Measure#event:FEATURE_HOVER
  • Feature#event:FEATURE_HOVER

Extends

  • Feature

Classes

Measure

Methods

# clone() → {Measure}

Clone this feature. If the original feature has a geometry it is also cloned.

Overrides:
  • Feature#clone

The clone.

Measure

# get(key) → {any}

Gets a value

Parameters:
Name Type Description
key string
Overrides:
  • Feature#get
any

# getBoundingBox() → {Extent}

Get extent/bounding box for feature geometry in geographic coordinates [minx, miny, maxx, maxy]

Overrides:
  • Feature#getBoundingBox

bounding box

Extent

# getGeometry() → {Geometry}

Get the feature's default geometry

Overrides:
  • Feature#getGeometry

The geometry for the feature.

Geometry

# getKeys() → {Array.<string>}

Get a list of object property names.

Overrides:
  • Feature#getKeys

List of property names.

Array.<string>

# getMeasurementInfo() → {Measure~Data}

Get all measurement info for this measure

measurement info for this shape

Measure~Data

# getProperties() → {Object.<string, *>}

Get an object of all property names and values.

Overrides:
  • Feature#getProperties

Object.

Object.<string, *>

# getStyle() → {Style}

Get the feature's style

Overrides:
  • Feature#getStyle

The feature style.

Style

# getType() → {string}

Return type of measure the values could be some of this ViewMode

ViewMode

string

# set(key, value)

Sets a value.

Parameters:
Name Type Description
key string

Key name.

value any

Value.

Overrides:
  • Feature#set

# setGeometry(geometry)

Set the default geometry for the feature.

Parameters:
Name Type Description
geometry Geometry

The new geometry.

Overrides:
  • Feature#setGeometry

# setProperties(values)

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Parameters:
Name Type Description
values Object.<string, *>

Values.

Overrides:
  • Feature#setProperties

# setStyle(styleopt)

Set the style for the feature to override the layer style. This can be a single style object, an array of styles, or a function that takes a resolution and returns an array of styles. To unset the feature style, call setStyle() without arguments or a falsey value.

Parameters:
Name Type Attributes Description
style Style <optional>

Style for this feature.

Overrides:
  • Feature#setStyle

# toGeoJSON() → {string}

Convert feature geometry to GeoJSON string with xy coordinates [long, lat]

Overrides:
  • Feature#toGeoJSON
string

# toWKT() → {string}

Convert feature geometry to WKT string with xy coordinates [long, lat]

Overrides:
  • Feature#toWKT
string

Events

# FEATURE_CLICK

Event triggered when measure receives a click

Parameters:
Name Type Description
location Location

Location with the coordinates for this event

measure Measure

Measure clicked

layer VectorLayer

Layer for this feature

Overrides:
  • Feature#event:FEATURE_CLICK

# FEATURE_HOVER

Event triggered when hovering over a measure

Parameters:
Name Type Description
location Location

Location with the coordinates for this event

layer VectorLayer

Layer for this feature

hover boolean

If the feature it's hover or not. False it's triggered when pointer not intersect when the geometry

Overrides:
  • Feature#event:FEATURE_HOVER

Documentation generated by Vexcel Imaging