Emitted when the BlueDot state changes
Current Blue Dot bearing
The MappedinMap Blue Dot position is on
The nearest MappedinNode to the Blue Dot position
Actual position of Blue Dot (post smoothing, if smoothing is enabled)
Visiblity state of the Blue Dot marker
Additional message to complement the reason
What we currently know about the user's position, and how confident we are.
Reason why Blue Dot may be in the current state
Animation duration in milliseconds
If Polygon is not set, this will let you add a TextLabel to another Map. Otherwise, it will use the currentMap
The short name text to use for the label.
The full name text to use for the label.
Direction "up" or "down"
Connection type, "escalator", "elevator", etc
map to add the marker to
the marker object to add to the scene
if provided, sets the object's position on the map
if provided, sets the object's rotation relative to the map
if provided, sets the object's scale relative to the map
By default, we don't hide tooltips when they collide. This is so that for floor switching tooltips we don't lose where the elevator is This option will override that behavior
The rank of the object used when comparing colliders to determine which should be shown.
Default (starting) anchor for tooltips
An object used to disable certain anchor positions from being used.
For venues that do not provide level updates, assume the user is always on the default map If this is false, and no level information is found from position updates, blueDotUpdate events will not include the nearest node This should probably be set true for single floor venues that have no level information in position updates
Override the default color of the Blue Dot. We interpolate other colors, (such as aura and bearing) from this base color
Custom positionUpdater
Show Bearing
Smooth incoming position updates. Set to false if smoothing happens outside the SDK
Whether to use the rotated view while following the user's position.
Optional color in hexadecimal string e.g. #2e2e2e.
A CSS style string font, e.g. "sans-serif". You can specify your own font via @font-face rule with a font family, and then include that here.
Size of the font in pixels.
By default this is the upper bounds of the Polygon. If you don't have a Polygon, or want a custom height for some reason, you can set this.
The amount of space to leave before starting the text in pixels
The minimum percentage we can shrink the label to if it won't fit within the bounds at 100%. If it doesn't fit at that level, it won't be created.
How much to decrement the scale each time it doesn't fit, so we don't end up with too many different font sizes on screen at once. If you are only labeling a few MappedinPolygons rather than everything, you can set this and and scaleMin to 0.1 to fit everything except really long names perfectly.
Margin around the label and marker. This will affect label density
Background color of the marker when it is active
Background color of the marker when it is inactive (grayed out due to being outranked by other labels around)
Foreground color of the marker when it is active
Foreground color of the marker when it is inactive (grayed out due to being outranked by other labels around)
Size of the marker in pixels
Text background color
Text foreground color
Line height sets the height of a line box. It's commonly used to set the distance between lines of text
Maxiumum width of text in pixels
Number of lines to display when text spans multiple lines
Text size in pixels
Animation options
Camera options to use while focusing
Targets to focus on
An extension of the GeolocationPosition type. https://developer.mozilla.org/en-US/docs/Web/API/GeolocationPosition
Function that returns an HTML template to use as a connection tooltips (elevators, escalators, etc)
Function that returns an HTML template to use as a departure marker. Override with null | undefined to disable
Function that returns an HTML template to use as a destination marker. Override with null | undefined to disable
Path Options for the non-current path in multi-destination mode.
Path Options
What color to highlight departure and destination polygons Pass false to disable
Display label despite the MappedinPolygon having an image on it. Often these images represent store logos.
Exclude specific location types from labeling
Locations to label - otherwise, use current venue object
Custom Translation Map for {@link MappedinLocation.MappedinLocationState}
A custom sort function to use for sorting locations
Indicates whether the user clicked close to the Blue Dot object on the map, if present. If Blue Dot is disabled, this will always be false.
A list of MappedinPolygons corresponding to every polygon that a user's click passed through. These are in order of first to last intersected. Will be empty if no interactive polygons were clicked.
The latitude / longitude of where the user clicked the map. Both components may be NaN if unable to compute these components.
True if the opacity argument to setBackgroundColor should be considered.
Controls whether antialiasing is on. Defaults to true, as long as devicePixelRatio is 1. This is very expensive on high resolution screens.
The opacity of the initial background color.
Background color of the map in hex number or string e.g. 0x2e2e2e or #2e2e2e.
First map to be rendered
By default, the SDK will merge all geometries by material to reduce the number of draw calls to the GPU
To rever back to using a single geometry for every polygon, pass MAP_RENDER_MODE.MULTI_GEOMETRY
Multi-buffer rendering should improve performance but may cause issues on older GPUs/browsers
True if the opacity argument to setBackgroundColor should be considered.
Controls whether antialiasing is on. Defaults to true, as long as devicePixelRatio is 1. This is very expensive on high resolution screens.
The opacity of the initial background color.
Background color of the map in hex number or string e.g. 0x2e2e2e or #2e2e2e.
If you would like to completely disable the hover effect (if you are on a touch screen for example), set this to true.
First map to be rendered
A callback executed with the 3D files have been downloaded for the first Map, and are starting to load into memory. The MapView is fully functional at this point, but some things will still be popping in.
A callback executed when the first map is fully loaded. This means onDataLoaded has already been fired (if specified) and then all the textures and other resources have finished popping in.
this is the "overloaded" version of the directive, with get-venue classes instead of stubs
Distance from the last instruction to the current. Useful for turn by turn navigation
What field the search matched on
The term that was found
The value of that field
Term's weight
A {@link Mappedin.OfflineSearch} is an offline search module
Fine tune search constants
Multiplier for category locations' descriptions
Multiplier for category locations' names
Multiplier for category locations' tags
Multiplier for category names
Default rank when one isn't available in the data, default = 1
Multiplier for location names
Fuzziness index for location names and tags
Multiplier for location tags
Multiplier for location names (1 by default)
Ratio of Fuzzy Searches of Location names and tags relative to exact
Ratio of Prefix Searches of Location names and tags relative to exact
Multiplier for descriptions
Emit Analytics events when doing search
Initialize Search with a previously indexed JSON string (outputted by OfflineSearch.toJSON())
Index location descriptions - typically better to use either tags or descriptions, depending on what's available
Also index all tags for every location in every category (caution: this may slow down indexing and search)
Index location tags - typically better to use either tags or descriptions, depending on what's available
Also index all tags for every location in every category (caution: this may slow down indexing and search)
Array of stopwords to ignore when searching, default: english stopwords
Use the location polygons' rank in weighing results
Details on why the result was returned
Found object
Total score of the result
Type describing the object
List of suggestions
Total number of suggestions generated
Animate the drawing of the path in the direction of travel.
Path Colour
Show arrows on path
Duration of path drawing
Radius of path at furthest zoom, in metres
Zoom level where the path size is farRadiustions.nearRadius
Flatten the path to a 2D line
Radius of path at nearest zoom, in metres
Zoom level where the path size is nearRadius
Colour of path pulse
Number of iterations to pulse to indicate direction
How many milliseconds to wait before starting the next pulse after the current pulse travels the entirety of the path
(Deprecated) alias for nearRadiusty
Show an animated pulse indicating the direction of travel.
The opacity of the initial background color.
Sets the initial background color of the map, including while loading.
The id of the first map to show on map load
Whether or not to display default styled Floating Labels initially
Set the map render strategy in order to optimize FPS
A class to access the Mappedin Search API. This will be created for you as part of Mappedin.{{#crossLink "Mappedin/initailize:method"}}{{/crossLink}}, but you can also create one manually.
Get Venue Data for a Mappedin Venue
[experimental] Fetching an offline Venue bundle It is possible to download the venue bundle with all assets built in, which allows for caching/offline solutions. Note 1: This requires enabling from Mappedin's Customer Solutions team. Note 2: This may behave a lot slower for large venues, especially those with many images. We are actively working on improving load times.
Overwrite the internal fetch function with your own. Typically for use in Node.js and Jest
HTML Element where the mapView should be placed
Venue Object returned by getVenue
MapView Options
Emitted when the BlueDot position updates