Micello SDK for Leaflet Reference Documentation

The following is the reference material for the Micello Maps SDK for Leaflet. | SDK Releases 

Classes & Factories

Community | Map Layer | Interactions | Navigation | Window | Directory Display | Position Events

Commonly Used Objects

Community | Drawing | Level | Geometry | Entity | Community Directory | Theme

Examples using this SDK can be found here.

Community  ^

The base class for adding a community to the Leaflet SDK. This base class will also instantiate the Map Layer, Interactions and Navigation classes and hold references to these objects with accessors available. Extends Evented.

Options

Option Type Description Default
key String The key used for authentication to access data from the file server null
mv Integer The map version to load - Wildcard. The latest available will be served. An explicit version can be set.
ev Integer The entity version to load - Wildcard. The latest available will be served. An explicit version can be set.
did Integer The drawing ID for a drawing that should loaded at the outset of the map load.  The root drawing of the map. If this ID is invalid, it will load the available root drawing.
lid Integer The level ID for a level that should be loaded at the outset of the map load The root (main) level of the drawing to load. If this ID is invalid, it will load the available root level of the chosen drawing.
lang String The language to load (if translation is available) Community Default Language
themeOverride String The qualified Theme Object derivation to be applied to the map. If set, this takes precedence over any other theme options. null
themeName String The named theme to use, if available Standard
themeUrl URL The URL of the theme to use (a fully qualified URL which serves a qualified theme is required). If set, this takes precedence over the themeName. null
themeMapOverride String The JSON of the thememap to be applied to the map. If set, this takes precedence over any other thememap options null
themeMapName String The name of the thememap to use. Standard
themeMapUrl URL The URL of the thememap to use (a fully qualified URL which serves a qualified themeMap is required) null
stringsOverride String The qualified JSON strings snippet to be applied to the map. If set, this takes precedence over any other strings options. null
stringsName String The name of the Strings file (translations) to use Standard
stringsUrl URL The URL of the strings file to use (a fully qualified URL which serves a qualified strings file is required). If set, this takes precedence over the stringsName.  
interact Boolean Determines if the default map click behavior occurs. If disabled, the indoorClick event will still fire, but the Preview window will not display. true
levelUIPosition String Position for the level control UI for selecting levels. Only appears if there are more than one level. Possible values are 'topleft', 'topright', 'bottomleft' or 'bottomright'. topleft (ordered below drawing if it appears)
levelControlMax Integer The max number of levels to show in the Level Control  -- anything over will utilize a down / up arrow 6
drawingUIPosition String Position for the drawing control UI for selecting a drawing. Only appears if there are more than one drawing. Possible values are 'topleft', 'topright', 'bottomleft' or 'bottomright'. topleft
singleMap Boolean Determines if the community displayed should be treated as a single community (as opposed to multiple communities showing at once). If true, the Map Bounds will be restricted and the user will not be able to pan away from the community. false
centerCommunity Boolean Determines if the map will be respositioned at the center coordinates of the community and the initial view of the community is fit into the viewport bounds. Setting this to true also makes the Leaflet map options "center" and "zoom" optional at instantiation because the centerCommunity feature will handle this task. If false, the position remains as set during the Leaflet instantiation with no bounding update and the "center" and "zoom" option are required. true
winMaxWidth Integer The default maximum allowed width (in pixels)  the Window class will allow the viewport width to be before it forces the window to the same size as the viewport. On custom window instantiations, this can be overridden. Also used with the Window class. 450
winMaxHeight Integer The maximum allowed height (in pixels)  the Window class will allow the viewport height to be before it forces the window to the same size as the viewport. This does not apply to “small” windows. Also used with the Window class. 750
navFindView String The initial window to show to find the starting point in a Navigation route request. Possible options are 'search' or 'map'. Used with the Navigation class. search
navOptions Array The types of navigation options to offer once a route is discovered. The first option in the array is the default used when the route is loaded. Options include: 'map' - just shows the route only; 'directionMinimal' -which shows a single direction at the top of the screen and the focusd navigation route on the map; 'directionList' - which shows only the direction list and no map; 'photo' which shows only the photo navigation and no map; Used with the Navigation class. ['map']
navWindow Boolean Boolean for whether to show the navigation window at all. If false, only the route on the map shows regardless of the navOption(s) chosen. true
navOptionLabel Object The labels to display on the buttons in the navigation windows. 

