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