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

Extent

Extent(coords)

This class involves a set of coordinates that are used to represent a rectangular area on the map. These coordinates create an extent, or a bounding box, which are often used for setting the map view. They are also very useful for doing calculations.

Constructor

# new Extent(coords)

Parameters:
Name Type Description
coords Array.<number>

The latitude of the location.

Example

Create simple extent object

const extent = new Vexcel.Geometry.Extent([20,10,-20,-10]);

Classes

Extent

Methods

# buffer(value) → {Extent}

Return extent buffered by the provided value.

Parameters:
Name Type Description
value number

The amount by which the extent should be buffered.

Extent

# clone() → {Extent}

Make a complete copy of the Extent.

Clone

Extent

# containsExtent(extent) → {boolean}

Check if one extent contains another.

An extent is deemed contained if it lies completely within the other extent, including if they share one or more edges.

Parameters:
Name Type Description
extent Extent
boolean

# containsLocation(location) → {boolean}

Check if the passed location is contained or on the edge of the extent

Parameters:
Name Type Description
location Location
boolean

# getCenter() → {Location}

Get the center Location of an extent

Location

# intersection(extent) → {Extent}

Get the intersection with other extent.

Parameters:
Name Type Description
extent Extent
Extent

# intersects(extent) → {boolean}

Determine if one extent intersects another.

Parameters:
Name Type Description
extent Extent
boolean

Documentation generated by Vexcel Imaging