ol/extent

Функции

applyTransform(extent, transformFn, dest, stops){Extent}

extent.js, строка 877

import {applyTransform} from 'ol/extent';

Применяет функцию преобразования к экстенту.

Имя	Тип	Описание
extent	Extent	Экстент.
transformFn	TransformFunction	Функция преобразования. Вызывается с координатами экстента [minX, minY, maxX, maxY].
dest	Extent | undefined	Целевой экстент.
stops	number | undefined	Количество промежуточных точек на каждой стороне, используемых для преобразования. По умолчанию используются только углы.

Возвращает:

Экстент.

boundingExtent(coordinates){Extent}

extent.js, строка 24

import {boundingExtent} from 'ol/extent';

Создаёт экстент, включающий все заданные координаты.

Имя	Тип	Описание
coordinates	Array<Coordinate>	Координаты.

Возвращает:

Ограничивающий экстент.

buffer(extent, value, dest){Extent}

extent.js, строка 55

import {buffer} from 'ol/extent';

Возвращает экстент, увеличенный на заданное значение.

Имя	Тип	Описание
extent	Extent	Экстент.
value	number	Величина, на которую следует увеличить экстент.
dest	Extent | undefined	Экстент.

Возвращает:

Экстент.

containsCoordinate(extent, coordinate){boolean}

extent.js, строка 122

import {containsCoordinate} from 'ol/extent';

Проверяет, находится ли заданная координата внутри экстента или на его границе.

Имя	Тип	Описание
extent	Extent	Экстент.
coordinate	Coordinate	Координата.

Возвращает:

Координата находится внутри экстента.

containsExtent(extent1, extent2){boolean}

extent.js, строка 138

import {containsExtent} from 'ol/extent';

Проверяет, содержит ли один экстент другой.

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

Имя	Тип	Описание
extent1	Extent	Экстент 1.
extent2	Extent	Экстент 2.

Возвращает:

Второй экстент содержится в первом или лежит на его границе.

containsXY(extent, x, y){boolean}

extent.js, строка 156

import {containsXY} from 'ol/extent';

Проверяет, находится ли заданная координата внутри экстента или на его границе.

Имя	Тип	Описание
extent	Extent	Экстент.
x	number	Координата X.
y	number	Координата Y.

Возвращает:

Значения x и y находятся внутри экстента.

createEmpty(){Extent}

extent.js, строка 196

import {createEmpty} from 'ol/extent';

Создаёт пустой экстент.

Возвращает:

Пустой экстент.

equals(extent1, extent2){boolean}

extent.js, строка 286

import {equals} from 'ol/extent';

Определяет, эквивалентны ли два экстента.

Имя	Тип	Описание
extent1	Extent	Экстент 1.
extent2	Extent	Экстент 2.

Возвращает:

Два экстента эквивалентны.

extend(extent1, extent2){Extent}

extent.js, строка 318

import {extend} from 'ol/extent';

Изменяет экстент, чтобы он включал другой экстент.

Имя	Тип	Описание
extent1	Extent	Изменяемый экстент.
extent2	Extent	Экстент, который будет включён в первый.

Возвращает:

Ссылка на первый (расширенный) экстент.

getArea(extent){number}

extent.js, строка 446

import {getArea} from 'ol/extent';

Получает площадь экстента.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Площадь.

getBottomLeft(extent){Coordinate}

extent.js, строка 460

import {getBottomLeft} from 'ol/extent';

Получает координату нижнего левого угла экстента.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Координата нижнего левого угла.

getBottomRight(extent){Coordinate}

extent.js, строка 470

import {getBottomRight} from 'ol/extent';

Получает координату нижнего правого угла экстента.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Координата нижнего правого угла.

getCenter(extent){Coordinate}

extent.js, строка 480

import {getCenter} from 'ol/extent';

Получает координаты центра экстента.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Центр.

getDifference(extent1, extent2){Array<Extent>}

extent.js, строка 663

import {getDifference} from 'ol/extent';

Получает разность двух экстентов, то есть области или области extent1, не покрытые extent2. Возвращает массив от 0 до 4 экстентов.

Если экстенты не пересекаются, возвращённый массив содержит extent1 в качестве единственного элемента. Если extent2 полностью содержит extent1, возвращённый массив пуст. В противном случае возвращается до четырёх неперекрывающихся экстентов, которые вместе точно покрывают части extent1 за пределами extent2.

Используется следующее разбиение:

┌────┬─────────┬────┐  ← y2
│    │   top   │    │
│    ├─────────┤    │  ← iy2
│left│ (gone)  │right│
│    ├─────────┤    │  ← iy1
│    │ bottom  │    │
└────┴─────────┴────┘  ← y1
x1  ix1       ix2   x2

Левая и правая полосы охватывают всю высоту extent1, а верхняя и нижняя полосы ограничены по горизонтали областью пересечения, поэтому четыре прямоугольника точно состыковываются без перекрытий и промежутков.

Имя	Тип	Описание
extent1	Extent	Экстент, из которого вычитается другой.
extent2	Extent	Вычитаемый экстент.

Возвращает:

Оставшиеся экстенты (от 0 до 4 элементов).

getHeight(extent){number}

extent.js, строка 581

import {getHeight} from 'ol/extent';

Получает высоту экстента.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Высота.

getIntersection(extent1, extent2, dest){Extent}

extent.js, строка 603

import {getIntersection} from 'ol/extent';

Получает пересечение двух экстентов.

Имя	Тип	Описание
extent1	Extent	Экстент 1.
extent2	Extent	Экстент 2.
dest	Extent | undefined	Необязательный экстент, в который будет записано пересечение.

Возвращает:

Пересекающийся экстент.

getSize(extent){Size}

extent.js, строка 713

import {getSize} from 'ol/extent';

Получает размер (ширину и высоту) экстента.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Размер экстента.

getTopLeft(extent){Coordinate}

extent.js, строка 723

import {getTopLeft} from 'ol/extent';

Получает координату верхнего левого угла экстента.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Координата верхнего левого угла.

getTopRight(extent){Coordinate}

extent.js, строка 733

import {getTopRight} from 'ol/extent';

Получает координату верхнего правого угла экстента.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Координата верхнего правого угла.

getWidth(extent){number}

extent.js, строка 743

import {getWidth} from 'ol/extent';

Получает ширину экстента.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Ширина.

intersects(extent1, extent2){boolean}

extent.js, строка 754

import {intersects} from 'ol/extent';

Определяет, пересекаются ли два экстента.

Имя	Тип	Описание
extent1	Extent	Экстент 1.
extent2	Extent	Экстент.

Возвращает:

Два экстента пересекаются.

isEmpty(extent){boolean}

extent.js, строка 769

import {isEmpty} from 'ol/extent';

Определяет, является ли экстент пустым.

Имя	Тип	Описание
extent	Extent	Экстент.

Возвращает:

Является ли экстент пустым.

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

Corner{'bottom-left'} {'bottom-right'} {'top-left'} {'top-right'}

Угол экстента.

Extent{Array.<number>}

Массив чисел, представляющий экстент: [minx, miny, maxx, maxy].