Руководство по продукту Содержание установка модуля «1с-битрикс: Интерактивная карта объектов»



страница5/11
Дата16.02.2017
Размер5.29 Mb.
Просмотров2296
Скачиваний0
ТипРуководство
1   2   3   4   5   6   7   8   9   10   11

Параметры по умолчанию

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

mapType


Тип

По умолчанию

Что означает

String

'yandex'

Тип карты для страницы с подключенным модулем

Если не указывать при инициализации тип, будет формироваться карта со значением по умолчанию.

$GeoMapp.init({

...

mapType: 'google',



...

});

mapScript


Объект, содержащий адрес подключаемого скрипта для соответствующей версии карты.

Тип

Тип карты

Значение по умолчанию

Версия

Object

google

'//maps.googleapis.com/maps/api/js?sensor=true&language=ru'

Google Maps (V3)

yandex

'//api-maps.yandex.ru/2.1/?lang=ru'

Yandex карты (2.1)

При необходимости эти параметры можно заменить, однако следует помнить про возможные изменения в API при их модернизации и связанные с этим отличия в работе.

$GeoMapp.init({

...

mapscript: {



google: '//maps.googleapis.com/maps/api/js?sensor=true&language=ru',

yandex: '//api-maps.yandex.ru/2.1/?lang=ru_RU'

},

...


});

Поддерживается и предыдущая версия подключения с дополнительным параметром:



Тип

Тип карты

Параметр

Значение по умолчанию

Версия

Object

google

main

'//maps.googleapis.com/maps/api/js?sensor=true&language=ru'

Google Maps (V3)

yandex

main

'//api-maps.yandex.ru/2.1/?lang=ru'

Yandex карты (2.1)

Такой синтаксис предполагает подключение дополнительных скриптов в зависимости от типа карты, но в текущей версии эта возможность не используется.

$GeoMapp.init({

...

mapScript: {



google: {

'main': '//maps.googleapis.com/maps/api/js?sensor=true&language=ru'

},

yandex: {



'main': '//api-maps.yandex.ru/2.1/?lang=ru_RU'

}

},



...

});

routeType


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

Тип

Поля

Тип

Тип

Возможные значения

Что означает

Object

google

Array

String

'driving'

На машине

'walking'

Пешком

'transit'

Городским транспортом

'bicycling'

На велосипеде

yandex

Array

String

'driving'

На машине

Синим отмечено значение по умолчанию, которое будет использовано, если параметр будет отсутствовать, или его значение будет пустым.

$GeoMapp.init({

...

routeType: {



google: ['walking', 'driving', 'transit']

},

...



});

Параметры, связанные с загрузкой контента

responseTime


Тип

Единицы измерения

Значение

Что означает

Number

миллисекунды

10000

Максимальное время ожидания загрузки пула скриптов

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

$GeoMapp.init({

...

responseTime: 7000,



...

});

loadTime


Тип

Единицы измерения

Значение

Что означает

Number

миллисекунды

500

Минимальное время ожидания загрузки контента

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

$GeoMapp.init({

...

loadTime: 300,



...

});

Параметры для дополнительного отслеживания ошибок


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

listenMainScriptLoading


Тип

Desktop

Mobile

Что означает

Boolean

false

false

Отслеживание ошибок во время загрузки основных скриптов

Используется для отслеживания ошибок во время загрузки основных скриптов, перечисленных в параметре [libs]. Ошибки могут быть связаны как с недоступностью контента, так и с тем, что по этому адресу находится не скриптовое содержание.

$GeoMapp.init({

...

listenMainScriptLoading: true,



...

});

listenMapScriptLoading


Тип

Desktop

Mobile

Что означает

Boolean

false

false

Отслеживание ошибок во время загрузки скриптов карты

Используется для отслеживания ошибок во время загрузки скрипта карты, перечисленных в параметре [mapScript]. Ошибки могут быть связаны как с отсутствием контента (статус ответа 404), так и с тем, что по этому адресу находится не скриптовое содержание (статус ответа 200).

