Title

Global

Type Definitions

Object

AppConfig

Properties:
Name Type Description
appSettings Object.<string, string>
menuInfo Object.<string, Array.<Object>>
*[#].categoryKey string
*[#].iconUrl string
*[#].menuImageUrl string
*[#].name string
translations Object
venueImages Object.<string, string>
Example
{
     appSettings: {},
         menuInfo: {
             mainmenu: [
             {
                 categoryKe: "CANTEEN",
                 name: "Canteen",
                 menuImageUrl: null,
                 iconUrl: "https://app.mapsindoors.com/mapsindoors/gfx/mapspeopledemo/cat-canteen.png"
             },
             {
                 categoryKey: "MEETINGROOM",
                 name: "Meeting Room",
                 menuImageUrl: null,
                 iconUrl: "https://app.mapsindoors.com/mapsindoors/gfx/mapspeopledemo/cat-meetingsrooms.png"
             },
             {
                 categoryKey: "OFFICE",
                 name: "Office",
                 menuImageUrl: null,
                 iconUrl: "https://app.mapsindoors.com/mapsindoors/gfx/mapspeopledemo/cat-offices.png"
             }]
     },
     venueImages: {
             rtx: "https://app.mapsindoors.com/mapsindoors/gfx/defaultvenue.png"
     },
     translations: {}
}
Object

Building

Properties:
Name Type Description
administrativeId string
anchor Point Anchor is a GeoJSON Point at the center of the building.
buildingInfo Object BuildingInfo contains all translatable informations for a building.
aliases Array.<string> A list of aliases.
language string Current language.
name string Name of the building
createdAt dateTime *Only pressent in the detailed format
floors Object.<number, BuildingFloor> List of all in the building. See Floor
*.geometry Geometry The geometry of the floor. See GeoJSON Geometry
*.name string Floor name
geometry Geometry The geometry of the building. See GeoJSON Geometry
id string The building id.
lastModified dateTime *Only pressent in the detailed format
Object

BuildingOutlineOptions

Properties:
Name Type Attributes Description
strokeColor string <optional>
 Sets the color for the building outline. The strokeColor property is specified a css color value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
strokeWeight number <optional>
 Sets the weight of the building outline in pixels.
strokeOpacity number <optional>
 Sets the opacity of the building outline. The opacity property is specified as a value between 0 and 1. See https://developer.mozilla.org/en-US/docs/Web/CSS/opacity
Object

Category

Properties:
Name Type Description
key string
value string
Object

DirectionsRendererOptions

Properties:
Name Type Attributes Description
mapsindoors MapsIndoors Sets the mapsindoors instance.
map google.maps.Map <optional>
 Sets the map on which the route will be rendered.
visible boolean <optional>
 Sets the initial visibility of the route.
strokeColor string <optional>
 Sets the color that the route will be displayed with. The color property is specified a css color value. See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
strokeOpacity number <optional>
 Sets the opacity of the route. The opacity property is specified as a value between 0 and 1. See https://developer.mozilla.org/en-US/docs/Web/CSS/opacity
strokeWeight number <optional>
 Sets the weight of the route in pixels.
zIndex number <optional>
 Sets the zIndex of the route on the map.

DirectionsResult

See Google Maps DirectionsResult for reference.
Properties:
Name Type Description
routes Route
status string
Object

DisplayRule

Properties:
Name Type Description
icon string Icon url.
imageScale number
imageSize Object
label string Label template.
labelZoomFrom number Minimum zoom level a label should be displayed at.
labelZoomTo number Maximum zoom level a label should be displayed at.
visible boolean Determines whether an icon + label should be visible or not.
zoomFrom number Minimum zoom level a icon should be displayed at.
zoomTo number Maximum zoom level a icon should be displayed at.
Example
{
  "icon": "https://app.mapsindoors.com/mapsindoors/gfx/default/poi.png",
  "imageScale": null,
  "imageSize": null,
  "label": "{{name}}",
  "visible": true,
  "zoomFrom": 19,
  "zoomTo": 21,
  "labelZoomFrom": null,
  "labelZoomTo": null
}
Object

DistanceMatrixResult

mapsindoors.DistanceMatrixResult
Properties:
Name Type Description
destination_addresses Array.<string>
origin_addresses Array.<string>
rows Array.<Object>
distance Object.<{text: string, value: number}>
duration Object.<{text: string, value: number}>
status string
Object

LabelOptions

Properties:
Name Type Attributes Description
maxLength number <optional>
 Maximum numbers of charectors to display. If exceeded the label will be truncated and "..." will be added to the end.
pixelOffset google.maps.Size <optional>
 For offsetting the label horizontal and/or vertical. A negative width will offset the label to the left and a negative height will offset the label upward. Can be specified as a object literal `{width: number, height: number}`. See https://developers.google.com/maps/documentation/javascript/reference/coordinates#Size
style LabelOptionsStyle <optional>
 For styling the label. Style
Object

Leg

See Google Maps DirectionsLeg for reference.
Properties:
Name Type Description
start_address string
start_location Object
end_address string
end_location Object
steps Array.<Step>
distance Object.<{string: text, number: value}>
duration Object.<{string: text, number: value}>
Feature

Location

See GeoJSON Feature
Properties:
Name Type Description
id string
type string
geometry Geometry See GeoJSON Geometry
properties Properties Properties
aliases Array.<string>
anchor string
building string
categories Object.<string, string>
displayRule Object
floor string
floorName string
imageURL string
locationType string
mapElement string
name string
roomId string
type string
venue string
Object

MapsIndoorsOptions

Properties:
Name Type Attributes Description
map google.maps.Map The Google Map instance that MapsIndoors will be bound to. See google.maps.Map
venue string <optional>
 Id of the initial venue.
buildingOutlineOptions BuildingOutlineOptions <optional>
 Settings for the polygon outlining the building thats in focus.
labelOptions LabelOptions <optional>
 Styling options for labels on the map.
Object

MapStyle

Properties:
Name Type Description
displayName string The display name for the map style.
folder string The folder where the map style are located.
Object

ReverseGeoCodeResult

Properties:
Name Type Description
building Object
id string Id of the building.
name string Name of the building.
floors Object.<string, string> List of floors in the building.
venue Object
id string Id of the venue.
name string Name of the venue.
Object

Route

See Google Maps DirectionsRoute for reference.
Properties:
Name Type Description
summary string
bounds Object
copyrights string
warnings Array.<string>
legs Array.<Leg>
overview_polyline Object.<{string: points}>
Object

Solution

Properties:
Name Type Description
availableLanguages Array.<string>
createdAt string
createdBy string
customerId string
defaultLanguage string
expirationDate string
id string
implementationType string
lastModified string
lastModifiedBy string
locationTemplate string
mapClientUrl string
minimumVersion string
modules Array.<string>
name string
types Array.<Type>
whitelabel boolean
Object

Step

See Google Maps DirectionsStep for reference.
Properties:
Name Type Description
distance Object.<{string: text, number: value}>
duration Object.<{string: text, number: value}>
end_location string
geometry Array.<Object>
highway string
abutters string
html_instructions string
maneuver string
start_location Object
travel_mode string
Object

Type

Properties:
Name Type Description
displayRule DisplayRule Rules for how and when to display a location of the given type.
icon string Url to type icon.
name string Name of the type.
searchkeys Array.<string> List of alias/searchkeys.
Object

Venue

Properties:
Name Type Description
anchor Point See GeoJSON Points
createdAt dateTime *Only pressent in the detailed format
defaultFloor string
entryPoints Array.<Point> See GeoJSON Points *Only pressent in the detailed format
floorNames Object.<string, string>
geometry Geometry See GeoJSON Geometry
graphId string
id string
lastModified dateTime *Only pressent in the detailed format
name string
solutionId string
styles Array.<{string: displayName, string: folder}>
tilesUrl string
venueInfo VenueInfo VenueInfo
aliases string A list of alisas for the venue.
language string Current language.
name string The name of the venue.