{
directionMinimal: 'Directions',
directionList: 'List',
map: 'Map only',
 photo: 'Photos',
exit: 'Exit route'
}

measure String The units to display (typically seen in the navigation layer). Choice is 'metric' or 'imperial'.  imperial
photoNavNextArrow HTML The markup for the next arrow displayed in Photo Nav. Also used with the Navigation class. ❱
photoNavBackArrow HTML The markup for the back arrow displayed in the Photo Nav. Also used with the Navigation class. ❰
photoNavArrowWidth Integer The width, in pixels, of the markup used for the next and back arrow. Also used with the Navigation class. 50
directionNavNextArrow HTML The markup for the next arrow displayed in the Direction Minimal Display. Also used with the Navigation class. ❱
directionNavBackArrow HTML The markup for the next arrow displayed in the Direction Minimal Display. Also used with the Navigation class. ❰
directionNavArrowWidth Integer The width, in pixels, of the markup used for the next and back arrow in the Direction Minimal display Also used with the Navigation class. 25
directionNavArrowHeight Integer The height, in pixels, of the markup used for the next and back arrow in the Direction Minimal display Also used with the Navigation class. 25
navStartIcon L.Icon The icon used to signify the start of a navigation route. Must be a L.Icon object. Also used with the Navigation class. L.Icon
navWaypointIcon L.Icon The icon used to signify a waypoint in a navigation route. Must be a L.Icon object.. Also used with the Navigation class. L.Icon
navEndIcon L.Icon The icon used to signify the destination point of a navigation route. Must be a L.Icon object. Also used with the Navigation class. L.Icon
navLevelChangeIcon L.Icon The icon used to signify the level change point (which is also clickable) of a navigation route. Also used with the Navigation class. L.Icon
navFlyToDuration Float The fraction of a second used to fly to the next navigation focused spot.  .15
directory Object The object of properties for the Directory Display. Please see the Directory Display Options for the properties of this object.  
geoposition Object The object of properties for the Position. Please see the Position Options for the properties of this object.  
loadingDisplay DOM Element The loading display when a map is loading on a device. This can be set to an empty div element to remove the loading display altogther. Micello status graphic

Creation

Factory Description
L.micello.community (CommunityId, options) The base call to instantiate a community on a Leaflet map

Methods

Function Returns Description
addTo (Leaflet map) this Adds the community to the Leaflet map
removeFrom (Leaflet map) this Removes the community from the Leaflet map
getCommunityData Community Data Object Returns the community data object
getCommunityDirectory Community Directory Object Returns the community directory object
getDirectory Directory Display Object Returns the directory display object (if enabled)
getGeoPosition Position Object Returns the Micello position object
getDrawingData (Drawing ID) Drawing Data Object Returns the drawing data object
getLevelInfo (Level ID) Level Info Object Returns the Level Info Object
getLevelData (Level ID) Level Data Object Returns the Level Data Object
getMapLayers Map Layers Object Returns the Map Layers object.
getNavigation Map Navigation Obect Returns the Navigation object
getInteract Map Interactions Object Returns the Map Interactions object (SDK default events / layers for map click)
getMap Leaflet map Returns the reference this SDK is holding for the Leaflet map
getTheme Theme Returns the currently loaded theme object
getThemeMap ThemeMap Returns the currently loaded thememap object
setMapLang Boolean Sets the current language the SDK will use
getMapLang string Returns the currently set SDK language
getMapDefaultLang string Returns the default language for the community
hitCheck (Array [Longitude, Latitude], (optional) Current Zoom) Geometry If the Latitude, Longitude coordinates intersect with a geomtry, that geometry is returned. This uses the current active layer (level). If zoom is omitted, the current zoom is used. This returns the topmost geometry found.
latLonToMxy(lat, lon, (Optional) Level Info Object) Array Returns the MX/MY coordinates in array [mx,my]. If the Level Info Object is omitted, the active level is used.
mxyToLatLon(mx, my, Level Info Object) Array Returns the Lat/Lon coordinates in array [lat, lon]. (Note that the Level Info Object is required here)
getGeomById (Geometry ID, Boolean Isolated, (optional) Level Info Object) Geometry Returns the requested geometry if it exists. If Isolated is set to true, grouped geometries will not be considered. If the Level Object is not included, the active level will be used. Note that the geometry needs to exist on the given level to be returned.
getGeomByAddress (Address, (optional) Level Info Object) Geometry Returns the requested geometry if it exists. If the Level Object is not included, the active level will be used. Note that the geometry needs to exist on the given level to be returned.
getLevelGeometries(Level ID) Integer Initiates the process for loading the level with the geometries and the respective geometry data. The "indoorLevelGeomRequested" event will fire upon initiation and the "indoorLevelGeomLoaded" will fire when completed. 

 