В мобильной версии при использовании значении по умолчанию (отслеживание отключено) соответствующее сообщение об ошибке не формируется, позволяя просматривать информацию об объектах без использования карты. Такое поведение возможно использовать принудительно с помощью параметра [withoutMap], который описан в разделе «Мобильные устройства» / «Необязательные параметры».

$GeoMapp.init({

...

listenMapScriptLoading: true,



...

});

Параметры подключения своих скриптов

libs


Массив адресов подключаемых скриптов для любой версии.

Тип

По умолчанию

Для чего необходим

Array

'iscroll.js'

Библиотека для прокрутки содержания на touch-экранах

Элементы массива — строки, которые представляют собой либо имя файла (например, 'common.js'), либо относительную или абсолютную ссылку на этот файл.

Значение этого параметра не заменяет значение по умолчанию, а добавляет переданные значения к уже имеющимся.

Если передать свой массив при инициализации карты, то произойдёт слияние массивов, что позволяет добавить свой скрипт.

Если строка представляет собой просто имя файла, он должен физически находиться в папке, указанной в параметре [defaultPath.libs] (описан в разделе «Уникальные параметры» / «Обязательные параметры»).

Поскольку все скрипты загружаются в асинхронном режиме, то порядок загрузки скриптов зависит только от ответа серверов, на которых они находятся. Однако, пока не произойдёт загрузки всех скриптов, указанных в параметре [libs], обработка данных и построение карты не начнётся (см. описание метода [ready] в разделе «API модуля»).

$GeoMapp.init({

...

libs: [


'custom.js', 'second.js'

],

...



});

Сообщения об ошибках при загрузке и построении интерфейса

parseMessages


Поля

По умолчанию

DEVICE_NOT_DEFINED

'Не указан тип устройства'

Связан с обязательным параметром инициализации [device] (описан в разделе «Уникальные параметры»). Параметр необходим для загрузки скрипта соответствующей версии устройств.

Поля

По умолчанию

UNKNOWN_DEFAULT_PATH

'Не указаны пути к файлам модуля'

Для работы с модулем требуется использование стилей и картинок, а также общих дополнительных плагинов. Пути для подключения этих компонентов указаны в обязательном параметре [defaultPath] (описан в разделе «Уникальные параметры»).

Поля

По умолчанию

PAGETYPE_NOT_DEFINED

'Не указан тип страницы'

Тип страницы необходим для работы с контентом разного типа и указывается в обязательном параметре [pageType] (описан в разделе «Уникальные параметры»).

Поля

По умолчанию

AJAX_NOT_DEFINED

'Не указан путь для загрузки данных'

Текущая версия модуля позволяет использовать загрузку отсутствующих данных, для чего требуется адрес, по которому отправляется фоновый запрос. Этот адрес указан в обязательном параметре [ajax] (описан в разделе «Уникальные параметры»).

Поля

По умолчанию

MAP_PARAMETERS_NOT_DEFINED

'Не заданы параметры карты'

Для построения карты требуется указание масштаба и центра, либо границ отображаемой области. Границы области передаются в обязательном параметре [mapBounds] (описан в разделе «Уникальные параметры»).

Поля

По умолчанию

COMMON_SCRIPT_NOT_LOADED

'Не удалось загрузить основные скрипты'

Сообщение этого типа выводится при возникновении ошибки во время загрузки всех скриптов модуля, включая указанные в параметре [libs] (описан выше в разделе «Параметры, связанные с типом карты»).

Поля

По умолчанию

MAP_SCRIPT_NOT_LOADED

'Не удалось загрузить скрипты карты'

Сообщение этого типа выводится при возникновении ошибки во время загрузки скрипта карты, указанного в параметре [mapScript] (описан выше в разделе «Параметры, связанные с типом карты»).

Поля

По умолчанию

MAP_DENIED **

'Запрет на использование карты для прокладки маршрута'

Это сообщение может появиться исключительно на странице прокладки маршрута в мобильной версии (тип страницы direction).

Поля

По умолчанию

ERRORS_COMMON_LOADING

'Неопределённая ошибка во время загрузки основных скриптов'

