Text search¶
Setup¶
Prerequisites¶
Build and run¶
Start a terminal/command prompt and go to the text_search
directory,
within the flutter examples directory - that is the name of this example project.
Note - the gem_kit
directory containing the Maps SDK for Flutter
should be in the plugins
directory of the example, e.g.
example_pathname/plugins/gem_kit
- see the environment setup guide above.
Replace example_pathname
with the actual example path name,
such as address_search
Download project dependencies:
flutter upgrade
run the following terminal commands in the project directory,
where the pubspec.yaml
file is located:
flutter clean
flutter pub get
Run the example:
flutter run
If such a question appears, select the chrome
browser; in the above example, press 2.
First, verify that the ANDROID_SDK_ROOT
environment variable
is set to the root path of your android SDK.
In android/build.gradle
add the maven {}
block as shown,
within the allprojects {} block
, for both debug and release builds,
without the line numbers, those are for reference:
1allprojects {
2 repositories {
3 google()
4 mavenCentral()
5 maven {
6 url "${rootDir}/../plugins/gem_kit/android/build"
7 }
8 }
9}
in android/app/build.gradle
within the android {}
block, in the defaultConfig {}
block,
the android SDK version minSdk
must be set as shown below.
Additionally, for release builds, in android/app/build.gradle
,
within the android {}
block, add the buildTypes {}
block as shown:
Replace example_pathname
with the actual example pathname, such as center_coordinates
1android {
2 defaultConfig {
3 applicationId "com.magiclane.gem_kit.examples.example_pathname"
4 minSdk 21
5 targetSdk flutter.targetSdk
6 versionCode flutterVersionCode.toInteger()
7 versionName flutterVersionName
8 }
9 buildTypes {
10 release {
11 // TODO: Add your own signing config for the release build.
12 // Signing with the debug keys for now, so `flutter run --release` works.
13 minifyEnabled false
14 shrinkResources false
15 signingConfig signingConfigs.debug
16 }
17 }
18}
Then build the apk:
flutter build apk --debug
flutter build apk --release
build/app/outputs/apk/debug
or
build/app/outputs/apk/release
subdirectory,
for debug or release build respectively,
within the current project directory, such as center_coordinates
app-release.apk
or app-debug.apk
adb push app-release.apk sdcard
And then click on the apk in the file browser on the device to install and run it.
In the ios/Podfile
configuration text file, at the top, set the minimum ios
platform to 13 like this:
platform :ios, '13.0'
pod install
in the [ios folder] ./ios/
flutter build ios
to build a Runner.app.flutter run
to build and run on an attached device.<path/to>/ios/Runner.xcworkspace
project in Xcode
and execute and debug from there.How it works¶
In the example project directory, such as center_coordinates
, there is a text file named
pubspec.yaml
which contains project configuration and dependencies.
The most important lines from this file are shown here:
1name: center_coordinates
2description: A Flutter example using Maps SDK for Flutter.
3
4version: 1.0.0+1
5
6environment:
7 sdk: '>=3.0.5 <4.0.0'
8
9dependencies:
10 flutter:
11 sdk: flutter
12 gem_kit:
13 path: plugins/gem_kit
14
15 cupertino_icons: ^1.0.2
16
17 dev_dependencies:
18 flutter_test:
19 sdk: flutter
20
21 flutter_lints: ^3.0.2
22
23# The following section is specific to Flutter packages.
24flutter:
25 uses-material-design: true
The project must have a name and version. The dependencies list the Flutter SDK, and the gem_kit, Maps for Flutter SDK.
The source code is in example_pathname/lib/main.dart
Replace example_pathname
with the actual example path name, such as center_coordinates
1import 'package:gem_kit/core.dart';
2import 'package:gem_kit/landmark_store.dart';
3import 'package:gem_kit/map.dart';
4import 'search_page.dart';
5import 'package:flutter/material.dart';
Note that the source file search_page.dart
also includes:
1import 'package:gem_kit/search.dart';
2import 'dart:async';
The dart
material package is imported, as well as the
required gem_kit
packages.
1void onMapCreated(GemMapController controller) {
2 _mapController = controller;
3}
This callback function is called when the interactive map is initialized and ready to use.
1// Custom method for navigating to search screen
2void _onSearchButtonPressed(BuildContext context) async {
3// Taking the coordinates at the center of the screen as reference coordinates for search.
4 final x = MediaQuery.of(context).size.width / 2;
5 final y = MediaQuery.of(context).size.height / 2;
6 final mapCoords = _mapController.transformScreenToWgs(XyType(x: x.toInt(), y: y.toInt()));
7
8// Navigating to search screen. The result will be the selected search result(Landmark)
9 final result = await Navigator.of(context).push(MaterialPageRoute<dynamic>(
10 builder: (context) => SearchPage(coordinates: mapCoords!),
11 ));
12
13 if (result is Landmark) {
14 // Retrieves the LandmarkStore with the given name.
15 var historyStore = LandmarkStoreService.getLandmarkStoreByName("History");
16
17 // If there is no LandmarkStore with this name, then create it.
18 historyStore ??= LandmarkStoreService.createLandmarkStore("History");
19
20 // Add the landmark to the store.
21 historyStore.addLandmark(result);
22
23 // Activating the highlight
24 _mapController.activateHighlight([result], renderSettings: RenderSettings());
25
26 // Centering the map on the desired coordinates
27 _mapController.centerOnCoordinates(result.coordinates);
28 }
29}
This is the method to navigate to the search screen, defined in the SearchPage()
widget,
in search_page.dart
1void _onSearchSubmitted(String text) {
2 SearchPreferences preferences = SearchPreferences(maxMatches: 40, allowFuzzyResults: true);
3
4 search(text, widget.coordinates, preferences: preferences);
5}
As text is typed in the text field by the user, the _onSearchSubmitted()
function is
called, which creates a preferences instance and then the search()
function is called.
The coordinates of the current location displayed on the map widget.coordinates
are used for comparison, to compute the distance to the positions of the search results.
1// Search method. Text and coordinates parameters are mandatory, preferences are optional.
2Future<void> search(String text, Coordinates coordinates, {SearchPreferences? preferences}) async {
3 Completer<List<Landmark>> completer = Completer<List<Landmark>>();
4
5// Calling the search method from the sdk.
6// (err, results) - is a callback function that calls when the computing is done.
7// err is an error code, results is a list of landmarks
8 SearchService.search(text, coordinates, preferences: preferences, (err, results) async {
9 // If there is an error or there aren't any results, the method will return an empty list.
10 if (err != GemError.success || results == null) {
11 completer.complete([]);
12 return;
13 }
14 if (!completer.isCompleted) completer.complete(results);
15 });
16 final result = await completer.future;
17 setState(() {
18 landmarks = result;
19 });
20}
The search()
function calls the SearchService.search()
, obtains a list of landmarks
in results
, which are then displayed as a text list. Tapping on a result causes the map
to be centered on the position of that search result.
This is done in the method that calls SearchPage()
above.
_mapController.activateHighlight([result], renderSettings: RenderSettings());
_mapController.centerOnCoordinates(result.coordinates);