Map Layer  ^

The class to handle the Leaflet layers rendered with the Community data. The Community Base Class instantiates this at run time and holds a reference to it with an available accessor. Extends Layer.

Creation

Factory Description
L.micello.maplayer (Community Base Class, options) The controlling class for the level and drawing interfaces. The Community base class holds a reference to this created object at run time.

Methods

Function Returns Description
setDrawing(<Number> Drawing ID) Boolean Sets the drawing
setLevel (<Number> Drawing ID, <Number> Level ID Boolean Sets the level on the Community if the given drawing and level arguments are present
getActiveLayer Layer  Returns the active SDK layer (which contains a reference to the level)
getLayer (<Number> Level ID) Layer Returns the given layer (which contains a reference to the level)
getActiveDrawing Drawing Returns the active drawing
getActiveLevel Level Returns the active level
getTileLayerMap GridLayer Object(s) indexed by Level ID Returns the Level ID indexed list of GridLayer objects used to render the map.

 

Map Layer: Level Control

The class to control the Level selector (if present -- communities with one level will not show a level selector). This class is primarily controlled by the Map Layer class and is generally not called directly. All options are handled at load time and are listed above. Various events are related this class and are listed in the event section below. Extends Control

Creation

Factory Description
L.micello.levelcontrol (Map Layer Object, options) The factory to add the Level Contol to the community

Map Layer: Drawing Control

The class to control the Drawing selector (if present -- communities with one drawing will not show a drawing selector). This class is primarily controlled by the Map Layer class and is generally not called directly. All options are handled at load time and are listed above. Various events are related this class and are listed in the event section below. Extends Control

Creation

Factory Description
L.micello.drawingcontrol (Map Layer Object, options) The factory to add the Drawing Contol to the community

Map Layer: Drawing Window

The class to control the Drawing window for choosing a different drawing. This class is primarily controlled by the Map Layer class and is generally not called directly. All options are handled at load time and are listed. Various events are related this class and are listed in the event section below. Extends Layer

Creation

Factory Description
L.micello.drawingwindow (Drawing Control Object, options) The factory to add the Drawing Window to the community

Map Layer: GridLayer

The Micello inerface to the Leaflet GridLayer class. This class is primarily controlled by the Map Layer class and is generally not called directly. Extends Gridlayer

Creation

Factory Description
L.micello.gridlayer(Level Object, Community Base Obect, options) The factory to instantiate a gridlayer object for rendering purposes

Methods

Function Returns Description
getRenderer Micello Renderer Returns the renderer used in this GridLayer object

 

Navigation  ^

The base class for Navigation. This class controls the entire navigation experience from setting the destination end points to displaying the directions. The Community Base Class instantiates this at run time and holds a reference to it with an available accessor. Extends Class.

Creation

Factory Description
L.micello.navigation (Community Base Object, options) Create a navigation factory for displaying a route on the map. The Community Bae Object holds a reference to this at run time.

Methods

Function Returns Description
getMapControl Community Base Class Returns the reference community base object used in creating the navigation
getRouteData Navigation Route Data Object Returns the navigation route data object
addTo (Geometry) this Adds the default interface for setting the starting point of a route (end point is set, in the Navigation object, via the Preview Window). Default is the Find By Directory method.
findByDir this Instantiates the Navigation Find Starting Point By Directory feature.
findByMap this Instantiates the Navigation Find Starting Point By Map feature.
distance (meters <Integer>) string Returns the distance display (based on setting) including how long to reach the intended destination
timeDisplay (seconds <Integer>) string Returns the natural language option for displaying time (i.e. instead of '90 seconds' use 'about a minute and a half')
turn (angle <Integer>) Array Returns a natural language direction based on the angle as well as a directional image
startpoint Array Returns a natural language direction based on the angle as well as a directional image
levelchange (Navigation segment) Array Returns a natural language direction based on the angle as well as a directional image
destination Array Returns a natural language direction based on the angle as well as a directional image
routeInit (routeFrom Roue Object, routeTo Route Object, routeDetails RouteDetails Object, adjusts Array of Adjust Objects, stops Array of Roue Objects this Kicks off the actual routing including start and end points as well as any potential adjustments or stops along the way. Upon successful completion an event will fire (indoorRouteLoaded) and the route object will be populated.
loadRouteMap this Displays the navigation route by drawing on the map only
loadRouteDirection this Displays the navigation route by drawing on the map and displaying the Directions window.
loadRoutePhoto this Displays the navigation route by drawing on the map and displaying the Photo navigation window.
exitRoute this Exit the navigation (and remove any navigation display)

 

Navigation: Find By Directory

The layer class to provide an interface for choosing the starting point for a route. Generally speaking , this layer is controlled by the Navigation class but can be called individually as needed. Extends Layer.

Creation

Factory Description
L.micello.navigationfindbydir(Navigation Object, options) The Navigation by Directory factory class

Methods

Function Return Description
loadDirectory (Community Directory Object) this Builds the usable directory array for this Navigation interface including sorting and searching.
buildDirectory (Directory Array) HTML Element The directory DOM ready for addition to an interface
searchDirectory (string Value, Directory Array) Array Given the value input, performs a "starts with" search on the given Directory array

 

Navigation: Find By Map

The layer class to provide an interface for choosing the starting point for a route. Generally speaking , this layer is controlled by the Navigation class but can be called individually as needed. Extends Layer.

Creation

Factory Description
L.micello.navigationfindbymap(Navigation Object, options) The Navigation by Map factory class

 

Navigation Route: Map

The layer class to add the interface for the base route display (map only). While the actual route rendering is handled by the Navigation Route Data class, this layer class manages the window display and the adding / removal of the route. Extends Layer.

Creation

Factory Description
L.micello.navigationroutemap(Navigation Object, Navigation Route, options) The factory to add the interface for the basic Route on the map

 

Navigation Route: Direction

The layer class to add the interface for the navigation by directions. While the actual route rendering is handled by the Navigation Route Data class, this layer class manages the window display and the adding / removal of the route. Extends Layer.

Creation

Factory Description
L.micello.navigationroutedirection(Navigation Object, Navigation Route, options) The factory to add the interface for the Navigation by Directions

 

Navigation Route: Photo

The layer class to add the interface for the navigation by photos. While the actual route rendering is handled by the Navigation Route Data class, this layer class manages the window display and the adding / removal of the route. Extends Layer.

Creation

Factory Description
L.micello.navigationroutephoto(Navigation Object, Navigation Route, options, loadTo) The factory to add the interface for the Navigation by Photos. Optionally providing the loadTo (integer) loads the Photo Navigation to a specific photo in the index of directions.

 

Navigation Route Data

The class to handle the interface to the route data as well as render the path of the community. Extends Class.

Creation

Factory Description
L.micello.navigationroutedata(Navigation Object, Navigation Route Data, options) The factory to hold the route data and interface and render the path on the community.

Methods

Function Return Description
getCommunityId Integer Returns the community ID of this route data
getCommunityMapVersion Integer Returns the community map version of this route data
getLanguage string Returns the language set on this route data
getfT string Returns the FT on this roue data (?)
getSegments Array Returns the array of navigation segments 
getSegmentDistance (segment) Integer Returns the distance set in the given segment
getLandmarks (segment) Array Returns the array of navigation landmarks
getPath Object Renders the navigation path and returns a location object for the starting point
removePath this Removes the currently rendered navigation layer

 

Interactions  ^

The default SDK handling of clicks on a community. This is an optional clas as the 'interact' commmunity option controls whether this is used. This class controls the Preview and Info Window displays. The Community Base Class instantiates this at run time and holds a reference to it with an available accessor.  Extends Class.

Creation 

Factory Description
L.micello.interact(Community Base Object, options) Establish the interactions class to handle a click on the community

Methods

Function Return Description
clickHandlerOn this Turns on the click handler event
clickHandlerOff this Turns off the click handler event
clearAttribution   Clears any and all attributions set across the whole map

 

Interactions: Preview Window

The class to handle the display of the Preview Window (when the interactions class is active, this is the generally what appears first after a click). Extends Layer.

Creation

Factory Description
L.micello.previewwindow (Interact Object, Geometry) The preview window class 

 

Interactions: Info Window

The class to handle the display of the Preview Window (when the interactions class is active, this is the generally displayed after the Info link in the Preview window is clicked). Extends Layer.

Creation

Factory Description
L.micello.infowindow(Interact Object, Preview Window Object) The Info window class

 

Window  ^

The class to add a window to the community and manage via the interface. Extends Layer.

Creation

Factory Description
L.micello.window (Community Base Object, options) Instantiate a window and add to the community

Options

Option Type Default Description
type String small One of two options: big or small which generally sets the size of the window
content HTML Element null The HTML Element to be added to the content area on window load
title HTML Element null The HTML Element to be added to the title area on window load
menu Array Array Array of menu items to be added as the menu at the bottom of the window. Menu item object structure: {label: Text to be displayed, callback: Method to be fired when clicked }
titleHeight Integer 110 The fixed height of the title area
contentHeight Integer 0 The contentHeight which is set after the content is loaded
menuHeight Integer 40 The fixed height of the menu area
noScroll Boolean 0 Whether to allow scrolling or force scrolling into an off / on state
winMaxWidth Integer 450 Regardless of the viewport status, the maximum width the window can be at any given time
winMaxHeight Integer 750 Regardless of the viewport status, the maximum height the window can be at any given time
position String middle Determines the position of the window when placed on the map. Position options are "left", "middle", "right". The top is always set to 0 (top of the map)

Methods

Function Return Description
updateTitleArea (HTML Element) this Update the title area of the window (generally the top third if present)
updateContent this Update the content area of the window (generally the middle section)
updateMenu (Array Menu Items) this Update the menu area with the array of menu items sent in
getContentHeight Integer Returns the content section height of the window

 

Directory Display  ^

The following class is for the Directory Display. This display uses the community directory data and other sources to present an interactive directory to easily find entities, etc. Options for altering the Directory display and behavior are included in the Community Options. The theme / overall appearance of the Directory can be customized via a style sheet. Extends L.Control.

Options

Option Type Default Description
toggle Array entities, amenities Determine which Directory toggle tabs appear at the top of the Directory Display window. The options are "entities" which displays the entities in the desired "list order"; "amenities" which displays the map amenities such as bathrooms, ATMs, etc; "nearby" which displays the items nearest to a given position (which can be a cordinate position or chosen object). Note that if only one toggle is included, the toggle tabs will not appear.
entities_toggle_label String Entities The label that appears on the Toggle tab for entities (Note that there is a character limit)
amenities_toggle_label String Amenities The label that appears on the Toggle tab for amenities (Note that there is a character limit)
nearby_toggle_label String Nearby The label that appears on the Nearby tab for nearest items (Note that there is a character limit)
list_order String list by drawing and level Choice for how to display the entities on the Entities tab. Choices include: "list only" which displays all of the entities in one list alphabetically; "list by level" which displays the entities by level regardless of the drawings they appear in; "list by drawing" which displays the entities by drawing regardless of which level they appear on;  "list by drawing and level" which displays the Entities alphabetically first by drawing, then by level within the drawing.
search_candidates Array address, amenities, name, category  When the search box at the top of the Directory Display is used, this determines which properties in the map to search on to get a result. Choices include the "address" which will search any available Internal Address for a result; "amenities" which will inclue the search for bathrooms, ATMs, etc; any entity property which, as defined in the default, includes "name" and "category" but any valid entity property can be included here. 
info_line Array address, level, drawing The smaller text informational line that appears below most entries in the Directory Display. These will appear i nthe order given in this array and will display the options given. Choices include "address" which displays the address of the item if one exists; "level" which displays the Level name that the item appears on; "drawing" which displays the Drawing name that the item appears on.
level_prefix String Level The string used in front of the Level whenever the level is displayed. (i.e. the term Floor might be used instead)
position String topleft The position of the Directory as determined by standard Leaflet position strings. Note that the Directory will always appear last if position with other map control items (level control, zoom control, etc)
no_display Boolean false If set true, the Directory will not display

Methods

Function Return  Description
getWin L.Window The L.Window instance that houses the Directory Display
optionUpdate (String option) this The caller can update what is displayed in the Directory by passing in the valid option ("entities", "amenities", "nearby"). Note that any one of these options needs to be included in the display.
near (Array coords [mx, my], Level Geometry) Object Given the proper arguments, this will return an array of objects sorted nearest first from the coordinates given. This is simply a spatial search and does not take anything into consideration (i.e. doors, paths, inaccessible space etc)

Creation

Factory Description
L.micello.directory (Map Layer, options) The directory display factory. Note that options are taken as an argument here but the Map Control handles the instantiation if the directory is enabled.

 

Position  ^

The position class to integrate a third party position supplier with the Micello map. Integration documentation can be found here.

Creation

Factory Description
L.micello.position (Map Control, options) The factory for instantiatin the position class. Note that the Map Control instantiates this class a map run time and can be accessed via the getGeoPosition function in the Community Object

Options

Option Type Default Description
enabled Boolean false Whether or not the position is enabled in the Micello map
callback Function null Provided by the position supplier, the function to call when a position is requested via getPosition. If this is null, the HTML5 Geolocation API is used.
supportCallback Function null Provided by the position supplier, the function to call when a suppot status of the current device is requested. This is optionally set and the function will always return true if this is left null and the callback option is not null. Otherwise, the HTML5 Geolocation API is used to determine support.
icon L.icon Blue Dot Image The icon to be used on the map to designate position. This is used when the Micello Level ID provided by the Position supplier matches the current level set on the drawing OR the drawing only has one level.
iconOpaque L.icon Opaque Blue Dot Image The icon to be used on the map to designate position. This is used when the Micello Level ID provided by the Position supplier does not match the current level set on the drawing OR whn the Level ID is not supplied by the Position supplier.

Methods

Function Return Description
setPosition (Position) this Given a valid Position object, the "blue dot" marker is updated to the given position and the "indoorPositionUpdate" event is fired. This is typically called by a position supplier. Note the position is not cached.
error (Error) this If an error occurs, the position supplier can notify the map by calling this function with the given error. This fires the event "indoorPositionError".
getPosition (function requestCallback) this When requested, this asynchronously calls the "callback" function set by the position supplier. When the Position supplier has ascertained the coordinates, the supplier will call the "requestCallback" function provided by the caller.
supported  Function supportCallback When called, the supplier must return a Boolean or some other notification object to determine support for the current device. This is optionally supplied by the Position supplier and if not set, always returns true.
enabled Boolean True or false which signifies whether the position is enabled in the map
removePosition this Removes the "blue dot" marker from the map

Events

Event Data Description
indoorPositionUpdate The Position object as provided by the supplier When he Position supplier sets the position, this event is fired
indoorPositionError The Error object as provided by the supplier When the Position supplier wants to report an error with the position

Position Object

Borrowed heavily from the W3C Geolocation API, the position object is what is used to integrate with Micello's maps. 

Property Type Description
coords Object

An object with the following properties: 

latitude: latitude in decimal degrees, required,

longitude: longitude in decimal degrees, required,

accuracy: in meters, required,

speed: meters / second or null if unknown,

heading: degrees of heading or null if unknown,

altitude: in meters or null if unknown,

altitudeAccuracy: in meters or null if unknown

timestamp Integer Unix epoch in microseconds
lid Integer Micello Level ID (optional, but a much better experience if included)

 

Events  ^

The following events are Indoor specific events fired by the SDK. All indoor events are fired from the Community base class.

Event Data Description
indoorClick Leaflet MouseEvent with additional “indoor” property describing what was clicked (i.e. geometry object, etc) Fired when a click occurs on an indoor related object
indoorPreviewMenuLoaded menu: Array of menu objects
indoor: convenience object included from indoorClick event
Upon loading of the preview Menu, typically after a click on the indoor map on an object that information to display (i.e. entity)
indoorInfoWindowLoaded content: DOM Object of content about to be displayed. 
indoor: convenience object included from indoorClick event
Upon loading of the Info Window, typically following a click of the info menu link in the Preview Window.
indoorMapError Error message in case of an indoor map error If an error occurs related to an indor map, this event will include the error
indoorLevelMatched Level object When the level has been matched (entities matched to geometries)
indoorGeomInlayAdded Inlay object and affected geometry object When an inlay has been added to the map (THIS HAS NOT BEEN IMPLEMENTED YET)
indoorGeomInlayRemoved Inlay object and affected geometry object When an inlay has been removed from the map
indoorCommunityRequested Community ID When a request is initiated to receive the community data (com-map file)
indoorLevelGeomRequested CID and Level ID of the requested When a request is initiated to receive the Level Geom file for the given parameters
indoorLevelGeomLoaded The level geometry object loaded When the request has completed successfully for the Level Geometry
indoorDrawingEntitiesRequested The Community ID and Drawing ID requested When the request for the  entities for a particular drawing is initiated
indoorDrawingEntitiesLoaded The drawing entities object When the drawing entities request has completed
indoorDirectoryRequested The community ID When the request for the community directory file has been initiated
indoorCommunityDataLoaded The map data object When the community has been loaded following a request for the com map file. This includes the completion of any relevant community  overrides.
indoorCommunityLoadComplete The indoor map has been completely loaded This fires at the tail end of any processing. Note, this does not report on any data requests (i.e. AJAX calls). This simply notes that the code for loading a community has reached the end. Data specific loading calls may still be in process (i.e. indoorLevelGeomRequested)
indoorDirectoryLoaded The community directory object Following the successful request of the community directory file
indoorMetaDataUpdated The metadata object When the metadata has been updated. This sets the handler for the theme.
indoorMetaDataLoaded The cached metadata object When the metadata has been loaded. This ensures the handler for the theme is set properly.
indoorNavExit The route object that was removed When the route is exited, this will fire signfying the route has been cleared from the map.
indoorDirectoryDisplayLoaded Directory Display object When the Directory Display is loaded into the map
indoorDirectoryDisplayUpdate Directory Display object When the content in the Directory Display has changed
indoorDirectoryDisplayClosed Directory Display object When the Directory Display is closed
indoorDirectoryItemClick Clicked item Object When an item in the directory is clicked, this fires with the clicked object passed to the event in the "item" property. This can be used to provide a custom click response to the Directory listing instead of the default action by stopping the popagation of the click event in this events function (i.e. L.DomUtil.stop(e);) 

 

Community Data Object  ^

The community data object

Property Description
id The community ID
mv The community map version
ev The community entity version
l The default community language
ft The FT (?)
d The array of drawing objects in the community
p An object with any relevant community properties (i.e. name)
settings (OPTIONAL) The community settings
or (OPTIONAL) Any relevant community specific overrides 

 

Drawing Data Object  ^

The drawing data object. 

Property Description
id The drawing ID
r Indicates if this drawing is the root drawing of this community
t Settings to transform from map coordinates to latitue / longitude
ar The angle of rotation from north being vertical
h The height of the map in map coordinates
w The width of the map in map coordinates
l A list of level info objects in this drawings
p An object with any relevant drawing properties (i.e. name, map_type)

 

Level Info Object  ^

The drawing level info object.

Property Description
id The level ID
z ZLevel - an integer giving the order of the z-direction
r (OPTIONAL) Boolean to determine if this level is the main level (if this does not appear, it is false)
p The relevant level properties (i.e. name)

 

Geometry Object  ^

The geometry object

Property Description
id The geometry ID
gid (OPTIONAL) If this geometry is in a group, the Group ID appears here
r (OPTIONAL) True if this geometry is the root of the drawing. Defaults to false.
v (OPTIONAL) Visibility. If set to true, the geometry should be plotted as is. Defaults to false.
st (OPTIONAL) Shape type. The type of shape (options include NONE, POINT, or PATH). Defaults to Path
shp (OPTIONAL) Path object. The shape coordinates.
gw (OPTIONAL) Geometry width. Parameter used for linear areas. Required if the there is a non-null linear area.
l (OPTIONAL) Label area object. The area for the label and if missing there is no label area
el (OPTIONAL) External Label. The flag to indicate the label area is external to the geometry. Defaults to false.
mx Marker X. This is the location for a marker on the object If marker x or y is missing then marker point is null.
my Marker Y. This is the location for a marker on the object If marker x or y is missing then marker point is null.
p Relevant geometry properties (i.e. name)
a (OPTIONAL) Address in JSON
lnk (OPTIONAL) Map Link. Defaults to null.

 

Entity Object  ^

The entity object

Property Description
id The entity ID
chid (OPTIONAL) The chain ID this entity belongs to. Defaults to no chain.
a (OPTIONAL) Entity Address list. Each address is as a complete string. Assume no address if missing.
p Relevant entity properties (i.e. nm)

 

Community Directory Object  ^

The community directory object. The load of this object is initialized at community load and has specificcally fired events whn load is complete.

Property Description
id The community ID
l The community language
mv The community Map Version for this directory
ev The community Entity Version for this directory
ft The FT
nm Ordered Community Directory Entry Object list for each named object. This includes geometry and entities. There will be an entry for each geometry and entity with a name for a given geometry.
a Ordered Community Directory Entry Object list for addresses shown as labels (i.e. any geometry that has an address used as a name)
ic Ordered Community Directory Entry Object list for icons (i.e. any object with an icon)

 

Community Directory: Entry Object 

The object for an individual entry found in the above Community Directory Object.

Property Description
nm The name of the object. (For entries in the Community Directory Object: nm list)
a Address (if address is used as the label)
ic Icon name (For entries in the Community Directory Object: ic list)
gid Geometry ID (note this is NOT the Group ID)
eid Entity ID (if applicable)
lid Level ID where the object appears

 

Theme  ^

The theme object used to theme a map. Derivations of this object can be passed into the themeOverride Community Base Class option at run time to customize the theme.

Property Description
nm Theme name
v Theme version
ft The FT
s (OPTIONAL) Geometry Styles in the format: Style Name:Theme: Geometry style object
iurl (OPTIONAL) Base URL for icons (if this is present, icons and images that have the field "rurl" use this prepended to url, otherwise all icons include the full url.
i (OPTIONAL) Theme: Label Info object in the format: Label name: Theme: Label Info Object
l (OPTIONAL) Label styles in the format: Label Style Name: Theme: Label Style Object. The style name "default" can be used to override the theme Label Style defaults. Additional styles may be created which can be referenced from the Geometry Styles.
m (OPTIONAL) Theme: Marker Icon Object in the format: Marker Name: Theme: Marker Icon Object

 

Theme: Geometry Style Object 

The theme geometry style object.

Property Description
m (OPTIONAL) Fill color for area (Hex color, i.e. #006bb7)
o (OPTIONAL) Stroke color for the area  (Hex color, i.e. #006bb7)
w (OPTIONAL) Outline width for the lines and areas (Interger)
img (OPTIONAL) If a pattern is desired, fully qualified URL to tile the pattern in the area
shadow (OPTIONAL) Add a drop shadow to the area [color,blur,offset x,offset y]
zmin (OPTIONAL) Minimum display zoom scale for the object
l (OPTIONAL) Label style name (if missing reverts to theme default or SDK default).

 

Theme: Label Info Object 

The theme label info object.

Property Description
lt  The label type (Options include: 0: None, 1: Text, 2: Icon, 3: Image)
r Reference. The text for the label. If "ar" is provided, this can be ommitted.
ar Absolute reference. This provides the text for the label via the translation table (i.e. this string is looked up for the language specific string)
url (OPTIONAL - Only applies if the "lt" property is set to 2 or 3). Absolute or relaive URL to download the Icon or Image file
rurl (OPTIONAL - Only applies if the "lt" property is set to 2 or 3). Relative to the Theme "iurl" property where this value is appended to the end of the "iurl" property to form the URL to download the Icon or Image file.

 

Theme: Label Style Object 

The theme label style object.

Property Description
font The label font. Example: "arial,geneva,sans serif", this allows multiple options in case one font is not recognized.
minFont The minimum font size to display, in pixels.
maxFont The maximum font size to display, in pixels.
caps If true, label will be displayed in all caps
fill Fill color for text (Hex color)
outline Outline color for text (Hex color)
outlineWidth Outline width for text (integer)
padding Padding for text from allotted text area (integer)
bgFill Background fill color (Hex color)
bgOutline Background outline color (Hex color)
bgOutlineWidth Background outline width (integer)
bgPadding Padding from background to text
bgR Rounded corner radius (integer)
bgShadow Shadow color for background (Hex color)
zmin minimum zoom scale for showing this label

 

Theme: Marker Icon Object 

The theme marker icon object.

Property Description
ox Offset X. Offset of anchor point from top left corner
oy Offset Y. Offset of anchor point from top left corner
src Image URL. 
mx (OPTIONAL) Marker X location (defaults to image center)
my (OPTIONAL) Marker Y location (defaults to image center)
The Position object as provided by the supplier
The markup for the next arrow displayed in the Direction Minimal Display. Also used with the Navigation class.