Такое сообщение возможно только при использовании параметра [listenMainScriptLoading] (описан выше в разделе «Параметры для дополнительного отслеживания ошибок»).

Поля

По умолчанию

ERRORS_MAP_LOADING *

'Неопределённая ошибка во время загрузки скриптов карты'

Такое сообщение возможно только в версии для стационарных устройств и планшетов при использовании параметра [listenMainScriptLoading] (описан выше в разделе «Параметры для дополнительного отслеживания ошибок»).

Поля

По умолчанию

NO_CATS **

'Нет ни одной категории'

Такое сообщение выводится в версии для мобильных устройств в случае, если на странице категорий (тип страницы category) не указано ни одной категории.

Поля

По умолчанию

NO_ITEMS

'Нет ни одного объекта'

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

Поля

По умолчанию

INDEFINED_ERRORS

'Неопределённая ошибка'

Этот вид ошибки зарезервирован для необычных случаев (на данный момент не используется).

$GeoMapp.init({

...

parseMessages: [



DEVICE_NOT_DEFINED: 'Нет никакой ложки'

],

...



});

Информирование о процессе прокладки маршрута

routeMessages


Поля

По умолчанию

Что означает

INVALID_REQUEST

'Неверный запрос'

Неверный формат переданных данных

MAX_WAYPOINTS_EXCEEDED

'Слишком много промежуточных точек'

Передано слишком много промежуточных точек

NOT_FOUND

'Часть координат неверно задана или невозможно распознать адрес'

Неверный формат координат хотя бы для одной из переданных точек маршрута

OK

'Запрос выполнен'

Подтверждение запроса

OVER_QUERY_LIMIT

'Превышен лимит на количество запросов'

Ограничение количества обращений к геосервису (требуется лицензия)

REQUEST_DENIED

'Сервис на этой странице недоступен'

Отказ в обработке запроса

UNKNOWN_ERROR

'Ошибка неизвестной природы'

Неизвестная ошибка

ZERO_RESULTS

'Невозможно проложить маршрут'

Пустой ответ

wait

'Ожидается ответ на запрос...'

Ожидание ответа при прокладке маршрута

blocked

'Функция определения местоположения заблокирована. Введите адрес вручную.'

Сервис геолокации заблокирован пользователем

none

'Функция определения не поддерживается. Введите адрес вручную.'

Сервис геолокации не поддерживается


Настройка текста, используемого в интерфейсе

interfaceText


Объект — набор строковых значений для элементов основного интерфейса.

Поля

По умолчанию

Что означает

error

'Ошибка'

Используется при выводе сообщения об ошибке

collapsePanel

'Свернуть'

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

closeList

'Закрыть'

Подсказка для кнопки закрытия

catsTitle

'Категории'

Название панели с категориями

subcatsTitle

'Подкатегории'

Название панели с дополнительными категориями (только для режима панелей)

objectsTitle

'Объекты'

Название панели с объектами

popupTitle

'Объекты'

Название панели с описанием объекта (только для режима панелей)

title

Заголовок документа

Название, выводимое в верхней части при развороте карты на полный экран

clearField

'Очистить поле'

Подсказка на кнопке сброса фильтрации на основе введённых символов

placeHolder

'Поиск. Например, Арбат'

Замещающий текст в поле фильтра

refreshMarkers

'Обновить маркеры'

Подсказка на кнопке обновления маркеров на основе результатов фильтрации

clearCategories

'Отменить выбор'

Надпись на кнопке под списком категорий

showList

'Список'

Надпись на свёрнутой панели объектов

back

'Вернуться'

Пока не используется

showMarker

'Показать на карте'

Подсказка на геокнопке в списке объектов

route

'Маршрут'

Подсказка/надпись на кнопке прокладки маршрута

walking

'Пешком'

Подсказка на кнопке выбора типа маршрута

transit

'Транспорт'

Подсказка на кнопке выбора типа маршрута

driving

'Авто'

Подсказка на кнопке выбора типа маршрута

bicycling

'Велосипед'

