TileGrid~TileGrid

import TileGrid from 'ol/tilegrid/TileGrid.js';

Базовый класс для настройки шаблона сетки источников, обращающихся к серверам с тайловыми изображениями.

new TileGrid(options) tilegrid/TileGrid.js, строка 68

Имя	Тип	Описание
`extent`	Extent \| undefined	Область охвата тайловой сетки. Источники `TileSource` не будут запрашивать тайлы за пределами этой области. Если не заданы ни `origin`, ни `origins`, то `origin` будет установлен в верхний левый угол области охвата.
`minZoom`	number (по умолчанию 0)	Минимальный уровень масштабирования.
`origin`	Coordinate \| undefined	Начало координат тайловой сетки, то есть точка пересечения осей `x` и `y` (`[z, 0, 0]`). Координаты тайлов увеличиваются слева направо и сверху вниз. Если параметр не задан, необходимо указать `extent` или `origins`.
`origins`	Array<Coordinate> \| undefined	Начала координат тайловой сетки, то есть точки пересечения осей `x` и `y` (`[z, 0, 0]`) для каждого уровня масштабирования. Если параметр задан, длина массива должна совпадать с длиной массива `resolutions`, то есть для каждого разрешения можно задать отдельное начало координат. Координаты тайлов увеличиваются слева направо и сверху вниз. Если параметр не задан, необходимо указать `extent` или `origin`.
`resolutions`	Array.<number>	Разрешения. Индекс каждого разрешения в массиве должен соответствовать уровню масштабирования. Это означает, что даже если задан параметр `minZoom`, длина массива разрешений будет равна `maxZoom + 1`.
`sizes`	Array<Size> \| undefined	Количество строк и столбцов тайлов сетки для каждого уровня масштабирования. Если параметр задан, значения определяют область охвата каждого уровня масштабирования вместе с `origin` или `origins`. Дополнительно можно настроить `extent`, которая ещё сильнее ограничит область, для которой источники выполняют запросы тайлов. Если в качестве `origin` или `origins` используется нижний левый угол области охвата, значение `y` должно быть отрицательным, поскольку в OpenLayers в качестве начала координат тайлов используется верхний левый угол.
`tileRanges`	Array<TileRange> \| undefined	Заранее заданные диапазоны тайлов для каждого уровня масштабирования. Если они указаны, то используются напрямую как полные диапазоны тайлов вместо вычисления на основе `sizes`. Полезно для задания границ индексов тайлов для каждого уровня (например, из `TileMatrixSetLimits` WMTS).
`tileSize`	number \| Size \| undefined	Размер тайла. По умолчанию — `[256, 256]`.
`tileSizes`	Array.<(number\|module:ol/size~Size)> \| undefined	Размеры тайлов. Если параметр задан, длина массива должна совпадать с длиной массива `resolutions`, то есть для каждого разрешения можно задать отдельный размер тайла.

Подклассы

WMTSTileGrid

Методы

forEachTileCoord(extent, zoom, callback) tilegrid/TileGrid.js, строка 245

Вызвать функцию для каждой координаты тайла в заданной области охвата и на заданном уровне масштабирования.

Имя	Тип	Описание
`extent`	Extent	Область охвата.
`zoom`	number	Целочисленный уровень масштабирования.
`callback`	function	Функция, вызываемая для каждой координаты тайла.

getExtent(){Extent} tilegrid/TileGrid.js, строка 301

Получить область охвата этой тайловой сетки, если она была задана.

Возвращает:

Область охвата.

getMaxZoom(){number} tilegrid/TileGrid.js, строка 310

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

Возвращает:

Максимальный уровень масштабирования.

getMinZoom(){number} tilegrid/TileGrid.js, строка 319

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

Возвращает:

Минимальный уровень масштабирования.

getOrigin(z){Coordinate} tilegrid/TileGrid.js, строка 329

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

Имя	Тип	Описание
`z`	number	Целочисленный уровень масштабирования.

Возвращает:

Начало координат.

getResolution(z){number} tilegrid/TileGrid.js, строка 350

Получить разрешение для заданного уровня масштабирования.

Имя	Тип	Описание
`z`	number	Целочисленный уровень масштабирования.

Возвращает:

Разрешение.

getResolutions(){Array.<number>} tilegrid/TileGrid.js, строка 359

Получить список разрешений тайловой сетки.

Возвращает:

Разрешения.

getTileCoordExtent(tileCoord, tempExtent){Extent} tilegrid/TileGrid.js, строка 476

Получить область охвата координаты тайла.

Имя	Тип	Описание
`tileCoord`	TileCoord	Координата тайла.
`tempExtent`	Extent \| undefined	Временный объект области охвата.

Возвращает:

Область охвата.

getTileCoordForCoordAndResolution(coordinate, resolution, opt_tileCoord){TileCoord} tilegrid/TileGrid.js, строка 498

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

Имя	Тип	Описание
`coordinate`	Coordinate	Координата.
`resolution`	number	Разрешение.
`opt_tileCoord`	TileCoord \| undefined	Объект назначения module:ol/tilecoord~TileCoord.

Возвращает:

Координата тайла.

getTileCoordForCoordAndZ(coordinate, z, opt_tileCoord){TileCoord} tilegrid/TileGrid.js, строка 589

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

Имя	Тип	Описание
`coordinate`	Coordinate	Координата.
`z`	number	Целочисленный уровень масштабирования, например результат вызова метода `getZForResolution()`
`opt_tileCoord`	TileCoord \| undefined	Объект назначения module:ol/tilecoord~TileCoord.

Возвращает:

Координата тайла.

getTileSize(z){number | Size} tilegrid/TileGrid.js, строка 615

Получить размер тайла для заданного уровня масштабирования. Тип возвращаемого значения соответствует типу tileSize или tileSizes, с которым была настроена тайловая сетка. Чтобы всегда получать Size, передайте результат в toSize.

Имя	Тип	Описание
`z`	number	Z.

Возвращает:

Размер тайла.

getZForResolution(resolution, opt_direction){number} tilegrid/TileGrid.js, строка 652

Имя Тип Описание

Имя	Тип	Описание
`resolution`	number	Разрешение.
`opt_direction`	number \| NearestDirectionFunction \| undefined	Если значение равно 0, будет использовано ближайшее разрешение. Если значение равно 1, будет использовано ближайшее большее разрешение (меньшее значение Z). Если значение равно -1, будет использовано ближайшее меньшее разрешение (большее значение Z). По умолчанию — 0. Для более точной настройки используйте `NearestDirectionFunction`. Например, чтобы менять Z тайла на средней точке между уровнями масштабирования function(value, high, low) { return value - low * Math.sqrt(high / low); }

resolution

number

Разрешение.

opt_direction

number | NearestDirectionFunction | undefined

Если значение равно 0, будет использовано ближайшее разрешение. Если значение равно 1, будет использовано ближайшее большее разрешение (меньшее значение Z). Если значение равно -1, будет использовано ближайшее меньшее разрешение (большее значение Z). По умолчанию — 0. Для более точной настройки используйте NearestDirectionFunction.

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

function(value, high, low) {
  return value - low * Math.sqrt(high / low);
}