ol/View

Классы

View

Функции

getView(source, transforms){Promise<ViewOptions>}

View.js, строка 2248

import {getView} from 'ol/View';

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

Имя	Тип	Описание
source	Source	Источник.
transforms	ViewTransform	Применяемые преобразования.

Возвращает:

Параметры представления.

withExtentCenter(){ViewTransform}

View.js, строка 2217

import {withExtentCenter} from 'ol/View';

Задаёт центр на основе области охвата.

Возвращает:

Преобразование представления.

withLowerResolutions(num){ViewTransform}

View.js, строка 2195

import {withLowerResolutions} from 'ol/View';

Добавляет более низкие разрешения.

Имя	Тип	Описание
num	number	Количество используемых уровней с более низким разрешением.

Возвращает:

Преобразование представления.

withZoom(z){ViewTransform}

View.js, строка 2235

import {withZoom} from 'ol/View';

Задаёт уровень масштабирования.

Имя	Тип	Описание
z	number	Уровень масштабирования.

Возвращает:

Преобразование представления.

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

Animation{Object}

Конфигурация анимации

Свойства:

Имя	Тип	Описание
sourceCenter	Coordinate | undefined	Исходный центр.
targetCenter	Coordinate | undefined	Целевой центр.
sourceResolution	number | undefined	Исходное разрешение.
targetResolution	number | undefined	Целевое разрешение.
sourceRotation	number | undefined	Исходный поворот.
targetRotation	number | undefined	Целевой поворот.
anchor	Coordinate | undefined	Опорная точка.
start	number	Начало.
duration	number	Длительность.
complete	boolean	Завершена.
easing	function	Функция плавности.
callback	function	Функция обратного вызова.

AnimationOptions{Object}

Свойства:

Имя	Тип	Описание
center	Coordinate | undefined	Центр представления по завершении анимации.
zoom	number | undefined	Уровень масштабирования представления по завершении анимации. Имеет приоритет над resolution.
resolution	number | undefined	Разрешение представления по завершении анимации. Если также задано zoom, этот параметр игнорируется.
rotation	number | undefined	Поворот представления по завершении анимации.
anchor	Coordinate | undefined	Необязательная опорная точка, которая остаётся неподвижной во время анимации поворота или разрешения.
duration	number (по умолчанию 1000)	Длительность анимации в миллисекундах.
easing	function | undefined	Функция плавности, используемая во время анимации (по умолчанию inAndOut). Функция вызывается для каждого кадра и получает число, представляющее долю длительности анимации. Функция должна возвращать число от 0 до 1, представляющее прогресс перехода к целевому состоянию.

Constraints{Object}

Свойства:

Имя	Тип	Описание
center	Type	Центр.
resolution	Type	Разрешение.
rotation	Type	Поворот.

FitOptions{Object}

Свойства:

Имя	Тип	Описание
size	Size | undefined	Размер в пикселях области, в которую нужно вписать область охвата. По умолчанию используется размер карты, с которой связано представление. Если с представлением не связана ни одна карта или связано несколько карт, укажите желаемый размер области (например, map.getSize()).
padding	Array.<number> (по умолчанию [0, 0, 0, 0])	Отступы (в пикселях), которые нужно оставить внутри представления. Значения массива задают отступы сверху, справа, снизу и слева.
nearest	boolean (по умолчанию false)	Если параметр constrainResolution представления равен true, возвращает ближайшую область охвата вместо наиболее близкой области, которая фактически помещается в представление.
minResolution	number (по умолчанию 0)	Минимальное разрешение, до которого выполняется масштабирование.
maxZoom	number | undefined	Максимальный уровень масштабирования. Если задано minResolution, это свойство игнорируется.
duration	number | undefined	Длительность анимации в миллисекундах. По умолчанию переход к целевой области охвата выполняется без анимации.
easing	function | undefined	Функция плавности, используемая во время анимации (по умолчанию inAndOut). Функция вызывается для каждого кадра и получает число, представляющее долю длительности анимации. Функция должна возвращать число от 0 до 1, представляющее прогресс перехода к целевому состоянию.
callback	function | undefined	Функция, вызываемая, когда представление достигает конечного положения. Функция обратного вызова получит значение true, если серия анимаций завершилась самостоятельно, или false, если она была отменена.

State{Object}

Свойства:

Имя	Тип	Описание
center	Coordinate	Центр (в координатах проекции представления).
projection	Projection	Проекция.
resolution	number	Разрешение.
nextCenter	Coordinate | undefined	Следующий центр во время серии анимаций.
nextResolution	number | undefined	Следующее разрешение во время серии анимаций.
nextRotation	number | undefined	Следующий поворот во время серии анимаций.
rotation	number	Поворот.
zoom	number	Масштаб.

ViewObjectEventTypes{Types} {'change:center'} {'change:resolution'} {'change:rotation'}

ViewOptions{Object}

Свойства:

Имя	Тип	Описание
center	Coordinate | undefined	Начальный центр представления. Если пользовательская проекция не задана, система координат центра указывается параметром projection. Источники слоёв не будут загружены, если этот параметр не задан, однако центр можно задать позднее с помощью #setCenter.
constrainRotation	boolean | number (по умолчанию true)	Ограничение поворота. false означает отсутствие ограничений. true означает отсутствие ограничений, но при значениях, близких к нулю, поворот округляется до нуля. Число ограничивает поворот указанным количеством значений. Например, 4 ограничит поворот значениями 0, 90, 180 и 270 градусов.
enableRotation	boolean (по умолчанию true)	Включить поворот. Если значение равно false, используется ограничение поворота, всегда устанавливающее поворот на ноль. Параметр constrainRotation не действует, если enableRotation равно false.
extent	Extent | undefined	Область охвата, ограничивающая представление; другими словами, за пределами этой области на карте ничего не будет видно.
constrainOnlyCenter	boolean (по умолчанию false)	Если значение равно true, ограничение области охвата применяется только к центру представления, а не ко всей области охвата.
smoothExtentConstraint	boolean (по умолчанию true)	Если значение равно true, ограничение области охвата применяется плавно, то есть представлению разрешается немного выходить за пределы заданной extent.
maxResolution	number | undefined	Максимальное разрешение, используемое для определения ограничения разрешения. Оно используется вместе с minResolution (или maxZoom) и zoomFactor. Если значение не указано, оно вычисляется таким образом, чтобы область допустимости проекции помещалась в тайл размером 256x256 пикселей. Если используется проекция «сферический Меркатор» (по умолчанию), maxResolution по умолчанию равно 40075016.68557849 / 256 = 156543.03392804097.
minResolution	number | undefined	Минимальное разрешение, используемое для определения ограничения разрешения. Оно используется вместе с maxResolution (или minZoom) и zoomFactor. Если значение не указано, оно вычисляется исходя из 29 уровней масштабирования (с коэффициентом 2). Если используется проекция «сферический Меркатор» (по умолчанию), minResolution по умолчанию равно 40075016.68557849 / 256 / Math.pow(2, 28) = 0.0005831682455839253.
maxZoom	number (по умолчанию 28)	Максимальный уровень масштабирования, используемый для определения ограничения разрешения. Он используется вместе с minZoom (или maxResolution) и zoomFactor. Обратите внимание: если также задано minResolution, оно имеет приоритет над maxZoom.
minZoom	number (по умолчанию 0)	Минимальный уровень масштабирования, используемый для определения ограничения разрешения. Он используется вместе с maxZoom (или minResolution) и zoomFactor. Обратите внимание: если также задано maxResolution, оно имеет приоритет над minZoom.
multiWorld	boolean (по умолчанию false)	Если значение равно false, представление ограничивается так, чтобы была видна только одна копия мира и нельзя было переместить карту за его край. Если значение равно true, при низком масштабе на карте может отображаться несколько копий мира. Используется только в том случае, если projection является глобальной. Обратите внимание: если также задано extent, оно имеет приоритет.
constrainResolution	boolean (по умолчанию false)	Если значение равно true, после взаимодействия выполняется анимация перехода к ближайшему уровню масштабирования; при значении false допускаются промежуточные уровни масштабирования.
smoothResolutionConstraint	boolean (по умолчанию true)	Если значение равно true, минимальное и максимальное значения разрешения применяются плавно, то есть представлению разрешается немного выходить за заданные границы разрешения или масштаба.
showFullExtent	boolean (по умолчанию false)	Разрешить уменьшение масштаба представления, чтобы показать всю настроенную область охвата. По умолчанию, если для представления задана область охвата, пользователи не могут уменьшить масштаб так, чтобы область просмотра превысила её по высоте или ширине. Поэтому вся область охвата может быть не видна, если соотношение сторон области просмотра отличается от соотношения сторон настроенной области охвата. Если showFullExtent имеет значение true, пользователь сможет уменьшить масштаб так, чтобы область просмотра превысила высоту или ширину настроенной области охвата, но не обе величины сразу, что позволит показать её целиком.
projection	ProjectionLike (по умолчанию 'EPSG:3857')	Проекция. По умолчанию используется проекция «сферический Меркатор».
resolution	number | undefined	Начальное разрешение представления. Единицы измерения — единицы projection на пиксель (например, метры на пиксель). Вместо этого параметра можно задать zoom. Если не заданы ни этот параметр, ни zoom, источники слоёв не будут загружены, однако их можно задать позднее с помощью #setZoom или #setResolution.
resolutions	Array.<number> | undefined	Разрешения, определяющие уровни масштабирования, если они заданы. Индекс в массиве соответствует уровню масштабирования, поэтому значения разрешения должны располагаться в порядке убывания. Массив также ограничивает разрешение минимальным и максимальным значениями. Если параметр задан, параметры maxResolution, minResolution, minZoom, maxZoom и zoomFactor игнорируются.
rotation	number (по умолчанию 0)	Начальный поворот представления в радианах (положительное значение означает поворот по часовой стрелке, 0 — направление на север).
zoom	number | undefined	Используется только в том случае, если resolution не задан. Уровень масштабирования, используемый для вычисления начального разрешения представления.
zoomFactor	number (по умолчанию 2)	Коэффициент масштабирования, используемый для вычисления соответствующего разрешения.
padding	Array.<number> (по умолчанию [0, 0, 0, 0])	Отступы (в CSS-пикселях). Если другие элементы содержимого (накладки) частично перекрывают края области просмотра карты, этот параметр позволяет сместить её центр в сторону от этих элементов. Порядок значений: сверху, справа, снизу, слева.

ViewStateLayerStateExtent{Object}

Как FrameState, но только viewState и extent.

Свойства:

Имя	Тип	Описание
viewState	State	Состояние представления.
extent	Extent	Область охвата (в координатах пользовательской проекции).
layerStatesArray	Array<State> | undefined	Состояния слоёв.

ViewTransform()

View.js, строка 2163