mapsindoors library
Starting point for all MapsIndoors functionality
Classes
- FloorSelectorState
- MapsIndoorsWidget
- A UniqueWidget that contains the map used by MapsIndoors
- MPBounds
- Describes the geographical bounds as a rectangle spanning from its northeastern point to its southwestern point
- MPBuilding
- A MapsIndoors geographical entity. A MPBuilding is contained within a MPVenue and contains a number of MPFloors.
- MPBuildingCollection
- A collection of building objects fetched from MapsIndoors. Uses MPBuilding.id as key
- MPBuildingInfo
- A collection of information about a MPBuilding
- MPCameraPosition
- A camera position object, used to move the camera to a specific position.
- MPCameraPositionBuilder
- Construct a camera position.
- MPCameraUpdate
- An object that can be used to update the position of the camera by calling MapControl.animateCamera().
- MPCategory
- A categorisation for MapsIndoors objects
- MPCategoryCollection
- A collection of category objects fetched from MapsIndoors. Uses MPCategory.key as key
- MPDataField
- A MPDataField contains a single field value with descriptive text and a type that describes the type of the value (eg. text or number)
- MPDefaultFloorSelector
- MPDirectionsRenderer
- MPDirectionsService
- MPDisplayRule
- A collection of settings that dictate how MapsIndoors objects are displayed on the map
-
MPEntity<
T extends DynamicObjectId> - An interface describing trivial properties of a MapsIndoors geographical entities
- MPError
- A class of errors that can occur when using the MapsIndoors SDK
- MPFilter
- A filter that can be applied during search, this will limit the returned MPEntitys to those that fulfills the filter
- MPFilterBehavior
- Sets a behavior for the map when calling MapsIndoorsWidget.setFilter
- MPFilterBehaviorBuilder
- Builder for MPFilterBehavior
- MPFilterBuilder
- Constructs a MPFilter
- MPFloor
- A MapsIndoors geographical entity. A MPFloor is contained within a MPBuilding.
- MPFloorSelectorInterface
- Interface used by MapsIndoors to communicate with floor selector UIs
- MPGeocodeResult
- GeoCode class to represent results from a reverse GeoCode.
- MPGeometry
- Superclass of all MapsIndoors geometry classes
- MPHighlightBehavior
- Sets a behavior for the map when calling MapsIndoorsWidget.setHighlight
- MPHighlightBehaviorBuilder
- MPIconSize
- Class to hold height and width information for an icon
- MPLabelGraphic
- Represents a label graphic in the MapsIndoors platform. A label graphic is used to display text on top of an image.
- MPLocation
- A MapsIndoors geographical entity. A MPLocation can exist anywhere, but it is usually only used inside MPVenues and MPBuildings.
- MPMapLabelFont
- MPMapStyle
- MPMultiPolygon
- MPMultiPolygon is a collection of MPPolygons that combine to form a single geographical area with multiple bodies
- MPPoint
- MPPoint is a representation of latitude and longitude coordinates packaged with a Z-axis representation in floorIndex
- MPPolygon
- MPPolygon is a collection of MPPoints that combine to form a single geographical area with a single body
- MPPositionProviderInterface
- Interface for added a position provider to the SDK
- MPPositionResultInterface
- Interface to deliver a position result to the MapsIndoors SDK
- MPQuery
- A collection of query parameters used to query MapsIndoors
- MPQueryBuilder
- A builder for MPQuery
- MPRoute
- A route from a origin to a destination broken up into MPRouteLeg legs
- MPRouteCoordinate
- A coordinate used for routing, it is contained within a MPRouteStep
- MPRouteLeg
- A leg of a MPRoute is defined as all steps between any context shifts (entering/exiting buildings, changing floors) A leg is comprised of a list of steps as well as a startLocation and an endLocation
- MPRouteProperty
- A property of of a MPRoute
- MPRouteResult
- Object that is returned from MPDirectionsSerivce.getRoute
- MPRouteStep
- A step of a MPRoute, the step is usually contained in a MPRouteLeg
- MPRouteStopIconConfig
- A class that creates a route stop icon for the Directions Renderer.
- MPRouteStopIconConfigInterface
- MPSelectionBehavior
- Sets a behavior for the map when calling MapsIndoorsWidget.selectLocation
- MPSelectionBehaviorBuilder
- Builder for MPSelectionBehavior
- MPSettings3D
- An object that governs layer settings for 3D features.
- MPSolution
- Governs the topmost
- MPSolutionConfig
- An object that governs solution level settings such as:
- MPUserRole
- A User Role that allows certain parts of the data to be viewed
- MPUserRoleCollection
- A collection of user role objects fetched from MapsIndoors. Uses MPUserRole.id as key
- MPVenue
- A MapsIndoors geographical entity. A MPVenue can exist anywhere, and it can contain a number of MPBuildings and MPLocations.
- MPVenueCollection
- A collection of venue objects fetched from MapsIndoors. Uses MPVenue.id as key
Enums
- LiveDataDomainTypes
- Domain types for livedata subscriptions
- MPBadgePosition
- MPCameraEvent
- Possible events that a MPCameraEventListener can recieve
- MPCameraViewFitMode
- Different ways the camera can fit a route inside the screen
- MPCollisionHandling
- Describes how the SDK should handle markers and labels overlapping with other markers and labels
- MPFeatureType
- Features that can be disabled through MapControl
- MPHighway
- OSM highways used by the MapsIndoors SDK in addition to MapsIndoors specific highways
- MPIconPlacement
- MPLabelType
- MPLocationPropertyNames
- Names of properties that can be set on a MPLocation
- MPLocationType
- Base type of a MPLocation
- MPSelectionMode
- MPSolutionDisplayRuleEnum
- Special MPDisplayRules that govern specific issues
Mixins
Functions
-
addOnMapsIndoorsReadyListener(
OnMapsIndoorsReadyListener listener) → void -
Add a one time
listenerto be invoked when MapsIndoors is ready -
addOnVenueStatusChangedListener(
MPVenueStatusListener listener) → void -
Add a
listenerthat is invoked when the loading status changes for a venue. -
addVenuesToSync(
List< String> venueIds) → Future<void> - Adds a collection of venues to be synchronized. All non-synchronized venues will be unloaded.
-
applyUserRoles(
List< MPUserRole> userRoles) → Future<void> - Applies a list of MPUserRoles to the SDK which will get the UserRole specific locations.
-
checkOfflineDataAvailability(
) → Future< bool?> - Checks if there is on device data (embedded/locally stored) available. For this to return true, data has to be available for all solution data types (MPLocation, MPBuilding...)
-
destroyMapsIndoors(
) → void - Clears the internal state of MapsIndoors SDK. Any loaded content is purged from memory.
-
disableMapsIndoorsEventLogging(
bool disable) → Future< void> -
disableSDK event logging through MapsIndoors. No logs will be created or send with this disabled. -
getAPIKey(
) → Future< String?> - Retrieves the API key that was set by using loadMapsIndoors
-
getAppliedUserRoles(
) → Future< List< MPUserRole> ?> - Returns the list of MPUserRole that is currently applied
-
getBuildings(
) → Future< MPBuildingCollection?> - Gets a collection of all buildings for the current API key
-
getCategories(
) → Future< MPCategoryCollection?> - Gets a collection of all categories for the current API key
-
getDefaultDisplayRule(
) → Future< MPDisplayRule?> - Retrieve the default display rule (hardcoded display rule in the SDK).
-
getDefaultVenue(
) → Future< MPVenue?> - Gets the default venue for this solution
-
getDisplayRuleByLocation(
FutureOr< MPLocation> location) → Future<MPDisplayRule?> -
Retrieve the display rule for the given
location -
getDisplayRuleByName(
String name) → Future< MPDisplayRule?> -
Retrieve the display rule with a given
name. -
getLocationById(
String id) → Future< MPLocation?> -
Retrieves a MPLocation by its
id -
getLocations(
) → Future< List< MPLocation> ?> - Gets all locations (a list of MPLocation objects) for the current API Key
-
getLocationsByExternalIds(
List< String> ids) → Future<List< MPLocation> ?> -
Retrieves a list of MPLocations by external
ids -
getLocationsByQuery(
{MPQuery? query, MPFilter? filter}) → Future< List< MPLocation> ?> - Runs a query on all the available MPLocations with an optional MPQuery and/or MPFilter
-
getMainDisplayRule(
) → Future< MPDisplayRule?> - Retrieve the main display rule (can be configured in the CMS).
-
getMapsIndoorsAvailableLanguages(
) → Future< List< String> ?> - Returns a list of the current solution's available languages
-
getMapsIndoorsDefaultLanguage(
) → Future< String?> - Returns the current solution's default language
-
getMapsIndoorsLanguage(
) → Future< String?> - Gets the current SDK language
-
getMapStyles(
) → Future< List< MPMapStyle> ?> - Gets a list of available map styles
-
getPlatformVersion(
) → Future< String?> - gets the platform name and build version
-
getPositionProvider(
) → MPPositionProviderInterface? - Returns the current position provider, if any is set
-
getSolution(
) → Future< MPSolution?> - Gets the MPSolution for the current API key
-
getSolutionDisplayRule(
MPSolutionDisplayRuleEnum solutionDisplayRule) → Future< MPDisplayRule?> - Retrieve the corresponding display rule for the given MPSolutionDisplayRuleEnum.
-
getSyncedVenues(
) → Future< List< String> > - Fetches all actively synchronized venues.
-
getUserRoles(
) → Future< MPUserRoleCollection?> - Gets the User Roles for the current solution
-
getVenues(
) → Future< MPVenueCollection?> - Gets a collection of all venues for the current API key
-
isAPIKeyValid(
) → Future< bool?> - Check if the current API key is valid
-
isMapsIndoorsInitialized(
) → Future< bool?> - Check if loadMapsIndoors has been called
-
isMapsIndoorsReady(
) → Future< bool?> - Check if the SDK is initialized and ready for use
-
loadMapsIndoors(
String key) → Future< MPError?> -
Loads content from the MapsIndoors solution matching the given API
key. -
loadMapsIndoorsWithVenues(
String key, List< String> venueIds) → Future<void> -
Loads content from the MapsIndoors solution matching the given API
key. -
removeOnMapsIndoorsReadyListener(
OnMapsIndoorsReadyListener listener) → void -
Remove a MapsIndoors ready
listener -
removeOnVenueStatusChangedListener(
MPVenueStatusListener listener) → void -
Remove a venue status
listener -
removeVenuesToSync(
List< String> venueIds) → Future<void> - Removes a collection of venues from active synchronization.
-
reverseGeoCode(
MPPoint point) → Future< MPGeocodeResult?> -
Get a MPGeocodeResult that contains lists of MPLocation (grouped by MPLocationType),
where the
pointis inside the locations geometry. When no floor index is set, locations on all floors are queried. -
setMapsIndoorsLanguage(
String language) → Future< bool?> - Sets the SDK's internal language.
-
setPositionProvider(
MPPositionProviderInterface? provider) → void - Set a new position provider, or pass null to remove the current one
-
synchronizeMapsIndoorsContent(
) → Future< MPError?> - Main data synchronization method
Typedefs
- MPCameraEventListener = void Function(MPCameraEvent event)
- Listens for camera events, eg. when the Camera starts or stops moving
- OnBuildingFoundAtCameraTargetListener = void Function(MPBuilding? building)
- Listener that is invoked when a building is found within the camera bounds
- OnFloorSelectionChangedListener = void Function(MPFloor newFloor)
- Listener that is invoked when the active floor is changed
- OnFloorUpdateListener = void Function(int floor)
- Listener that is invoked when floor selection changes
- OnLegSelectedListener = void Function(int legIndex)
- Listener that is invoked during directions when a MPRouteLeg is selected
- OnLiveLocationUpdateListener = void Function(MPLocation location)
- Listener that is invoked when a location receives a livedata update
- OnLocationSelectedListener = void Function(MPLocation? location)
- Listener that is invoked when a MPLocation is selected
-
OnMapClickListener
= void Function(MPPoint point, List<
MPLocation> ? locations) - Listener that is invoked when the map is clicked
- OnMapsIndoorsReadyListener = void Function(MPError? error)
- Listener that is invoked when MapsIndoors is ready for use
- OnMarkerClickListener = void Function(String locationId)
- Listener that is invoked when a MPLocation marker is clicked on the map
- OnMarkerInfoWindowClickListener = void Function(String locationId)
- Listener that is invoked when a markers infowindow is clicked
- OnPositionUpdateListener = void Function(MPPositionResultInterface position)
- Listener that is invoked when user positioning is updated
- OnVenueFoundAtCameraTargetListener = void Function(MPVenue? venue)
- Listener that is invoked when a venue is found within the camera bounds