API specification for the Situm Wayfinding Library.

The main entry point is the class SitumMapsLibrary. There are two ways to load the Situm Map, in your layout using SitumMapView or programmatically using SitumMapsLibrary.

  • SitumMapView:

    In your layout, add the SitumMapView:

    <es.situm.wayfinding.SitumMapView
            android:id="@+id/map_view"
            android:layout_width="match_parent"
            android:layout_height="match_parent" />
            

    You can set the credentials (user and API key) in the AndroidManifest.xml file adding the next meta-data fields:

     <meta-data
             android:name="es.situm.maps.API_USER"
             android:value="API_USER_EMAIL" />
     <meta-data
             android:name="es.situm.maps.API_KEY"
             android:value="API_KEY" />
            
  • SitumMapsLibrary:
    librarySettings = new LibrarySettings();
    librarySettings.setApiKey(API_USER_EMAIL, API_KEY);
    // Create library:
    mLibrary = new SitumMapsLibrary(R.id.maps_library_target, context, librarySettings);
    // Get notified about context initialisation events:
    mLibrary.setSitumMapsListener(...);
    ...
    // Load:
    mLibrary.load();
            

Then, you can access the different features through the SitumMap and/or SitumMapsLibrary methods.

See the getting started project at github.

You can find more info in the Situm Documentation.

Packages 
Package Description
es.situm.maps.library.domain.interceptor  
es.situm.wayfinding  
es.situm.wayfinding.actions  
es.situm.wayfinding.navigation