summaryrefslogtreecommitdiffstats
path: root/src/location/doc/src/plugins/esri.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/location/doc/src/plugins/esri.qdoc')
-rw-r--r--src/location/doc/src/plugins/esri.qdoc173
1 files changed, 173 insertions, 0 deletions
diff --git a/src/location/doc/src/plugins/esri.qdoc b/src/location/doc/src/plugins/esri.qdoc
new file mode 100644
index 00000000..06b0c2c1
--- /dev/null
+++ b/src/location/doc/src/plugins/esri.qdoc
@@ -0,0 +1,173 @@
+/****************************************************************************
+**
+** Copyright (C) 2013-2016 Esri <contracts@esri.com>
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtLocation module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\page location-plugin-esri.html
+\title Qt Location Esri Plugin
+\ingroup QtLocation-plugins
+
+\brief Uses Esri for location services.
+
+\section1 Overview
+
+This geo services plugin allows applications to access
+\l {http://www.esri.com}{Esri} location based services using the Qt Location API.
+The use of these services is governed by the \l {http://www.esri.com/legal/terms-use}{Esri terms of use}.
+
+Data is provided by \l {http://www.esri.com/data/find-data}{many different content providers}.
+
+The Esri geo services plugin can be loaded by using the plugin key "esri".
+
+\section1 Parameters
+
+\section2 Mandatory parameters
+
+\table
+\header
+ \li Parameter
+ \li Description
+\row
+ \li esri.token
+ \li Security token for using routing services only. Mapping and geocoding services do not require a token.
+\endtable
+
+To use the routing services hosted on ArcGIS Online with the Esri plugin, a token is required. You can \l{https://developers.arcgis.com/authentication/accessing-arcgis-online-services/#registering-your-application}{obtain a token for testing purposes},
+or you can sign up for an \l {http://www.arcgis.com/features/plans/pricing.html}{ArcGIS Online subscription}.
+
+\section2 Optional parameters
+
+\table
+\header
+ \li Parameter
+ \li Description
+\row
+ \li esri.useragent
+ \li User agent string sent when making network requests
+\row
+ \li esri.mapping.minimumZoomLevel
+ \li The minimum zoom level [double] at which the map is displayed
+\row
+ \li esri.mapping.maximumZoomLevel
+ \li The maximum level [double] at which the map is displayed
+\endtable
+
+\section2 Directions language
+
+The service supports generating directions in the following languages:
+
+\table
+\header
+ \li Language
+ \li Description
+\row
+ \li ar
+ \li Generate directions in Arabic
+\row
+ \li cs
+ \li Generate directions in Czech
+\row
+ \li de
+ \li Generate directions in German
+\row
+ \li el
+ \li Generate directions in Greek
+\row
+ \li en
+ \li (default) Generate directions in English
+\row
+ \li es
+ \li Generate directions in Spanish
+\row
+ \li et
+ \li Generate directions in Estonian
+\row
+ \li fr
+ \li Generate directions in French
+\row
+ \li he
+ \li Generate directions in Hebrew
+\row
+ \li it
+ \li Generate directions in Italian
+\row
+ \li ja
+ \li Generate directions in Japanese
+\row
+ \li ko
+ \li Generate directions in Korean
+\row
+ \li lt
+ \li Generate directions in Lithuanian
+\row
+ \li lv
+ \li Generate directions in Latvian
+\row
+ \li nl
+ \li Generate directions in Dutch
+\row
+ \li pl
+ \li Generate directions in Polish
+\row
+ \li pt-BR
+ \li Generate directions in Brazilian Portuguese
+\row
+ \li pt-PT
+ \li Generate directions in Portuguese (Portugal)
+\row
+ \li ru
+ \li Generate directions in Russian
+\row
+ \li sv
+ \li Generate directions in Swedish
+\row
+ \li tr
+ \li Generate directions in Turkish
+\row
+ \li zh-CN
+ \li Simplified Chinese
+\endtable
+
+If only unsupported language codes are specified via the \l{http://doc.qt.io/qt-5/qml-qtlocation-plugin.html#locales-prop}
+{locales} property, the service returns the directions using the default language, English.
+
+\section2 Directions length units
+
+QLocale::MetricSystem (default) use meters, other values (QLocale::ImperialUSSystem, QLocale::ImperialUSSystem) use feet.
+
+*/