logo
Documentation
Tutorials
Getting Started Initialization Layers Third party Controls Geometries Vector styles Measures InfoBox
Releases

Documentation

Modules

  • Constants

Events

  • FEATURE_CLICK
  • FEATURE_HOVER
  • CHANGE_MEASURE
  • CLICK
  • FEATURES_CLICK
  • FIND_IMAGES_LOADED
  • LAYER_AOIS
  • MAP_INITIALIZE
  • MOVE_END
  • POINTER_MOVE
  • 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
  • VexcelLayer

Classes

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

Measurements

Classes / Tools

  • LineTool
  • PointTool
  • PolygonTool

Classes

  • Measure

Services

Classes

  • UserService

Styles

Classes

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

Class

MeasurementManager

MeasurementManager

The Measurement Manager class handles measurement logic. Use this class to change measurement units from feet to meters, enable tooltips, and activate/deactivate specific tools.

Classes

MeasurementManager

Methods

# activate(tool)

Activates specified tool

Parameters:
Name Type Description
tool module:constants~MeasurementTools

tool to activate

See:
  • MeasurementTools

# changeAreaUnits(unit)

Sets the area units to be shown by the tool.

Parameters:
Name Type Description
unit AreaUnits

Imperial or metric value from AreaUnits

See:
  • AreaUnits

# changeLengthUnits(unit)

Sets the length units to be shown by the tool.

Parameters:
Name Type Description
unit LengthUnits

Imperial or metric value from LengthUnits

See:
  • LengthUnits

# changeMeasureUnits(system)

Changes measurement system for tools. Changing measurement system will automatically choose the most appropriate measurement unit for each measurement.

Parameters:
Name Type Description
system MeasureSystems

Imperial or metric value from MeasureSystems

See:
  • MeasureSystems

# changeSlopeUnits(unit)

Sets the slope units to be shown by the tool.

Parameters:
Name Type Description
unit SlopeUnits

Imperial or metric value from SlopeUnits

See:
  • SlopeUnits

# clear()

Clear all features

# deactivate(tool)

Deactivates specified tool

Parameters:
Name Type Description
tool module:constants~MeasurementTools

tool to deactivate

See:
  • MeasurementTools

# disableTooltips()

Hides measurement tooltips

# enableTooltips()

Shows measurement tooltips

# getDrawingLayer() → {VectorLayer}

Returns the vector layer used for vector drawing.

Drawing layer

VectorLayer

# getMeasurementLayer() → {GroupLayer}

Returns the vector layer used for make and save measurements.

Measurement Layer

GroupLayer

# hasMeasurementActive() → {boolean}

Checks to see if any measurement tools are active. Returns 'true' if one or more tools are active

boolean

# toggleEdit()

Toggles Edit Mode for measurement tools

Documentation generated by Vexcel Imaging