Skip to content

Commit

Permalink
GITBOOK-83: Rob + Mattis corner
Browse files Browse the repository at this point in the history
  • Loading branch information
Anne Kristine Bach authored and gitbook-bot committed Oct 23, 2023
1 parent 54bbe8b commit 01832b1
Show file tree
Hide file tree
Showing 32 changed files with 1,803 additions and 361 deletions.
Binary file added .gitbook/assets/Routing-directions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/desk_to_room_optimizer.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/externalIdDisplayRule (1).gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/externalIdDisplayRule.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/externalIdsDisplayRules.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (3).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (4).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (5).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 6 additions & 3 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@
* [Web](sdks-and-frameworks/web/README.md)
* [Getting Started](sdks-and-frameworks/web/getting-started/README.md)
* [Map Engine Setup](sdks-and-frameworks/web/getting-started/prerequisites.md)
* [Create a Search Experience](sdks-and-frameworks/web/getting-started/create-a-search-experience.md)
* [Tutorial](sdks-and-frameworks/web/getting-started/tutorial.md)
* [Map Visualization](sdks-and-frameworks/web/map-visualization/README.md)
* [Display Rules in Practice](sdks-and-frameworks/web/map-visualization/display-rules-in-practice.md)
* [Display a Map](sdks-and-frameworks/web/map-visualization/display-a-map.md)
* [Switching Solutions](sdks-and-frameworks/web/map-visualization/switching-solutions.md)
* [Remove Labels from Buildings and Venues](sdks-and-frameworks/web/remove-labels-from-buildings-and-venues.md)
* [Change Building Outline](sdks-and-frameworks/web/change-building-outline-color.md)
* [Turn Off Collisions Based on Zoom Level](sdks-and-frameworks/web/displaying-objects/turn-off-collisions-based-on-zoom-level.md)
* [Managing Collisions Based on Zoom Level](sdks-and-frameworks/web/map-visualization/managing-collisions-based-on-zoom-level.md)
* [3D Maps](key-features/3d-maps/README.md)
* [Managing your 3D Maps](sdks-and-frameworks/web/map-visualization/3d-maps/managing-your-3d-maps.md)
* [Wayfinding](sdks-and-frameworks/web/directions-and-routing/README.md)
Expand All @@ -23,8 +24,10 @@
* [Directions Renderer](sdks-and-frameworks/web/wayfinding/directions-renderer.md)
* [User's Location as Point of Origin](sdks-and-frameworks/web/directions-and-routing/directions-renderer/users-location-as-point-of-origin.md)
* [Search](sdks-and-frameworks/web/search/README.md)
* [Basic Searching](sdks-and-frameworks/web/basic-searching.md)
* [External IDs](sdks-and-frameworks/web/other-guides/external-ids.md)
* [Search Operations](sdks-and-frameworks/web/search/search-operations.md)
* [Searching](sdks-and-frameworks/web/search/searching.md)
* [Using External ID, Geospatial Joins](sdks-and-frameworks/web/other-guides/external-ids.md)
* [Utilizing MapsIndoors Web Components and Other Searches](sdks-and-frameworks/web/search/utilizing-mapsindoors-web-components-and-other-searches.md)
* [Map Management](sdks-and-frameworks/web/map-management/README.md)
* [Data Visualization](sdks-and-frameworks/web/data-visualization/README.md)
* [Booking](sdks-and-frameworks/web/booking/README.md)
Expand Down
12 changes: 0 additions & 12 deletions sdks-and-frameworks/integration-api/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
# Integration API

**Documentation reflects the latest version:** 

You can find documentation on legacy versions here:

{% content-ref url="../../other-docs/legacy-docs/" %}
[legacy-docs](../../other-docs/legacy-docs/)
{% endcontent-ref %}

***

### Introduction and Getting Started[](https://docs.mapsindoors.com/api#introduction-and-getting-started) <a href="#introduction-and-getting-started" id="introduction-and-getting-started"></a>

The MapsIndoors Integration API offers an alternative to changing your Mapsindoors data via the [CMS](https://cms.mapsindoors.com/). From this API you can get, add, change and delete either directly via third party tools like [Postman](https://www.postman.com/) or via the provided Swagger frontend.

You can access data through the Integration API using a range of endpoints. The endpoints are described in the Swagger interface definition: [https://integration.mapsindoors.com/doc](https://integration.mapsindoors.com/doc/index.html)
Expand Down
158 changes: 0 additions & 158 deletions sdks-and-frameworks/web/basic-searching.md

This file was deleted.

13 changes: 13 additions & 0 deletions sdks-and-frameworks/web/data-visualization/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
# Data Visualization

Data visualization in the form of displaying external dynamic data within your indoor map is crucial for enhancing the map's utility, relevance, real-time applicability and not least for customizing it to fit your specific use cases. \


MapsIndoor’s data visualization functionality is built to ensure a unified, up-to-date, and contextually relevant mapping experience for users. \


By altering your map data visualization dynamically, you will create a use-case-specific digital twin that only shows information that is relevant for solving your users’ needs.\


Integrate everything from live data sensors, calendar booking systems, ERP systems, and more to MapsIndoors.\


Follow our guides to customise your maps with the data integrations you need.&#x20;
29 changes: 28 additions & 1 deletion sdks-and-frameworks/web/directions-and-routing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,31 @@ layout:

# Wayfinding

##
Wayfinding is a critical component of your indoor map solution enabling efficient route calculations and optimal navigation within indoor spaces.\


MapsIndoors’ wayfinding functionality is a comprehensive solution that seamlessly integrates local and global maps, considers various travel modes, utilizes entry points for smooth transitions, and breaks down routes into logical legs and steps, ultimately enhancing navigation and user satisfaction.\


Key elements to dig into when enabling wayfinding in your MapsIndoors solution are:

**Outdoor to indoor navigation**\
Turn-by-turn directions visualized on the map with estimated travel time and detailed descriptions.

**Venue to Venue wayfinding**

When you're getting routes between two of your own MapsIndoors venues and may require using public routes from Google Maps or Mapbox to get there.

**Dynamic routes**\
Automated route updates based on obstacles like furniture and changing floor plan layout.&#x20;

**Personalized routes**\
User profiles allow for personalized guidance, based on what the user is allowed to see and where they are allowed to navigate. Getting the right people to the right destinations.

**Accessible wayfinding**\
Allow users with disabilities to effortlessly navigate your building by avoiding stairs and using elevators and ramps for navigation. &#x20;

\


All the guidance is here for you. Happy wayfinding!
Original file line number Diff line number Diff line change
Expand Up @@ -26,38 +26,36 @@ This guide will show you how to implement directions, render routes, and interac
* Would you like to show directions on the map?
* How will the end user let the map know it's time to update with the next part of their journey?

<figure><img src="broken-reference" alt=""><figcaption></figcaption></figure>

<figure><img src="../../../.gitbook/assets/UI-directions-2.png" alt=""><figcaption></figcaption></figure>

<figure><img src="../../../.gitbook/assets/image (1).png" alt=""><figcaption><p>Creating and combining the interfaces and the map view.</p></figcaption></figure>

<figure><img src="../../../.gitbook/assets/image (3).png" alt=""><figcaption><p>Determining the scope and simplicity of your end user experience should be a big focus when implementing the MapsIndoors SDK</p></figcaption></figure>

From an implementation standpoint, there are two functional things that need to be taken care of.

1. Setting up and requesting directions

<figure><img src="../../../.gitbook/assets/Route Request.png" alt=""><figcaption><p>Getting directions via the SDK</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (4).png" alt=""><figcaption></figcaption></figure>

2. [Handling and rendering directions responses](../wayfinding/directions-renderer.md)
1. [Handling and rendering directions responses](../wayfinding/directions-renderer.md)

<figure><img src="../../../.gitbook/assets/Route Response Handling.png" alt=""><figcaption><p>What you can do once you have the response.</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (5).png" alt=""><figcaption></figcaption></figure>



The first step in getting directions is initializaing the directions service instance. By passing the externalDirectionsProvider, the MapsIndoors SDK will handle merging responses from the base map, e.g. outdoor directions that will charge billable requests if you request from somewhere else other than MapsIndoors data (e.g. an end users house, to somewhere indoors.)

**Implementation**
## **Implementation**

The class `DirectionsService` is used to request routes from one point to another. The minimal required input is an `origin` and a `destination`. &#x20;

Mapbox (required parameter of the DirectionsService instance)
**Mapbox** (required parameter of the DirectionsService instance)

```javascript
const externalDirectionsProvider = new mapsindoors.directions.MapboxProvider();
const miDirectionsServiceInstance = new mapsindoors.services.DirectionsService(externalDirectionsProvider);
```

Google (not required for legacy reasons, but recommended to pass an externalDirectionsProvider as a parameter)
**Google** (not required for legacy reasons, but recommended to pass an externalDirectionsProvider as a parameter)

```javascript
const externalDirectionsProvider = new mapsindoors.directions.GoogleMapsProvider();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

As a key element in the MapsIndoors platform, we offer APIs for efficiently calculating and displaying the most optimal routes from anywhere in the world to any Location in MapsIndoors. In the case of travelling inside a Venue, this calculation can be done on a local map provided by MapsIndoors. In the case of travelling between Venues or from outdoors to indoors, MapsIndoors provides a seamless journey outline from a specified Origin through automatically selected Entry Points at the edge of your Venues to the specified destination. See illustration below:

<figure><img src="https://docs.mapsindoors.com/img/directions/directions-with-entry-points.svg" alt="" width="563"><figcaption><p><mark style="background-color:blue;">MJE: GRAFIC NEEDS AND UPDATE - AND PARKING SHOULD BE REMOVED. DOTS MUST STILL ILLUSTRATE LEG DIVISION AS DESCRIBED IN THE ARTICLE.</mark></p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Routing-directions.png" alt=""><figcaption></figcaption></figure>

In order to provide a route between Venues, MapsIndoors integrates with external and global map engines (Mapbox and Google Maps).

Expand Down
Loading

0 comments on commit 01832b1

Please sign in to comment.