2. Свойства и опции
accessToken:string
Токен доступа к карте. The event type.
src/index.js
Пример (см. ниже).
mmrgl.accessToken = myAccessToken
baseApiUrl:string
Начальный API URL, используемый для получения тайлов, стилей, спрайтов и глифов.
src/index.js
Пример (см. ниже).
mmrgl.baseApiUrl = 'https://geo.rustore.ru/api';
workerCount:number
Количество веб-воркеров на странице с GL JS картами. По умолчанию это половина числа ядер (ограничено 6). Обязательно нужно устанавливать этот параметр перед инициализацией карты.
src/index.js
Пример (см. ниже).
mmrgl.workerCount = 2;
maxParallelImageRequests:number
Максимальное количество изображений (растровых тайлов, спрайтов, иконок) для параллельной загрузки. Влияет на производительность в растровых картах. 16 по умолчанию.
src/index.js
Пример (см. ниже).
mmrgl.maxParallelImageRequests = 10;
supported:function
Проверяет поддержку браузером GL JS
src/index.js
Пример (см. ниже).
if (!mmrgl.supported()) {
alert( 'Your browser does not support MMR GL' );
}
version:string
Версия текущей сборки MMR GL
src/index.js
Пример (см. ниже).
console.log(mmrgl.version);
//> 1.2.3;
setRTLTextPlugin:function
Устанавливает плагин для поддержки RTL. Необходимо для поддержки арабского и еврейского языков.
src/index.js
Параметры:
pluginURL:string
— путь до RTL плагина;callback:function(error:object)
— функция вызывается если есть ошибка;lazy:boolean
— ленивая подгрузка.
Пример (см. ниже).
mmrgl.setRTLTextPlugin(pluginUrl, function (error) {
if (error) {
console.log('something was wrong', error);
} else {
console.log('rtl-text-plugin loaded successfully');
}
}, true);
getRTLTextPluginStatus:function
Получаем статус RTL-плагина. Статус плагина может быть: unavailable
(т. е. не запрошено или удалено), loading
, loaded
или error
. Если статус loaded
и плагин запрашивается снова, то будет выдана ошибка.
src/index.js
Пример (см. ниже).
const pluginStatus = mmrgl.getRTLTextPluginStatus();
clearStorage:function
Очищает cacheStorage
в котором могут храниться кэш тайлов
src/index.js
Параметры:
callback:function(error:object)
— путь до RTL-плагина.
Пример (см. ниже).
mmrgl.clearStorage()
AnimationOptions
(группа параметров)
Параметры, влияющие на анимацию (используются в методах: Map#panBy
, Map#easeTo
), контролируют продолжительность и функцию плавности анимации (easing function). Являются необязательными.
src/ui/camera.js
Параметры:
duration:number
— продолжительность анимации (в миллисекундах);easing:function
— функция, принимающая время в диапазоне 0..1 и возвращающая число, где 0-начальное состояние, а 1-конечное;offset:PointLike
— смещение центра относительно реального центра контейнера карты в конце анимации;animate:boolean
— если false, анимации будут отключены;essential:boolean
— если true, то анимация считается существенной и не будет затронута prefers-reduced-motion (предпочитает уменьшенное движение);