zapt_sdk_flutter 1.1.0-alpha7

Package for integration with Zapt Tech SDKs.

zapt_sdk_flutter

Getting started

Flutter Installation

Install Flutter SDK in your machine.

Run Example

To run the example just run $ flutter pub get and $ flutter run in the /example folder.

Deploy Package

1 - Run $ npm run deploy:verify to check package. 2 - Run $ npm run deploy to deploy package in pub repository.

Installing Zapt-Location-SDK-Flutter in another project

In the root folder of your project run:

$ flutter pub add zapt_sdk_flutter

Requirements

Requirement	Version
Flutter	2.5.0+
XCode	9.0+
Project target	iOS 9+
CocoaPods	1.2.0+
Java Compiler	1.8
Android SDK (minSdkVersion)	Android API 21
Android Support Library v4	2+

Usage

After the installation is done according to the steps above, just import the package into the desired file.

import 'package:zapt_sdk_flutter/zapt_sdk_flutter.dart';

Link to location on maps

The function presented just below provides a link that can be used in a WebView or similar HTML rendering component. This link renders a map that shows the user's location in real time.

final _zaptSdkFlutterPlugin = ZaptSdkFlutter();
Map<String, String> options = {'floorId': '1'};
final String placeId = "-ltvysf4acgzdxdhf81y";

String mapLink = ""
mapLink = await _zaptSdkFlutterPlugin.getMapLink({'placeId': placeId, 'options': options});

ZaptMap Widget

The ZaptMap Widget brings a real-time location map implementation, ready to be integrated into the APP.

import 'package:zapt_sdk_flutter/zapt_sdk_flutter.dart';

class Example extends StatefulWidget {
  const Example({Key? key}) : super(key: key);

  @override
  State<Example> createState() => _ExampleState();
}

class _ExampleState extends State<Example> {
  Map<String, String> options = {'floorId': '1'};
  final String placeId = "-ltvysf4acgzdxdhf81y";

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
        debugShowCheckedModeBanner: false,
        home: ZaptMap(
          placeId: placeId,
          options: options, //optional
          onCreated: (controller) => setState((){
          	_controller = controller,
        	}),
        ),
    );
  }
}

Note: Both in the getMapLink function and in the ZaptMap Widget, the placeID parameter is required for the Widget to work. If you have not yet received your location's unique identifier (PLACE_ID), please contact us at [e-mail].

Controller - Interacting with map

The ZaptMap Widget returns a controller through the onCreated callback, as shown in the example above. This controller provides methods for interacting with the map:

Change Floor

• setFloor - This method returns a Future that is resolved as soon as the new floor is initialized.

  Example:

  zaptController.setFloor(0);
  

• setMapId - This method returns a Future that is resolved as soon as the new map is initialized.

  Example:

  zaptController.mapId("-ltvysf4acgzdxdhf81y-floor0");
  

Centralize

• setCenter - Center the map according to a MapCenter instance with horizontal(x) and vertical(y) coordinates. You can pass zoom as an attribute or define it later.

  Example:

  zaptController.setCenter(MapCenter(x:100, y:100, zoom: 0));
  

• highlightInterestById - It takes the unique id of the POI as a parameter and centers the map on the POI coordinates.

  Example:

  zaptController.highlightInterestById("-mtcd5jwpv3bukpewpu_");
  

• removeHighlightInterest - Removes the focus from the POI, receives a bool as a parameter, which when true returns the map to the center and initial zoom.

  Example:

  zaptController.removeHighlightInterest();
  

Set Zoom

• setZoom - Receives the zoom value as a parameter. This value must be min ≤ zoom ≤ max, where min and max are defined in the map configuration.

  Example:

  zaptController.setZoom(0);
  

Rotate Map

• setRotation - Receives as a parameter the value of the angle in degrees.

  Example:

  zaptController.setRotation(180);
  

Start Route

• createRouteByIds - It traces a route between two POIs receiving as a parameter the ids of the points of interest of origin and destination respectively.

  Example:

  zaptController.createRouteByIds("-mtc1mhp6t5hwg9zdidy", "-ltfb2qqdg6jgwqhf1_i");
  

• createRouteByCoordinates - Receives as a parameter an instance of ReferencePoint for the origin and one for the destination.

  Example:

  zaptController.createRouteByIds(
      ReferencePoint(coordX: 340, coordY: 1130, floor: 1),
      ReferencePoint(coordX: 340, coordY: 1130, floor: 1)
  );
  

• removeRoute - Removes the traced route.

  Example:

  zaptController.removeRoute();
  

Monitoring Map Events

In the ZaptMap Widget it is possible to pass callbacks to listen to map events:

onChangeMapStatus

