Spec-Zone.ru › OpenLayers

ol/extent


import * as olExtent from 'ol/extent';

Функции

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

extent.js, line 810
import {applyTransform} from 'ol/extent';

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

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

Экстент.

transformFn TransformFunction

Функция преобразования. Вызывается с координатами экстента [minX, minY, maxX, maxY].

dest Extent | undefined

Экстент назначения.

stops number | undefined

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

Возвращает:
Extent.

boundingExtent(coordinates){Extent}

extent.js, line 24
import {boundingExtent} from 'ol/extent';

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

Имя Тип Описание
coordinates Array<Coordinate>

Координаты.

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

buffer(extent, value, dest){Extent}

extent.js, line 55
import {buffer} from 'ol/extent';

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

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

Экстент.

value number

Величина, на которую следует буферизовать экстент.

dest Extent | undefined

Экстент.

Возвращает:
Экстент.

containsCoordinate(extent, coordinate){boolean}

extent.js, line 122
import {containsCoordinate} from 'ol/extent';

Проверить, содержится ли переданная координата внутри или на краю экстента.

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

Экстент.

coordinate Coordinate

Координата.

Возвращает:
Координата содержится в экстенте.

containsExtent(extent1, extent2){boolean}

extent.js, line 138
import {containsExtent} from 'ol/extent';

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

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

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

Экстент 1.

extent2 Extent

Экстент 2.

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

containsXY(extent, x, y){boolean}

extent.js, line 156
import {containsXY} from 'ol/extent';

Проверить, содержится ли переданная координата внутри или на краю экстента.

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

Экстент.

x number

Координата X.

y number

Координата Y.

Возвращает:
Значения x, y содержатся в экстенте.

createEmpty(){Extent}

extent.js, line 196
import {createEmpty} from 'ol/extent';

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

Возвращает:
Пустой экстент.

equals(extent1, extent2){boolean}

extent.js, line 286
import {equals} from 'ol/extent';

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

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

Экстент 1.

extent2 Extent

Экстент 2.

Возвращает:
Два экстента эквивалентны.

extend(extent1, extent2){Extent}

extent.js, line 318
import {extend} from 'ol/extent';

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

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

Экстент, который нужно изменить.

extent2 Extent

Экстент, который будет включен в первый.

Возвращает:
Ссылку на первый (расширенный) экстент.

getArea(extent){number}

extent.js, line 446
import {getArea} from 'ol/extent';

Получить размер области.

Name Type Description
extent Extent

Область.

Returns:
Площадь.

getBottomLeft(extent){Coordinate}

extent.js, line 460
import {getBottomLeft} from 'ol/extent';

Получить левую нижнюю координату области.

Name Type Description
extent Extent

Область.

Returns:
Левая нижняя координата.

getBottomRight(extent){Coordinate}

extent.js, line 470
import {getBottomRight} from 'ol/extent';

Получить правую нижнюю координату области.

Name Type Description
extent Extent

Область.

Returns:
Правая нижняя координата.

getCenter(extent){Coordinate}

extent.js, line 480
import {getCenter} from 'ol/extent';

Получить центральную координату области.

Name Type Description
extent Extent

Область.

Returns:
Центр.

getHeight(extent){number}

extent.js, line 581
import {getHeight} from 'ol/extent';

Получить высоту области.

Name Type Description
extent Extent

Область.

Returns:
Высота.

getIntersection(extent1, extent2, dest){Extent}

extent.js, line 603
import {getIntersection} from 'ol/extent';

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

Name Type Description
extent1 Extent

Область 1.

extent2 Extent

Область 2.

dest Extent | undefined

Необязательная область для заполнения пересечением.

Returns:
Пересекающаяся область.

getSize(extent){Size}

extent.js, line 646
import {getSize} from 'ol/extent';

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

Name Type Description
extent Extent

Область.

Returns:
Размер области.

getTopLeft(extent){Coordinate}

extent.js, line 656
import {getTopLeft} from 'ol/extent';

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

Name Type Description
extent Extent

Область.

Returns:
Левая верхняя координата.

getTopRight(extent){Coordinate}

extent.js, line 666
import {getTopRight} from 'ol/extent';

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

Name Type Description
extent Extent

Область.

Returns:
Правая верхняя координата.

getWidth(extent){number}

extent.js, line 676
import {getWidth} from 'ol/extent';

Получить ширину области.

Name Type Description
extent Extent

Область.

Returns:
Ширина.

intersects(extent1, extent2){boolean}

extent.js, line 687
import {intersects} from 'ol/extent';

Определить, пересекается ли одна область с другой.

Name Type Description
extent1 Extent

Область 1.

extent2 Extent

Область.

Returns:
Две области пересекаются.

isEmpty(extent){boolean}

extent.js, line 702
import {isEmpty} from 'ol/extent';

Определить, является ли область пустой.

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

Область.

Возвращает:
Является ли пустой.

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

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

Угол области.

Extent{Array.<number>}

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

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_extent.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API