Global

Type Definitions

ajaxConfig

Type:
  • object
Properties:
Name Type Attributes Default Description
method string <optional>
 GET the http method for the ajax call
payload string <optional>
 the body for PUT/POST calls
mimeType string <optional>
 the mime type for the ajax call

itemIteratorFunction(index, object) → {boolean}

Parameters:
Name Type Description
index number the step counter
object object the current object
Returns:
return false to stop iterating
Type
boolean

location

Represents a latitude/longitude pair
Type:
  • object
Properties:
Name Type Description
lat Number
lng Number

mapDataLoadConfig

Type:
  • object
Properties:
Name Type Description
style string Path to the map's style JSON file.
venueId string the venue's id

mapViewCameraConfig

Camera configuration parameters
Type:
  • object
Properties:
Name Type Attributes Description
center location the position of the camera
minZoom Number <optional>
 the minimum zoom level of the camera. Defaults to 1.0s
maxZoom Number <optional>
 the maximum zoom level of the camera. Defaults to 21.0
zoomLevel Number <optional>
 the current zoom level of the camera. Defaults to 17.0
bearing Number <optional>
 the bearing of the camera. Defaults to 0.0
pitch Number <optional>
 the camera pitch. Defaults to 0.0
enableScrollZoom boolean <optional>
 enable zooming the map in/out via the mouse scroll wheel. Defaults to true.
enableDragRotate boolean <optional>
 enable rotating the map by dragging with the mouse. Defaults to true.
enableDoubleClickZoom boolean <optional>
 enable zooming IN the map by double-clicking. Defaults to true.
enableKeyboardShortcuts boolean <optional>
 enable manipulating the camera via keyboard controls. Defaults to true.
enableBoxZoom boolean <optional>
 enable zooming the map in/out via dragging a box around the zoom area. Defaults to true.
enableHash boolean <optional>
 enable syncing the camera position with a URL hash. Defaults to true.

mapViewLoadConfig

Type:
  • object
Properties:
Name Type Attributes Description
venueBaseURL string Base url for all venue map data files for a specific venue.
useDefaultMapProvider boolean true to use the embedded Mapbox map provider or false to use a custom map (or none) map provider, e.g. Google maps
accessToken string <optional>
 Mapbox access token. Required when useDefaultMapProvider is true.
streetMapJSON string <optional>
 Mapbox style for world/street map tiles. Required when useDefaultMapProvider is true.
streetMapURL string <optional>
 Mapbox vector tiles source url for world/street map tiles. Required when useDefaultMapProvider is true.
mapGlyphsURL string <optional>
 url pointing to font glyph files (in proto-buff format)
mapSpritesURL string <optional>
 url pointint to the spritemap files for icons and textures that are referenced in your map view.
tilesetURL string <optional>
 Specify a custom location for your venue's vector tiles
commonTilesetURL string <optional>
 Specify a custom location for your venue's icon/label vector tiles
buildingOutlines string <optional>
 Specify a custom location for your venue's building outlines vector tiles
rasterTilesetURL string <optional>
 Specify a custom location for your venue's raster map tiles.
rasterBuildingOutlinesURL string <optional>
 Specify a custom location for your venue's building outlines raster tiles
artTilesetURL string <optional>
 Specify a custom location for your venue's artistic map tiles.
showZoomControls boolean <optional>
 adds map controls for zooming in and out. Defaults to false.
showCompassControls boolean <optional>
 add map controls that show the compass. Defaults to false.
controlsPosition boolean <optional>
 specificy the position to add map controls. Valid values are "top-left", "top-right" , "bottom-left" , "bottom-right". Defaults to "top-right".

matchingFunction(item) → {boolean}

Parameters:
Name Type Description
item object the item to check if a match exists
Returns:
true if the item matches requirements, false otherwise
Type
boolean

onCompleteCallback(response, error)

Parameters:
Name Type Description
response object the responseObject
error string error message if anything

vmAnnotationPopup

Properties:
Name Type Attributes Description
options vmPopupConfig <optional>
 the config options for this popup
htmlElement object the htmlElement to present for this popup

vmCoordinateBounds

Represents a bounding rectangle in for a region on the map
Type:
  • object
