Skip to main content

 

 

 

Template:OutSystems/Documentation_KB/Breadcrumb_New_Layout

 

 

Template:OutSystems/OSLanguageSwitcher

 

Applies only to Mobile Apps and Reactive Web Apps

 

 

OutSystems

Map

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • You can use the Map UI Pattern to provide an interactive satellite map to you users.

    Google Maps isn’t free. You must always buy an API key. For more info on getting an API Key, see https://developers.google.com/maps/d...pt/get-api-key.

    How to use the Map UI Pattern

    1. In Service Studio, in the Toolbox, search for Map.

      The Maps widget is displayed.

      Map in the Service Studio toolbar

    2. From the Toolbox, drag the Maps widget into the Main Content area of your application's screen.

      Map pattern in the preview screen

    3. You can you can change the Map's look and feel by setting the (optional) properties.

      In this example, we enter an API key so that the "For development purposes" watermark is removed. We also enter the latitude and longitude coordinates for Lisbon (38.71667, -9.13333) in the Location and the Marker Location properties. Finally, we set the Zoom property to zoom on a city level when the page is loaded.

      Map preview with properties

    After following these steps and publishing the module, you can test the pattern in your app.

    Properties

  • Standard (default)
  • Silver
  • Retro
  • Dark
  • Night
  • Aubergine
  • Property Description
    APIKey (Text): Optional Add a Google Maps API key to display the map correctly and remove the development purpose watermark. You can get an API key for Google Maps here: https://developers.google.com/maps/documentation/javascript/get-api-key
    Location (Text): Optional Defines where the map is centered. You can input addresses or coordinates (latitude and longitude). By default, the map automatically adjusts to show all markers. You can override this by Location and Zoom properties. To add markers, drag the MapMarker block into the Content placeholder.
    Markers (Marker List): Optional Sets a location on the map. By default, the marker uses the Google Maps default marker. For more information, see https://developers.google.com/maps/d...script/markers
    Zoom (Zoom Identifier): No Sets the zoom level to apply to the map, with the levels ranging from 1 (world) to 20 (building).

    Examples

    • Auto: Fit to all markers present on the map. This is the default.
    • Zoom1: World
    • Zoom5: Continent
    • Zoom10: City
    • Zoom15: Streets
    • Zoom20: Buildings

    For more information, see https://developers.google.com/maps/d...ew#zoom-levels

    Height (Text): Optional Sets the height of the map in pixels ("300px"), percentage ("100%"), or viewport height ("100vh"). If this property is left empty, the map fits to the parent height Of using percentages, ensure that the map has a parent with a fixed height value, otherwise, its height is 0. The height property value is applied to a CSS variable ued on the OutSystems UI Theme. This variable can be overridden to manipulate the maps height on your CSS theme.
    Style (Style Identifier): Optional Sets the theme type based on themes provided by Google Maps. To create your own style or to change the theme options, see https://mapstyle.withgoogle.com/. When your custom theme is ready, use the AdvancedFormat property to apply it. Note that any style applied won't be visible if the Satellite type is selected. For more information, see https://developers.google.com/maps/d...script/styling. The available styles are as follows:

    Type (Type Identifier): Optional Sets the map type to either roadmap (default), satellite, hybrid, or terrain, provided by Google Maps. For more information, see https://developers.google.com/maps/d...cript/maptypes.
    Offset (Offset): Optional Expand the options to set the Offset(X) vertical and the Offset(Y) horizontal in pixels to apply to a map. This is applied based on the defined Location.
    StaticMap (Boolean): Optional If True, the map is not interactive. If False, the map is interactive. This is the default. The static map API has limitations. For more information, see https://developers.google.com/maps/d...s-static/start.
    ShowTraffic (Boolean): Optional If True, traffic mode is enabled on the map. If False, traffic mode is not enabled. This is the default.
    AdvancedFormat (Text): Optional Allows for more options beyond what's provided through the input parameters. For more information, see https://developers.google.com/maps/d...cript/controls.
    ExtendedClass (Text): Optional Adds custom style classes to the block.
    • Was this article helpful?