# getRoute

## Description

Display the route on the map from the start position to end position.

## Input / Parameter

| Name            | Description                                                                   | Input Type | Default | Options                              | Required |
| --------------- | ----------------------------------------------------------------------------- | ---------- | ------- | ------------------------------------ | -------- |
| component       | The name of the map component.                                                | Text       | -       | -                                    | Yes      |
| mode            | The route mode to show.                                                       | Text       | -       | DRIVING, WALKING, BICYCLING, TRANSIT | -        |
| startCoordinate | The latitude and longitude of the start position. Format: latitude, longitude | Text       | -       | -                                    | Yes      |
| endCoordinate   | The latitude and longitude of the end position. Format: latitude, longitude   | Text       | -       | -                                    | Yes      |
| waypoints       | The waypoints on the route. Format: \['latitude, longitude']                  | List       | -       | -                                    | -        |

## Output

N/A

## Example

In this example, we will set a route using the getRoute function and display it on the Map component.

### Steps

1. Drag a `button` component and a `map` component to a page in the mobile designer.

   ![](https://399701567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwmJ1RKjM2uNFaL6fO3Xu%2Fuploads%2Fgit-blob-c7b2caccd0cf99815977597eb0d9ebfef060b4bd%2FgetRoute-step-1.png?alt=media)
2. Select the event `press` for the button and drag the function `Map.mapRoute` to the event flow. Fill in the parameters of the function.

   ![](https://399701567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwmJ1RKjM2uNFaL6fO3Xu%2Fuploads%2Fgit-blob-97f927961bb40c78dcc4d25ad6ec1257589e3b99%2FgetRoute-step-2.png?alt=media)

### Result

1. The map component should show the route based on the parameters passed in the `Map.mapRoute` function.