模块:ol/proj

ol/proj


import * as olProj from 'ol/proj';

函数

addCoordinateTransforms(source, destination, forward, inverse)

import {addCoordinateTransforms} from 'ol/proj';

注册坐标转换函数,用于在源投影与目标投影之间进行坐标转换。正向和反向函数处理坐标对的转换;此函数将它们转换为内部函数,这些内部函数同时处理范围和坐标数组。

Name Type 描述
source ProjectionLike

数据源 投影.

destination ProjectionLike

目标投影。

forward function

正向变换函数(即从源投影到目标投影)接受一个Coordinate作为参数并返回转换后的数据Coordinate.

inverse function

逆变换函数(即从目标投影到源投影)接受一个Coordinate作为参数,并返回转换后的Coordinate如果变换函数只能变换少于输入坐标的维度,则应返回一个仅包含可变换维度的坐标;其余维度将保持不变,直接取自源坐标。

addEquivalentProjections(projections)

import {addEquivalentProjections} from 'ol/proj';

注册不改变坐标的转换函数。这些函数允许在坐标意义相同的投影之间进行转换。

Name Type 描述
projections Array<Projection>

投影。

addProjection(projection)

import {addProjection} from 'ol/proj';

将投影对象添加到支持的投影列表中,这些投影能够通过代码查找。

Name Type 描述
projection Projection

投影实例。

clearUserProjection()

import {clearUserProjection} from 'ol/proj';

清除用户投影(如果已设置)。

equivalent(projection1, projection2){boolean}

import {equivalent} from 'ol/proj';

检查两个投影是否相同,即一个投影中的每个坐标是否对应另一个投影中相同坐标所表示的同一地理点。

Name Type 描述
projection1 Projection

投影 1.

projection2 Projection

投影 2.

返回:
等效的。

fromLonLat(coordinate, projection){Coordinate}

import {fromLonLat} from 'ol/proj';

将坐标从经纬度转换到另一种投影。

Name Type 描述
coordinate Coordinate

坐标以经度和纬度表示,即一个数组,其中经度为第一个元素,纬度为第二个元素。

projection ProjectionLike | undefined

目标投影。默认为Web墨卡托,即EPSG:3857。

返回:
坐标已投影至目标投影坐标系。

get(projectionLike){Projection | null}

import {get} from 'ol/proj';

获取指定代码的投影对象。

Name Type 描述
projectionLike ProjectionLike

要么是由授权机构和标识符组合的代码字符串(例如“欧洲石油调查组织:4326”),要么是现有的投影对象,要么是未定义。

返回:
投影对象,若不在列表中则为 null。

getPointResolution(projection, resolution, point, units){number}

import {getPointResolution} from 'ol/proj';

获取点的分辨率(以度或距离为单位)。对于以度为单位的投影,将直接返回提供的分辨率。对于其他投影,默认通过将 point 像素转换到 EPSG:4326,测量其在球体上的宽度和高度,并取平均值来估计点分辨率。可以通过在 Projection 构造函数中设置 getPointResolution 选项,或使用 setGetPointResolution 修改现有投影对象,来为特定投影提供自定义函数。

Name Type 描述
projection ProjectionLike

投影。

resolution number

标称分辨率(投影单位)

point Coordinate

指向以查找调整后的分辨率。

units Units | undefined

用于指定点分辨率的单位。默认为投影的单位。

返回:
点 分辨率.

getTransform(source, destination){TransformFunction}

import {getTransform} from 'ol/proj';

给定投影类对象,搜索变换函数以将坐标数组从源投影转换到目标投影。

Name Type 描述
source ProjectionLike

数据源.

destination ProjectionLike

目标点。

返回:
变换函数。

getUserProjection(){Projection | null}

import {getUserProjection} from 'ol/proj';

获取 API 方法传入与返回坐标的投影。

返回:
用户投影(若未设置,则为 null)。

setUserProjection(projection)

import {setUserProjection} from 'ol/proj';

为 API 方法提供和返回的坐标设置投影。这包括所有不与瓦片网格交互的 API 方法,以及 FrameStateState

Name Type 描述
projection ProjectionLike

用户投影。

toLonLat(coordinate, projection){Coordinate}

import {toLonLat} from 'ol/proj';

将坐标转换为经纬度。

Name Type 描述
coordinate Coordinate

投影坐标。

projection ProjectionLike | undefined

坐标投影。 默认采用Web墨卡托投影,即'EPSG:3857'。

返回:
坐标表示为经度和纬度的数组,其中经度为第一个元素,纬度为第二个元素。

transform(coordinate, source, destination){Coordinate}

import {transform} from 'ol/proj';

将坐标从源投影转换到目标投影。此函数返回一个新坐标(不修改原始坐标)。如果两个投影之间无可用的转换,将抛出错误。

范围变换请参考 transformExtent。几何变换请参考 Geometry 及其子类的变换方法。

Name Type 描述
coordinate Coordinate

坐标。

source ProjectionLike

类似源投影的。

destination ProjectionLike

类似目标投影的。

返回:
坐标。

transformExtent(extent, source, destination, stops){Extent}

import {transformExtent} from 'ol/proj';

将范围从源投影转换至目标投影。此操作将返回一个新范围,且不会修改原始范围。

Name Type 描述
extent Extent

变换范围

source ProjectionLike

类似源投影。

destination ProjectionLike

类似目标投影的。

stops number | undefined

用于变换的每侧控制点数量。默认情况下仅使用角点。

返回:
变换后的范围

useGeographic()

import {useGeographic} from 'ol/proj';

在 API 方法中使用地理坐标(WGS-84 基准)。这包括所有不与瓦片网格交互的 API 方法,以及 FrameStateState

类型定义

ProjectionLike{Projection} {string} {undefined}

投影可以是 Projection、SRS标识符字符串或未定义。

TransformFunction(input, output, dimension, stride){Array.<number>}

转换函数接受一个输入坐标值数组、一个可选的输出数组和一个可选的维度(默认值应为2)。该函数转换输入坐标值,填充输出数组,并返回输出数组。

Name Type 描述
input Array.<number>
output Array.<number> | undefined
dimension number | undefined
stride number | undefined

Transforms{Object}

属性:
Name Type 描述
forward TransformFunction

正向变换(从地理坐标系)

inverse TransformFunction

逆变换(至地理坐标系)。