Release 4.0.0-preview1-00285
[platform/core/csapi/tizenfx.git] / src / Tizen.Maps / doc / api / Tizen.Maps.md
1 ---
2 uid: Tizen.Maps
3 remarks: *content
4 ---
5 ## Overview
6
7 Maps API provides a developer with a set of functions, helping to create Maps aware applications.
8
9 Maps API comprises of following features:
10 - [Geocoding](#geocoding) and [reverse Geocoding](#reverse-geocoding)
11 - Discoverying [place](#places) information
12 - Calculating [route](#route)
13 - [View](#view)
14
15 Maps API allows a Developer to choose one of Map Providers which are being included as plugins.
16
17 ### Geocoding
18
19 The [Maps Geocoding](xref:Tizen.Maps.GeocodeRequest) API allows translating an address to its geographical
20 location defined in terms of latitude and longitude; the input can be a
21 qualified and structured address or a free-formed search text with full or
22 partial address information.
23
24 The example below shows a structured address:
25  - housenumber=117,
26  - street=Invaliden street
27  - city=Berlin,
28  - postalcode=10115,
29  - country=Germany,
30  - state=Berlin
31
32
33 ### Reverse Geocoding
34
35 The [Maps Reverse Geocoding](xref:Tizen.Maps.ReverseGeocodeRequest) API allows to inverse translating a geographical
36 location (longitude, latitude) to an address; it can be used to answer the
37 question "Where am I?".
38
39
40 ### Route
41
42 The [Maps Route](xref:Tizen.Maps.Route) API provides ways to calculate a route that defines a path
43 between a start and a destination and may, optionally, pass through specific
44 intermediate locations.
45
46 Route Preferences:
47  - Travel Mode (car, pedestrian, public transit, truck),
48  - Optimization (fastest, shortest),
49  - Avoid/Prefer Preferences (toll road, motorway, ferry, public transit,
50    tunnel, dirt road, parks, car-pool lane).
51  - Route Calculations
52  - Way points and preferences as input values,
53  - Route geometry and maneuver (instructions for guidance) as result values:
54    Geometry consists of points that visually represent the determined route,
55    Maneuver contains turn-by-turn instruction and position.
56
57
58 ### Places
59
60 The [Maps Place](xref:Tizen.Maps.Place) API allows you to find place information.
61
62 Place search
63  - Depending on the location context, the number of relevant places might
64    be large. Therefore this query may not only return places, but also
65    suggestions for additional filter criteria that allow users to interactively
66    refine the classes of places they are interested in.
67  - Nearby Search: search for places within a specified area.
68    You can refine your search request by supplying keywords, Name of Points
69    of Interests, or Proximity.
70  - Category Search: search for popular places for the given location context and matching the category filter criteria.
71    You can refine your search request by specifying the categories of place you are searching for.
72 Result item type of searching
73  - ID, name, location, distance, URI, rating, category.
74 Place information allows to fetch details about a place. The following place content is supported:
75  - Base Attribute includes name, location, categories, contacts, ID, ratings, icon path,
76    image content, review content, and editorial content.
77  - Extended Attribute refers to opening hours, payment methods, annual closings, disabled access.
78
79
80 ### View
81 The [Maps View](xref:Tizen.Maps.MapView) API provides a developer with a set of functions, bringing
82 basic interactive visual user interface in maps applications.
83
84 View widget: Drawing a map image on the map port, the specified rectangular
85 area of the maps application GUI.
86
87 Zoom and rotation: Changing zoom and orientation of the view in response
88 to user gestures, such as scrolling, tapping, zooming, rotating, etc.
89
90 Conversion of screen coordinates to geographical and vice versa.
91
92 User's gesture support:
93  - Receive the event of the user gesture.
94  - Enable or disable the specified gesture.
95  - Re-assign the action, which should be taken in response to the user's gesture.
96
97 Various Properties:
98  - Visibility and size on the screen.
99  - Theme: Day, satellite, or terrain.
100  - Language: English, Russian, Chinese, Italian, German, Spanish, etc.
101
102
103 ### Related Features
104 To guarantee that the Maps application runs on a device with Maps profile feature,
105 declare the following feature requirements in the config file:
106 * http://tizen.org/feature/maps
107 * http://tizen.org/feature/internet