ol/Map

Классы

Map

Определения типов

AtPixelOptions{Object}

Свойства:

Имя	Тип	Описание
layerFilter	undefined | function	Функция фильтрации слоёв. Функция фильтрации получает один аргумент — layer-candidate — и должна возвращать логическое значение. Проверка объектов выполняется только для видимых слоёв, для которых эта функция возвращает true. По умолчанию проверяются все видимые слои.
hitTolerance	number (по умолчанию 0)	Допуск обнаружения объектов в пикселях CSS. Для обнаружения объектов проверяются пиксели в радиусе вокруг заданной позиции.
checkWrapped	boolean (по умолчанию true)	Проверка объектов с учётом обёртки. Будут проверяться объекты с обёрткой в диапазоне +/- 1 ширины мира. Работает только в том случае, если используется проекция, поддерживающая обёртку.

FrameState{Object}

Состояние текущего кадра. В приложениях следует использовать только pixelRatio, time и viewState.

Свойства:

Имя	Тип	Описание
pixelRatio	number	Коэффициент масштабирования пикселей кадра.
time	number	Время запроса на отрисовку кадра.
viewState	State	Состояние текущего представления.
animate	boolean	Анимация.
coordinateToPixelTransform	Transform	Преобразование координат в пиксели.
declutter	Object<string, module:rbush<DeclutterEntry>> | null	Деревья устранения наложений, сгруппированные по группе устранения наложений. Если значение равно null, устранение наложений не требуется, поскольку оно не включено ни для одного слоя.
extent	null | Extent	Область охвата (в координатах проекции представления).
nextExtent	Extent | undefined	Следующая область охвата во время последовательности анимации.
index	number	Индекс.
layerStatesArray	Array<State>	Массив состояний слоёв.
layerIndex	number	Индекс слоя.
pixelToCoordinateTransform	Transform	Преобразование пикселей в координаты.
postRenderFunctions	Array<PostRenderFunction>	Функции, выполняемые после отрисовки.
size	Size	Размер.
tileQueue	TileQueue	Очередь тайлов.
usedTiles	Object.<string, Object.<string, boolean>>	Используемые тайлы.
viewHints	Array.<number>	Подсказки представления.
wantedTiles	Object.<string, Object.<string, boolean>>	Запрошенные тайлы.
mapId	string	Идентификатор карты.
renderTargets	Object.<string, boolean>	Идентификаторы ранее отрисованных элементов.

MapObjectEventTypes{Types} {'change:layergroup'} {'change:size'} {'change:target'} {'change:view'}

MapOptions{Object}

Объект с параметрами конфигурации карты.

Свойства:

Имя	Тип	Описание
controls	Collection<Control> | Array<Control> | undefined	Элементы управления, добавляемые к карте при создании. Если параметр не задан, используется defaults. В рабочем потоке элементы управления по умолчанию не добавляются.
pixelRatio	number (по умолчанию window.devicePixelRatio)	Соотношение физических пикселей и независимых от устройства пикселей (DIP) на устройстве.
interactions	Collection<Interaction> | Array<Interaction> | undefined	Взаимодействия, добавляемые к карте при создании. Если параметр не задан, используется defaults. В рабочем потоке взаимодействия по умолчанию не добавляются.
keyboardEventTarget	HTMLElement | Document | string | undefined	Элемент, на котором отслеживаются события клавиатуры. Он определяет, когда срабатывают взаимодействия KeyboardPan и KeyboardZoom. Например, если для этого параметра задано значение document, взаимодействия с клавиатурой будут срабатывать всегда. Если параметр не задан, библиотека отслеживает события клавиатуры на целевом элементе карты (то есть на предоставленном пользователем div карты). Если это значение не равно document, целевой элемент необходимо сфокусировать, чтобы генерировались события клавиатуры; для этого целевой элемент должен иметь атрибут tabindex.
layers	Array<BaseLayer> | Collection<BaseLayer> | LayerGroup | undefined	Слои. Если параметр не задан, будет отображена карта без слоёв. Обратите внимание, что слои отрисовываются в указанном порядке. Например, чтобы векторный слой отображался поверх слоя тайлов, его нужно указать после слоя тайлов.
maxTilesLoading	number (по умолчанию 16)	Максимальное количество тайлов, загружаемых одновременно.
moveTolerance	number (по умолчанию 1)	Минимальное расстояние в пикселях, на которое должен переместиться курсор, чтобы событие считалось перемещением карты, а не щелчком. Увеличение этого значения может упростить щелчки по карте.
overlays	Collection<Overlay> | Array<Overlay> | undefined	Наложения, добавляемые к карте при создании. По умолчанию наложения не добавляются.
target	HTMLElement | string | HTMLCanvasElement | OffscreenCanvas | undefined	Контейнер карты: сам элемент или id элемента. Если параметр не задан при создании, для отображения карты необходимо вызвать setTarget. Если передан элемент, контейнер может находиться во вторичном документе. Для использования в рабочих потоках или при экспорте карты в качестве целевого элемента укажите OffscreenCanvas или HTMLCanvasElement с шириной и высотой в физических пикселях, при необходимости умноженными на коэффициент масштабирования, и с преобразованием масштаба, соответствующим коэффициенту масштабирования пикселей карты. Для обеспечения доступности (фокус и события клавиатуры при навигации по карте) для элемента target необходимо правильно настроить атрибут tabindex. Если элемент target находится внутри Shadow DOM, атрибут tabindex необходимо задать для хост-элемента пользовательского элемента. Примечание: поддержка CSS transform для целевого элемента ограничена значением scale.
view	View | Promise<ViewOptions> | undefined	Представление карты. Источники слоёв не будут загружаться, если этот параметр не задан при создании или с помощью setView.

MapOptionsInternal{Object}

Свойства:

Имя	Тип	Описание
controls	Collection<Control> | undefined	Элементы управления.
interactions	Collection<Interaction> | undefined	Взаимодействия.
keyboardEventTarget	HTMLElement | Document	Целевой элемент событий клавиатуры.
overlays	Collection<Overlay>	Наложения.
values	Object.<string, *>	Значения.

PostRenderFunction()

Map.js, строка 79