1. Карта
Карта на странице связана с объектом Map
. Он предоставляет методы и свойства, позволяющие изменять карту из кода. При создании карты MMR GL JS инициализирует ее и возвращает объект Map
.
Параметры
Название | Тип | Описание |
---|---|---|
container | HTMLElement | string | HTML-элемент или id блока, в который MMR GL JS будет рендерить карту. Указанный элемент не должен содержать дочерних элементов. |
minZoom | number default: 0 | Минимальный уровень zoom (0-20). |
maxZoom | number default: 20 | Максимальный уровень zoom (0-20). |
minPitch | number default: 0 | Минимальный уровень наклона карты (0-85). |
maxPitch | number default: 85 | Максимальный уровень наклона карты (0-85). |
style | object | string | Стиль карты в формате JSON или ссылка на стиль. Это JSON-объект, составленный по правилами оформления стилей.
|
hash | boolean | string default: false | Если true , все параметры страницы (zoom , latitude , longitude и pitch ) будут синхронизированы в URL через # параметра. |
interactive | boolean default: false | Если false , карта не будет реагировать ни на какой элемент управления (мышь, экран, клавиатура). |
bearingSnap | number default: 7 | Граница, измеряемая в градусах, которая определяет когда пеленг карты будет привязан к северу. |
pitchWithRotate | boolean default: true | Если false , управление наклоном карты с помощью «drag and rotate» будет отключено. |
clickTolerance | number default: 3 | Максимальное количество пикселей, на которое пользователь может переместить указатель мыши во время щелчка, чтобы он считался допустимым щелчком (в отличие от перетаскивания мыши). |
attributionControl | boolean default: true | Если true , AttributionControl будет добавлен на карту. |
customAttribution | string | Array <string> | Строка или строки для отображения в AttributionControl. Возможно только если attributionControl = true . |
failIfMajorPerfomanceCaveat | boolean default: false | Если true , инициализация карты завершится с ошибкой если производительность карты будет не приемлемой. |
preserveDrawingBuffer | boolean default: false | Если true , холст карты можно экспортировать в PNG-изображение используя map.getCanvas().toDataUrl() . По умолчанию установлен в false , для улучшения производительности. |
antialias | boolean default: false | Если true , gl-контекст будет создан с применением MSAA-сглаживания, которое может быть полезно для сглаживания кастомных слоев. По умолчанию установлен в false , для улучшения производительности. |
refreshExpiredTiles | boolean default: true | Если false , то карта не будет запрашивать тайлы после истечения ср ока их жизни в соответствии с заголовками cacheControl / expires . |
maxBounds | LngLatBoundsLike | Если установлено, карта будет ограничена заданными границами. |
scrollZoom | boolean | object default: true | Если true , то увеличение с помощью скролла работает. Значение объекта передается в качестве параметров ScrollZoomHandler. |
boxZoom | boolean default: true | Если true , взаимодействие типа «box zoom» включено (подробнее BoxZoomHandler) |
dragRotate | boolean default: true | Если true , взаимодействие типа «drag to rotate» включено (подробнее DragRotateHandler ) |
dragPan | boolean | object default: true | Если true , взаимодействие типа «drag to pan» включено (подробнее DragPanHandler) |
keyboard | boolean default: true | Если true , можно использовать клавиатуру и сочетания клавиш для взаимодействия с картой (подробнееKeyboardHandler) |
doubleClickZoom | boolean default: true | Если true , взаимодействие типа «double click to zoom» включено (подробнее DoubleClickZoomHandler) |
touchZoomRotate | boolean | object default: true | Если true, взаимодействие типа «pinch to rotate and zoom» включено (подробнееTouchZoomRotateHandler) |
touchPitch | boolean | object default: true | Если true , взаимодействие типа «drag to pitch» включено (подробнее TouchPitchHandler) |
trackResize | boolean default: true | Если true , карта будет автоматически менять свой размер при изменении окна. |
center | LngLatLike default: [0,0] | Начальная точка карты. Если центр не указан в параметрах конструктора, MMR GL JS будет смотреть его в объекте стиля карты. Если он также не указан в стиле, то по умолчанию он будет равен [0, 0] .Примечание: используется порядок координат долготы, широты (в отличие от широты, долго ты) для соответствия GeoJSON. |
zoom | number default: 0 | Начальный уровень масштаба карты. Если уровень масштаба не указан в параметрах конструктора, MMR GL JS будет смотреть его в объекте стиля карты. Если он также не указан в стиле, то по умолчанию он будет равен 0 . |
bearing | number default: 0 | Начальный пеленг (поворот) карты, измеренный в градусах против часовой стрелки с севера. Если пеленг не указан в параметрах конструктора, MMR GL JS будет искать его в объекте стиля карты. Если он также не указан в стиле, то по умолчанию он будет равен 0 . |
pitch | number default: 0 | Начальный шаг (наклон) карты, измеряемый в градусах от плоскости экрана (0-85). Если шаг не указан в параметрах конструктора, MMR GL JS будет искать его в объекте стиля карты. Если он также не указан в стиле, то по умолчанию он будет равен 0. |
bounds | LngLatBoundsLike | Начальные границы карты. Если заданы границы, то он переопределяет center и zoom. |
fitBoundsOptions | object | Map#fitBounds -параметры объекта следует использовать только при подгонке исходных границ приведенных выше (bounds ). |
renderWorldCopies | boolean default: true | Если это true , то несколько копий мира будут отображаться бок о бок за пределами -180 и 180 градусов долготы.Если установлено значение false :
|
maxTileCache | number default: null | Максимальное количество плиток, хранящихся в кэше для данного источника (source ). Если этот параметр опущен, размер кэша будет динамически определяться в зависимости от текущего окна просмотра. |
localIdeographFontFamily | string default: sans-serif | Определяет CSS font-family для локального переопределения генерации глифов в _CJK Unified Ideographs , Hiragana , Katakana и Hangul Syllables_ .В этих языковых структурах настройки шрифта из стиля карты будут игнорироваться, кроме font-weight (light /regular /medium /bold ).Установите значение false , чтобы включить настройки шрифта из стиля карты для этих глифов. |
localFontFamily | string default: false | Определяем CSS font-family для переопределения генерации всех глифов.Настройки шрифта из стиля карты будут игнорироваться, кроме font-weight (light /regular /medium /bold ).Если этот параметр установлен, то он переопределяет настройку в localIdeographFontFamily . |
transformRequest | RequestTransformFunction default: null | Функция выполняется до выполнения URL-запроса. Она может использоваться для изменения URL, установки заголовков или свойства credentials для кросс-доменных запросов. |
collectResourceTiming | boolean default: false | Если true , то информация Resource Timing API будет доступна для запросов выполняемых GeoJSON и Vector Tile (эта информация обычно недоступна из основного потока JavaScript). Информация будет возвращена в свойстве ResourceTiming . |
fadeDuration | number default: 300 | У правление длительности анимации fade-in/fade-out для коллизий подписей в миллисекундах. Этот параметр не влияет на продолжительность переходов стиля во время выполнения или перекрестного затухания растровых плиток. |
crossSourceCollisions | boolean default: true | Если true , то символы из нескольких источников могут сталкиваться друг с другом во время обнаружения столкновения. Если значение false , обнаружение коллизий выполняется отдельно для символов в каждом источнике. |
accessToken | string default: null | Если указан, тогда будет использоваться этот токен вместо того, который указан в mmrgl.accessToken |
locale | object default: null | Патч для применения к таблице локализации по умолчанию для строк пользовательского интерфейса, например подсказок управления. Объект locale сопоставляет идентификаторы строк пользовательского интерфейса в пространстве имен с переведенными строками на целевом языке; см. src/ui/default_locale.js , например, со всеми поддерживаемыми строковыми идентификаторами. Объект может указывать все строки пользовательского интерф ейса (тем самым добавляя поддержку нового перевода) или только подмножество строк (тем самым исправляя таблицу перевода по умолчанию). |
Пример
var map = new mmrgl.Map({
container: 'map',
center: [37.6165, 55.7505],
zoom: 8,
style: styleObject,
hash: true ,
transformRequest: (url, resourceType)=> {
if (resourceType === 'Source' && url.startsWith('http://myHost' )) {
return {
url: url.replace('http', 'https' ),
headers: { 'my-custom-header': true },
credentials: 'include' // Include cookies for cross-origin requests
}
}
}
});
Методы
Название | Описание | ||||||||
---|---|---|---|---|---|---|---|---|---|
addControl(control, position?) | Добавляет IControl на карту, Параметры: • • | ||||||||
addImage(id, image, options) | Добавьте изображение в стиль. Это изображение может быть отображено на карте, как и любой другой значок в спрайте, используя ID изображения с Параметры: •
• • • • •
| ||||||||
addLayer(layer, beforedId?) | Добавляет слой стиля к стилю карты. Слой определяет, как будут стилизованы данные из указанного источника. Параметры: • Ниже представлено Описание объекта • • (Так же может быть кастомным. Дополнительные сведения см. в разделе CustomLayerInterface. • • sourceLayer — (необязательно) имя слоя в указанном • • • • minzoom:number — (необязательно) минимальный уровень масштабирования для слоя. При уровнях масштабирования меньше, чем minzoom, слой будет скрыт. Значение может быть любым числом от • • •
| ||||||||
addSource(id, source) | Добавляет источник в стиль карты. Параметры:
| ||||||||
areTilesLoaded() | Возвращает логическое значение, указывающее, загружены ли все плитки в окне просмотра из всех источников стиля.
| ||||||||
boxZoom | BoxZoomHandler карты, который реализует масштабирование с помощью жеста перетаскивания с нажатой клавишей Shift. Более подробную информацию и примеры использования boxZoom можно найти в разделе BoxZoomHandler | ||||||||
cameraForBounds(bounds, options?) | Параметры:
|