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

InfoBox

InfoBox(options)

An element to be displayed over the map and attached to a single map location. Overlays are visible widgets, they are not in a fixed position on the screen, but are tied to a geographical coordinate, so panning the map will move an Overlay but not a Control.

Learn how to implement an InfoBox in our InfoBox fixed and InfoBox on click tutorials.

Constructor

# new InfoBox(options)

Parameters:
Name Type Attributes Description
options options

Extend Overlay options

location Location <optional>

Location object with the coordinates for popup

content string <optional>

Html content to show in the info popup

class String <optional>

the a class of the overlay to style the popup.

anim boolean <optional>

Animate the popup the popup, default false.

closeBox bool <optional>

popup has a close box, default false.

onclose function | undefined <optional>

callback function when infobox is closed

onshow function | undefined <optional>

callback function when infobox is shown

offsetBox Number | Array.<number> <optional>

an offset box

positioning string <optional>

the 'auto' positioning var the popup choose its positioning to stay on the map. Possible values are 'bottom-left', 'bottom-center', 'bottom-right', 'center-left', 'center-center', 'center-right', 'top-left', 'top-center', and 'top-right'.

Classes

InfoBox

Methods

# hide()

Hide and remove from map

# show(locationopt, contentopt)

Set the position and the content of the popup.

Parameters:
Name Type Attributes Description
location Location <optional>

Location object with the coordinates for popup

content string <optional>

Html content to show in the info popup

Documentation generated by Vexcel Imaging