Through this callback it is possible to receive the map loading status as soon as it starts or finishes initializing.

 ZaptMap(
    ...
    onChangeMapStatus: (loading) => setState((){
      _mapIsLoading = loading;
    }),
  )

onMapStartsLoading

This callback is called every time a map starts loading. It receives as parameters the ID of the visitable, the ID of the floor that will be loaded, the name of the floor that will be loaded and the loading status of the map.

ZaptMap(
    ...
    onMapStartsLoading: (mapInfo) {
        debugPrint("Changing to floor name: ${mapInfo.floorName}");
        debugPrint("Changing to floor ID: ${mapInfo.floorId}");
        debugPrint("Changing to place ID: ${mapInfo.placeId}");
 	},
)

onMapFinishesLoading

This callback is called every time a map finishes loading. It receives as parameters the ID of the visitable, the ID of the floor that was loaded, the name of the floor that was loaded and the loading status of the map.

ZaptMap(
	...
	onMapFinishesLoading: (mapInfo) {
        debugPrint("Loaded on the floor name: ${mapInfo.floorName}");
        debugPrint("Loaded on the floor ID: ${mapInfo.floorId}");
        debugPrint("Loaded on the place ID: ${mapInfo.placeId}");
    },
)

onCancelRoute

This callback is called every time a route is canceled.

 ZaptMap(
    ...
    onCancelRoute: ()=> debugPrint("Route canceled"),
  )

onMapClick

This callback is called when the map is clicked. It receives as parameters the POI closest to the click, the coordinates of the exact point where the map was clicked and as a third parameter whether the click was inside the POI area.

When passing a function to this callback, the default behavior of opening a popup on the clicked POI ceases to happen.

 ZaptMap(
    ...
    onMapClick: (interestClicked, clickedPoint, clickInsidePOI) {
      debugPrint("Interest Id clicked ${interestClicked.id}");
      debugPrint("Clicked inside POI area $clickInsidePOI");
      debugPrint(
          "Clicked point: X: ${clickedPoint.x}  Y: ${clickedPoint.y}");
    },
  )

Permissions Request

As soon as the Map is initialized in the APP for the first time, permission will be requested to access the device's location, but if necessary, this permission can be requested at an earlier time through the requestPermissions() function.

Troubleshooting

If you are experiencing the following error when deploying to iOS:

error: include of non-modular header inside framework module 'zapt_sdk_flutter.ZaptSdkFlutterPlugin'

See the solution in this link

Layout Options

The getMapLink function (second parameter) and the ZaptMap Widget (options parameter) accept options to customize the map view.

Name	Type	Default	Description
bottomNavigation	bool	true	If true shows the bottom bar
appBar	bool	true	If true shows the top bar
search	bool	true	If true shows search field (on large screens)
splash	bool	true	If true shows Zapt Tech splash, if false shows generic splash
navBar	bool	true	If true shows the nav bar
embed	bool	false	If true removes all options

Functional Options

In addition to the layout options, the options attribute also receives an option for map functionality.

Name	Type	Description
floorId	string	Gets the ID of the floor on which the map should be launched. See this ID in the Portal.
zoom	number	Set the initial zoom of the map. The zoom value must be between the minimum and maximum limits defined in the map settings.
rotation	number	Defines an initial map rotation angle. This value can be between 0 and 360.
poi	string	Receives the ID of a point of interest and centers the map on it. See this ID in the Portal.

Center by Coordinates

Name	Type	Description
centerX	number	Set the initial center of the map horizontally
centerY	number	Set the initial center of the map horizontally

Note: The centerX and centerY attributes must be used at the same time to work.

Plot routes with points of interest

Name	Type	Description
fromPoi	string	ID of a point of interest for the start of a route.
toPoi	string	ID of a point of interest for the start of a route.

Note: You can add only the target point parameter. In this case the route will be drawn from the main entrance, if any. If only the starting point is entered, nothing will happen.

Trace routes with coordinates

Name	Type	Description
fromCoordinateX	number	X coordinate (horizontal) for route origin
fromCoordinateY	number	Y (vertical) coordinate for route origin
fromCoordinateZ	number	Z coordinate (walk) for route origin
toCoordinateX	number	X coordinate (horizontal) for route destination
toCoordinateY	number	Y (vertical) coordinate for route destination
toCoordinateZ	number	Z coordinate (walk) for route destination

Note: You can add only the target point parameter. In this case the route will be drawn from the main entrance, if any. If only the starting point is entered, nothing will happen.

Draw marker

Name	Type	Description
markerX	number	X coordinates (horizontal) where marker should be drawn.
markerY	number	Y coordinates (horizontal) where marker should be drawn.
markerZ	number	Z coordinates (floor) where marker should be drawn.