Properties:
Name Type Description
sw location the southwest point of the rectangle
ne location the northeast point of the rectangle

vmDebugConfig

Properties:
Name Type Description
loggingEnabled boolean enables debug messages in the console. Defaults to false.
showBuildingBoundingBoxes boolean Shows a rectangle around venue builidings. Defautts to false.
showFloorBoundingBoxes boolean Shows a rectangle around floors. Defaults to false.
showVenueBoundingBox boolean Shows a rectangle around the entire venue. Defaults to false.
showTileBoundaries boolean Shows a rectangle around map tiles and other debug information. Defaults to false.

vmdFileCollection

Collection of properties to specify map data files to load
Type:
  • object
Properties:
Name Type Attributes Description
sitemapURL string <optional>
 Path to the sitemap (for legacy venue map data ONLY)
xml string <optional>
 Path to VMD's xml file
geojson string <optional>
 Path to VMD's geojson file
zipURL string <optional>
 Path to zip file containing venue map data

vmMapBuilding

Type:
  • object
Properties:
Name Type Description
id string the ID of the building
name string the name of the building
floors string list of floors associated with this building
bounds vmCoordinateBounds the sw/ne bounds of the floor
coordinates Array.<location> a list of coordinates that make up the perimeter of the floor
center location the center point of the building based on its bounds

vmMapBuildingFloor

Type:
  • object
Properties:
Name Type Description
id string the ID of the floor
name string the naem of the floor
buildingId string the id of the building this floor belongs
legacyId string the legacy id of the floor
ordinal number the floor ordinal
units Array.<vmMapUnit> list of units on this floor
bounds vmCoordinateBounds the sw/ne bounds of the floor
coordinates Array.<location> a list of coordinates that make up the perimeter of the floor

vmMapUnit

Type:
  • object
Properties:
Name Type Attributes Description
id string the id of the unit
name string the label associated with the unit
floorId string the id of the floor this unit is associated with
coordinates Array.<location> a list of coordinates that make up this unit
centerLocation location the calculated center of the unit. This will not be accurate for oddly shaped units.
labelLocation location <optional>
 the location of the label for units that have labels
iconLocation location <optional>
 the location of the icon for units that have icons
hotspotLocation location <optional>
 the location of the hotspot for units that have them
icon string <optional>
 the name of the icon for units that have them

vmPointAnnotation

Properties:
Name Type Attributes Description
id string the id of the annotation
floorId string the id of the floor that the annotation is visible on
htmlElement object <optional>
 the html element to present for this map annotation
location location the location of the map annotation
popup vmAnnotationPopup <optional>
 a popup to display when this annotation is selected

vmPopupConfig

Properties:
Name Type Attributes Description
closeButton boolean <optional>
 show or hide an X close button for the popup. Defaults to true.
closeOnClick boolean <optional>
 close the popup when user clicks anywere outside of the popup. Defaults to true.
anchor string <optional>
 where to anchor the popup to, relative to its parent annotation. Possible options are 'center' , 'top' , 'bottom' , 'left' , 'right' , 'top-left' , 'top-right' , 'bottom-left' , and 'bottom-right'
offset number <optional>
 Additional amount in pixels to offset the popup
maxWidth number <optional>
 The maximum width for the popup container

vmVenueLayerStyle

This class represents all of the stylistic properties that can be configured for display of a map's style
Type:
  • object
Properties:
Name Type Attributes Description
fillColor string <optional>
 The fill color for this layer, which will only applies to polygon layers. This property ignored if fillPattern is not null.
fillPattern string <optional>
 The name of the fill pattern to use for this layer, which only applies to polygon layers. The fill pattern must exist by the same name as one of the sprites in the map sprite sheet.
outlineColor string <optional>
 The outline color for this layer, which only applies to polygon layers.
fontName string <optional>
 The name of the font to use for this layer, which only applies to text layers. The font must exist by the same name in your mapview's font glyph url
fontSize string <optional>
 The size of the font
fontColor string <optional>
 The color of the font
fontStrokeColor string <optional>
 The stroke color of the font
fontStrokeWidth string <optional>
 The stroke width of the font
maxTextWidth string <optional>
 The max width a label can be before it wraps to another line
Since:
  • 1.2.1

wayfindingLoadConfig

Wayfinding settings