MapViewConfiguration class

The MapView settings.

MapView(
  key: const Key("situm_map"),
  configuration: MapViewConfiguration(
  // Your Situm credentials.
    situmUser: "YOUR-SITUM-USER",
    situmApiKey: "YOUR-SITUM-API-KEY",
  // Set your building identifier:
    buildingIdentifier: "YOUR-SITUM-BUILDING-IDENTIFIER",
  // Alternatively, you can set an identifier that allows you to remotely configure all map settings.
  // For now, you need to contact Situm to obtain yours.
  // remoteIdentifier: null;
    viewerDomain: "map-viewer.situm.com",
    apiDomain: "dashboard.situm.com",
    directionality: TextDirection.ltr,
    enableDebugging: false,
  ),
),

Constructors

MapViewConfiguration({String? situmUser, required String situmApiKey, String? buildingIdentifier, String? remoteIdentifier, String? viewerDomain, String apiDomain = "dashboard.situm.com", TextDirection directionality = TextDirection.ltr, bool enableDebugging = false, bool? lockCameraToBuilding, bool? persistUnderlyingWidget = false, bool displayWithHybridComposition = true, String? language})
The MapView settings. Required fields are your Situm user and API key, but also a buildingIdentifier or remoteIdentifier.

Properties

apiDomain String
A String parameter that allows you to choose the API you will be retrieving our cartography from. Default is dashboard.situm.com.
final
buildingIdentifier String?
The building that will be loaded on the map. Alternatively you can pass a remoteIdentifier (that will be prioritized).
final
directionality TextDirection
Sets the directionality of the texts that will be displayed inside MapView. Default is TextDirection.ltr.
final
displayWithHybridComposition bool
Determine whether the underlying webview containing the map will use hybrid composition or not. Only for Android, see: https://docs.flutter.dev/platform-integration/android/platform-views The default value is true.
final
enableDebugging bool
Whether to enable the platform's webview content debugging tools. See AndroidWebViewController.enableDebugging.
final
hashCode int
The hash code for this object.
no setterinherited
language String?
Sets the UI language based on the given ISO 639-1 code. Checkout the Situm docs to see the list of supported languages.
final
lockCameraToBuilding bool?
When set to true, the camera will be locked to the building so the user can't move it away. Also the minimum zoom will be set to an internally calculated value so the building remains visible when the user does zoom out.
final
persistUnderlyingWidget bool?
When set to true, the underlying WebView will persist over MapView disposals.
final
remoteIdentifier String?
A String identifier that allows you to remotely configure all map settings. Alternatively you can pass a buildingIdentifier, remoteIdentifier will be prioritized.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
situmApiKey String
Your Situm API key.
final
situmUser String?
Your Situm user.
final
viewerDomain String
A String parameter that allows you to specify which domain will be displayed inside our webview.
latefinal

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited