Подпись:

Оглавление

Глава 1..................................................................................................................................................................................................................... 3

Где и что?......................................................................................................................................................................................................... 3

Требования для функционирования.......................................................................................................................................................... 3

Интеграция карт с вашим сайтом........................................................................................................................................................... 4

Проверка работоспособности................................................................................................................................................................... 5

Проверка работоспособности штатных компонентов.................................................................................................................................... 6

Глава 2..................................................................................................................................................................................................................... 7

Начинаем работу........................................................................................................................................................................................... 7

НЕ нашли? Не то? Что вы ищете?

Вставка экспорт-фрейма в страницу вашего сайта.......................................................................................................................... 7

Правила формирования GET-параметров в URL экспорт-фрейма................................................................................................................ 8

Глава 3.................................................................................................................................................................................................................. 11

Сервисы данных для интеграции с *****....................................................................................................................................... 11

Список населенных пунктов и их кодов................................................................................................................................................. 11

Список районов города............................................................................................................................................................................... 11

Список улиц.................................................................................................................................................................................................... 12

Список адресов и перекрестков на улице.............................................................................................................................................. 12

Дата модификации справочника улиц.................................................................................................................................................. 13

Дата модификации справочника адресов............................................................................... 13

Глава 1

  Где и что?

Мы предоставляем возможность использования карт в ваших проектах, в виде конечного решения, обслуживаемого на стороне UMAP.

Решение расположено по адресу http://www. *****/mapd/index. php, подключение его осуществляется через iframe (HTML-тэг).

  Требования для функционирования

Проект ***** предоставляет доступ на основе авторизации вида «пользователь-сервер».

Для работы без проблем вам необходимо зарегистрироваться на портале ***** и указать доменное имя вашего сервера на странице настроек (http://www. *****/show/user/profile/view) в закладке «Мои сайты», на котором будет работать этот модуль. Если таких имен много, то нужно указать каждый (для непривилегированного пользователя имеется возможность указания только одного домена).

Будем полагать, что ваш идентификатор на протяжении всей документации будет равен _UMAP_sUser.

Получив идентификатор пользователя после регистрации (он генерируется автоматически) вы можете использовать его в дальнейшем для работы с модулем.

Для привилегированных пользователей идентификатор генерируется вручную и выдается непосредственно пользователю вместе с договором сотрудниками *****.

   

  Интеграция карт с вашим сайтом

Карты, предоставляемые проектом ***** могут быть использованы на Вашем сайте в следующих целях:

    Предоставление пользователям геоинформационного интерфейса на страницах вашего сайта (увеличение информационной емкости вашего сайта). Привязка справочных объектов своей системы к географической карте (возможность быстрой сноски на местоположение объекта на карте) Наглядное представление множества объектов на географической карте (работа с выделенными слоями)

Соответственно, задача интеграции разбивается на три этапа:

1.  Вставка экспорт-фрейма в страницу вашего Сайта

2.  Правила формирования GET-запроса фрейма для позиционировки на определенное место:

a.  По адресу

b.  По координатам

c.  По ID-объекта *****

d.  По ID-адреса *****

3.  Правила формирования GET-запроса фрейма для включения опциональных слоёв.

  Проверка работоспособности.

Создайте страницу в корне своего сайта, следующего содержания:

<html>

<head>

<title>Тестовая страница карты uMap </title>

</head >

<body >

<iframe src="http://www. *****/mapd/index. php?user=[имя пользователя]" width="100%" height="800" frameborder="0" scrolling="no"></iframe>

</body >

</html >

   

В случае успешно пройденных предыдущих этапов, при открытии страницы должна загрузиться карта г. Екатеринбурга с поисковым интерфейсом.
Проверка работоспособности штатных компонентов

Основные загружаемые компоненты – это масштабная линейка, интерфейс, поисковик, слои, миникарта* , меню и информер.

После загрузки тестовой страницы работоспособность компонент можно проверить по визуальной и поведенческой части:

·  Масштабная линейка – расположена в левом верхнем углу, с активированным ползунком, который можно свободно перетаскивать по делениям линейки.

·  Интерфейс – присутствует в виде закладок в левой части (выровненной по верхней части). Закладки раскрываются при нажатии и активируют содержимое.

·  Поисковик – субкомпонента интерфейса, работающая в закладке «Поиск». Для проверки достаточно открыть закладку и убедиться, что в ней есть содержимое и поле ввода. Также имеет смысл ввести проверочное слово «молоко» в это поле ввода и нажать кнопку «найти», если после этого произошло изменение содержимого и на карте появились флажки с цифрами – компонент в работе.

·  Слои – субкомонента интерфейса, работающая в закладке «Слои». Для проверки откройте эту закладку и убедитесь, что в ней есть содержимое в виде разделов с чекбоксами. Нажав на чекбокс второго уровня вы должны увидеть отрисовку объектов на карте. В этом случае компонент исправен.

·  Миникарта * – располагается правом нижнем углу, позволяет осуществлять быстрое панорамирование карты.

·  Меню – это контекстное меню, которое должно открываться при нажатии правой кнопкой на любое место карты (кроме объектов на ней).

·  Информер – субкомпонента интерфейса, которую можно быстро проверить, нажав на номер дома (на самом близком масштабе) и увидев открывшийся поп-ап с данными по адресу.

* - Отсутствует в версиях ниже 0.1.4

   


Глава 2

  Начинаем работу

  Вставка экспорт-фрейма в страницу вашего сайта

Для вставки фрейма понадобится конструкция вида <iframe width=".." height=".." src=".."></iframe>. Конструкция может быть размещена практически в любом месте вашей страницы (не противореча спецификации HTML).

width, height – ширина и высота окна фрейма. Вы можете задавать как пиксельные, так и процентные значения, карта растянется под любой указанный размер. Будьте осторожны в случае с height="n%" – блок, в котором размещается iframe, должен обладать при этом ненулевой прописанной в стилях/атрибутах высотой, иначе вы получите iframe нулевой высоты.

src – атрибут, где указывается URL с параметрами экспорт-фрейма.

Для быстрой вставки фрейма в страницу достаточно прописать в ней следующее выражение:

<iframe src="http://www. *****/mapd/index. php?user=[имя пользователя]" width="100%" height="800" frameborder="0" scrolling="no"></iframe>
Правила формирования GET-параметров в URL экспорт-фрейма

После того, как вы успешно вставили экспорт-фрейм в страницу вашего сайта, может возникнуть необходимость управления возможностями фрейма. Это осуществляется путём передачи GET-параметров в URL фрейма.

<iframe width="100%" height="800" src="http://www. *****/mapd/index. php?name=30066&scaleIndex=1" frameborder="0" scrolling="no"></iframe>

Жирным в примере выделена типичная строка GET-параметров.

Параметры для открытия карты города

Для этого используется два вида параметров:

name = [ID города] - идентификатор города в БД *****.

или

city = [Название города] - название города в БД ***** (как правило, простое текстовое название города).

Например:

<iframe width="100%" height="800" src="http://www. *****/mapd/index. php?name=30066" frameborder="0" scrolling="no"></iframe>

или

<iframe width="100%" height="800" src="http://www. *****/mapd/index. php?city=Екатеринбург" frameborder="0" scrolling="no"></iframe>

Карта Екатеринбурга

Параметры для позиционировки карты на адрес

Следующие параметры:

street = [Название улицы] – название улицы в БД ***** (как правило, простое текстовое название улицы).

house = [Номер дома или название перекрестной улицы] – Номер дома вместе с корпусом и литерой (если есть) слитно.

Например:

<iframe width="100%" height="800" src="http://www. *****/mapd/index. php? name=30066&street=Малышева&house=25" frameborder="0" scrolling="no"></iframe>

или

<iframe width="100%" height="800" src="http://www. *****/mapd/index. php? name=Екатеринбург&street=Малышева&house=8-е Марта" frameborder="0" scrolling="no"></iframe>

Параметры для позиционировки карты о координатам

Следующие параметры:

centerX = [Значение x-координаты] – x-координата сервиса карты для центровки

centerY = [Значение y-координаты] - y-координата сервиса карты для центровки

showX = [Значение x-координаты] - x-координата сервиса карты для отрисовки стрелки-указателя

showy = [Значение y-координаты] - y-координата сервиса карты для отрисовки стрелки-указателя

scaleIndex = [Индекс масштаба] - индекс масштаба (диапазон может варьироваться в зависимости от города) – 0 – самый крупный, 8 – самый мелкий.

Например:

<iframe width="100%" height="800" src="http://www. *****/mapd/index. php? name=30066&centerX=32030&centerY=-30230&scaleIndex=4" frameborder="0" scrolling="no"></iframe>

или

<iframe width="100%" height="800" src="http://www. *****/mapd/index. php? name=30066&centerX=32030&centerY=-30230&showX=32030&showY=-30230&scaleIndex=4" frameborder="0" scrolling="no"></iframe>

Параметры для позицонировки карты по ID организации *****

Следующие параметры:

orgId = [ID организации] – внутренний ID организации в БД *****.

Например:

<iframe width="100%" height="800" src="http://www. *****/mapd/index. php? name=30066&orgId=3594"></iframe>

Параметры для позиционировки карты по ID адреса *****

Следующие параметры:

addrId = [ID адреса] – внутренний ID адреса в БД *****

Например:

<iframe width="100%" height="800" src="http://www. *****/mapd/index. php? name=30066&addrId=762"></iframe>


Глава 3

  Сервисы данных для интеграции с *****

  Список населенных пунктов и их кодов

Формат запроса:

http://www. *****/assets/map/srv. php? u=USERID&t=maplist

Выходной XML содержит список доступных населенных пунктов (перечень указывается в договоре обслуживания).

<root>
<c code="число"
name="строка"
type="строка"
ftype="строка"
region="число"/>

</root>

/root/c/@code – код нас. пункта, который нужно передавать в запросы на получение данных

/root/c/@name – название нас. пункта

/root/c/@type – сокращенный тип нас. пункта (г., д., с., РП и т. д.)

/root/c/@ftype – полный тип нас. пункта (город, деревня, село, рабочий поселок и т. д.)

/root/c/@region – код региона, в котором находится нас. пункт.

Список кодов регионов:

45 – Курганская область

59 – Пермская область

66 – Свердловская область

72 – Тюменская область

74 – Челябинская область

86 – ХМАО

89 – ЯНАО

  Список районов города

Формат запроса:

http://www. *****/assets/map/srv. php? u=USERID&t=district&n=CITYCODE

CITYCODE – код нас. пункта

Выходной XML содержит список административных и жилых районов города:

<root>
<adm code="число"
name="строка"/>

<res code="число"
name="строка"/>

</root>

/root/adm/@code – код административного района

/root/adm/@name – название административного района (без слова "район")

/root/res/@code – код жилого района

/root/res/@name – название жилого района

  Список улиц

Формат запроса:

http://www. *****/assets/map/srv. php? u=USERID&t=strtlist&n=CITYCODE
[& (c=STREETCODE) | (p=STREETNAME)]

CITYCODE – код нас. пункта

STREETCODE – код улицы (необязательный параметр)

STREETNAME – первые буквы названия улицы (необязательный параметр)

Выходной XML содержит весь список улиц или подходящих под уточняющий критерий (код или первые буквы названия):

<root>
<s code="число"
name="строка"
type="строка"
ftype="строка"
loc="строка">
<a name="строка"
type="строка"
ftype="строка"/>
<a …/>

</s>

</root>

/root/s/@code – код улицы

/root/s/@name – название улицы

/root/s/@type – сокращенный тип (пер., просп. и т. д.), для типа "ул." – не указывается

/root/s/@ftype – полный тип (переулок, проспект и т. д.), для типа "улица" – не указывается

/root/s/@loc – месторасположение улицы (только для дубликатных названий)

/root/s/a/@name – дополнительное название улицы (псевдоним или устаревшее)

/root/s/a/@type – сокращенный тип, указывается только если отличается от типа основной улицы

/root/s/a/@ftype – полный тип, указывается только если отличается от типа основной улицы

  Список адресов и перекрестков на улице

Формат запроса:

http://www. *****/assets/map/srv. php? u=USERID&t=strt&n=CITYCODE&s=STREETCODE

CITYCODE – код нас. пункта

STREETCODE – код улицы

Выходной XML содержит перечень кодов адресов по указанной улице в порядке возрастания номера, первый номер – это условная точка в начале улицы.

<root>
<a code="число"
home="строка"
adm="число"
res="число"/>

<s code="число"/>

</root>

/root/a/@code – код адреса в нас. пункте

/root/a/@home – номер здания на улице

/root/a/@adm – код административного района города (отсутствует, если неизвестен)

/root/a/@res – код жилого района города (отсутствует, если неизвестен)

/root/s/@code – код пересекающей улицы

  Дата модификации справочника улиц

Формат запроса:

http://www. *****/assets/map/srv. php? u=USERID&t=dt_strt&n=CITYCODE

CITYCODE – код нас. пункта

Выходной XML содержит дату последнего изменения справочника улиц указанного нас. пункта.

<root>
<dt modified="строка"/>
</root>

/root/dt/@modified – дата в формате "yyyy-mm-dd"

  Дата модификации справочника адресов

Формат запроса:

http://www. *****/assets/map/srv. php? u=USERID&t=dt_addr&n=CITYCODE

CITYCODE – код нас. пункта

Выходной XML содержит дату последнего изменения справочника адресов и перекрестков указанного нас. пункта.

<root>
<dt modified="строка"/>
</root>

/root/dt/@modified – дата в формате "yyyy-mm-dd"