Подсказка на кнопке выбора типа маршрута

toWalk

'Идти'

Надпись при выборе типа транспорта

toDrive

'Ехать'

Надпись при выборе типа транспорта

reverseDirection

'Сменить направление'

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

createRoute

'Проложить'

Надпись на кнопке прокладки маршрута

pointsTitle

'Объекты маршрута'

Заголовок в легенде маршрута

currentPosition

'Мое текущее положение'

Начальная надпись в поле выбора стартовой точки маршрута

from

'Откуда'

Подпись к полю выбора стартовой точки маршрута

to

'Куда'

Подпись к полю выбора конечной точки маршрута

catAbstractName

'Группа'

Абстрактное название категории

directionTitle

'Настройка маршрута'

Название панели с параметрами прокладываемого маршрута

popular

'Популярные'

Название вкладки с популярными маршрутами

closeMap

'Закрыть карту'

Подсказка для кнопки закрытия слоя карты

groupCategoryName

'Без категории'

Название для родительской папки одиночных категорий

multiObjects

'Объекты по адресу'

Заголовок списка объектов по этому адресу

showObjects

'Показать все объекты по адресу'

Название на элементе для показа всех объектов по этому адресу

showCurrentObject

'Вернуться к выбранному объекту'

Название элемента для возврата к текущему объекту в списке

increaseZoom

'Увеличить масштаб'

Подсказка для кнопки увеличения масштаба карты

decreaseZoom

'Уменьшить масштаб'

Подсказка для кнопки уменьшения масштаба карты

showFullScreen

'Развернуть карту на полный экран'

Подсказка для кнопки полноэкранного показа карты

showMap

'Открыть карту'

Подсказка на кнопке развёртывания слоя с картой (не используется)

showMapObject

'Показать на карте'

Подсказка для произвольного элемента с параметрами показа карты (не используется)

choiceMarker

'Выбрать маркер на карте'

Содержание поля для имени второго объекта по умолчанию

choiceText

'Переключить выбор'

Подсказка на кнопке переключения ввода адреса и выбора объекта



Параметры настройки внешнего вида

icon


Параметры, описывающие иконки категорий и маркеры.

Поля

Desktop

Mobile

Что означает

objects

Описание спрайта иконок для объектов




url

'objects.png'

'objects.png'

Адрес спрайта




size

[30, 40]

[30, 40]

Размеры иконки




anchor

[15, 37]

[15, 37]

Положение точки на карте от верхнего левого края иконки (привязка)




logo

[30, 30]




Размер площадки логотипа категории

events

Описание спрайта иконок для событий




url

'events.png'

'events.png'

Адрес спрайта




size

[30, 30]

[30, 30]

Размеры иконки




anchor

[15, 15]

[15, 15]

Положение точки на карте от верхнего левого края иконки (привязка)




logo

[30, 30]




Размер площадки логотипа категории

routes

Описание спрайта иконок для маршрутов




url

'routes.png'

'routes.png'

Адрес спрайта




size

[30, 40]

[30, 40]

Размеры иконки




anchor

[15, 37]

[15, 37]

Положение точки на карте от верхнего левого края иконки (привязка)




logo

[30, 30]




Размер площадки логотипа категории

category

Описание спрайта иконок для маршрутов




url




'category.png'

Адрес спрайта




size




[70, 60]

Размеры иконки




anchor




[35, 35]

Положение точки на карте от верхнего левого края иконки (привязка)




scale




2

Масштаб для чёткости изображения

direction

Описание спрайта иконок для маршрутов




url

'direction.png'

'direction.png'

Адрес спрайта




size

[30, 40]

[30, 40]

Размеры иконки




anchor

[15, 37]

[15, 37]

Положение точки на карте от верхнего левого края иконки (привязка)

Работа со спрайтом построена на принципе 3-х горизонтальных линий иконок — для логотипов категорий в левой панели, для иконок неактивных и активных (при клике) маркеров.

Параметр anchor привязки определяет положение точки относительно левого верхнего угла иконки. Если не передавать параметр, положение будет установлено в середину нижнего края.

Параметр logo — это размер площадки с логотипом категории.

Линия активных маркеров вплотную примыкает к линии неактивных (при показе активного маркера спрайт смещается вверх на высоту иконки). В свою очередь, линия неактивных маркеров начинается сразу после линии с логотипами. Общая высота спрайта составит logo[1] + 2 * size[1].

Левый край каждой из площадок тройки начинается на одном горизонтальном расстоянии — это называется шаг. Именно это расстояние смещения указывается при описании каждой категории при инициализации карты. В первой позиции находится тройка для отображения маркера и иконки категории по умолчанию. Именно маркер из этой тройки используется при указании параметра [universalMarker].

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

Для мобильной версии с целью повышения резкости логотипов категорий размер изображений превышает отображаемый. Масштаб указывается в параметре [scale]. Это означает, что изображение будет меньше исходного в указанное количество раз.

path


Перечень параметров, описывающих линию маршрута.

Поля

Desktop

Mobile

Что означает

def

Описание иконки для маркеров-узлов




size

[20, 20]

[20, 20]

Размеры иконки




anchor

[10, 10]

[10, 10]

Положение точки на карте от верхнего левого края иконки (привязка)




offset

[60, 30]

[60, 0]

Вертикальное расстояние от левого верхнего угла спрайта до левого верхнего угла области

active

Иконка для активных маркеров-узлов




size

[20, 20]

[20, 20]







anchor

[10, 10]

[10, 10]




offset

[80, 30]

[80, 0]

strokeWeight

4

4

Ширина линии

strokeColor

'#4f84b0'

'#113a9e'

Цвет линии

strokeColorActive

'#ec473b'




Цвет линии активного маршрута

strokeOpacity

.7

.7

Непрозрачность линии (0 — полностью прозрачный, 1 — полностью непрозрачный)

strokeOpacityHover

1




Непрозрачность линии маршрута при наведении

Параметры пути тесно связаны с маршрутами, но описаны отдельно по техническим причинам. Параметры иконок для точек маршрута берутся из [icon.routes].

Розовым выделены не использующиеся параметры.


directionOptions


Перечень параметров, описывающих линию проложенного маршрута.

Поля

Desktop

Mobile

Что означает

def

Описание иконки для маркеров-узлов




size

[20, 20]

[20, 20]

Размеры иконки




anchor

[10, 10]

[10, 10]

Положение точки на карте от верхнего левого края иконки (привязка)




offset

[80, 0]

[80, 0]

Вертикальное расстояние от левого верхнего угла спрайта до левого верхнего угла области

strokeWeight

4

4

Ширина линии

strokeColor

'#0080ff'

'#0080ff'

Цвет линии

strokeOpacity

1

1

Непрозрачность линии (0 — полностью прозрачный, 1 — полностью непрозрачный)

Параметры иконок старта и окончания проложенного маршрута описаны в [icon.direction]. Промежуточные маркеры маршрута в данный момент не рисуются. Иконки для промежуточных точек в текстовом описании описаны в стилях (описание стилей в конце документа).

cluster


Перечень параметров, описывающих кластеризацию маркеров при изменении масштаба.

Поля

Поля

По умолчанию

Что означает

gridSize




32

Шаг сетки

anchor




[0, 0]

Смещение центра иконки от точки кластеризации

icon




'cluster.png'

Адрес иконки

color




'#fff'

Цвет цифр

set




Массив

Набор иконок и их размер




Кластер до 10 маркеров




size

50







Кластер до 100 маркеров




size

60







Кластер до 1000 маркеров




size

74







Кластер свыше 1000 маркеров




size

90




Параметр set — массив объектов. Градация состоит из 4-х шагов: до 10, до 100, до 1000 и свыше 1000 маркеров в кластере. Каждый элемент массива — объект с описанием иконки кластера.



Поделитесь с Вашими друзьями:
1   2   3   4   5   6   7   8   9   10   11


База данных защищена авторским правом ©nethash.ru 2019
обратиться к администрации

войти | регистрация
    Главная страница


загрузить материал