Geolib 项目技术文档

1. 安装指南

使用 npm 安装

npm install geolib

使用 yarn 安装

yarn add geolib

2. 项目的使用说明

概述

Geolib 是一个用于基本地理空间操作的库，例如距离计算、十进制坐标与六十进制坐标的转换等。该库目前是 2D 的，意味着它不支持海拔/高度的计算。

使用方式

Geolib 提供了 UMD 和 ES Module 两种构建方式。你可以根据项目需求选择合适的方式进行使用。

在 Node.js 中使用

const geolib = require('geolib');

在浏览器中使用

<script src="lib/geolib.js"></script>

在浏览器中加载后，可以通过 window.geolib 访问所有函数。

使用 ES Module

如果你使用的是支持 ES Module 的环境（如 Webpack 或 Parcel），可以直接导入需要的函数：

import { getDistance } from 'geolib';

或者导入整个库：

import * as geolib from 'geolib';

为了更好地利用 treeshaking，推荐直接导入单个函数：

import getDistance from 'geolib/es/getDistance';

3. 项目API使用文档

常用函数

getDistance(start, end, accuracy = 1)

计算两个地理坐标之间的距离。

• start 和 end：必须是有效的 GeolibInputCoordinates，例如 {latitude: 52.518611, longitude: 13.408056}。
• accuracy：精度（单位：米），默认值为 1 米。

getDistance(
    { latitude: 51.5103, longitude: 7.49347 },
    { latitude: "51° 31' N", longitude: "7° 28' E" }
);

返回值为以米为单位的距离。

getPreciseDistance(start, end, accuracy = 1)

计算两个地理坐标之间的精确距离，使用 Vincenty 反算公式，适用于长距离计算。

geolib.getPreciseDistance(
    { latitude: 51.5103, longitude: 7.49347 },
    { latitude: "51° 31' N", longitude: "7° 28' E" }
);

getCenter(coords)

计算一组地理坐标的中心点。

geolib.getCenter([
    { latitude: 52.516272, longitude: 13.377722 },
    { latitude: 51.515, longitude: 7.453619 },
    { latitude: 51.503333, longitude: -0.119722 },
]);

返回值为包含 latitude 和 longitude 的对象。

getCenterOfBounds(coords)

计算一组地理坐标的边界中心点。

geolib.getCenterOfBounds([
    { latitude: 51.513357512, longitude: 7.45574331 },
    { latitude: 51.515400598, longitude: 7.45518541 },
    { latitude: 51.516241842, longitude: 7.456494328 },
    { latitude: 51.516722545, longitude: 7.459863183 },
    { latitude: 51.517443592, longitude: 7.463232037 },
]);

返回值为包含 latitude 和 longitude 的对象。

getBounds(points)

计算一组地理坐标的边界。

geolib.getBounds([
    { latitude: 52.516272, longitude: 13.377722 },
    { latitude: 51.515, longitude: 7.453619 },
    { latitude: 51.503333, longitude: -0.119722 },
]);

返回值为包含 minLat、maxLat、minLng 和 maxLng 的对象。

isPointInPolygon(point, polygon)

检查一个点是否在多边形内。

geolib.isPointInPolygon({ latitude: 51.5125, longitude: 7.485 }, [
    { latitude: 51.5, longitude: 7.4 },
    { latitude: 51.555, longitude: 7.4 },
    { latitude: 51.555, longitude: 7.625 },
    { latitude: 51.5125, longitude: 7.625 },
]);

返回值为 true 或 false。

isPointWithinRadius(point, centerPoint, radius)

检查一个点是否在圆内。

geolib.isPointWithinRadius(
    { latitude: 51.525, longitude: 7.4575 },
    { latitude: 51.5175, longitude: 7.4678 },
    5000
);

返回值为 true 或 false。

4. 项目安装方式

通过 npm 安装

npm install geolib

通过 yarn 安装

yarn add geolib

以上是 Geolib 项目的详细技术文档，涵盖了安装、使用说明、API 文档以及安装方式。希望这份文档能帮助你更好地理解和使用 Geolib 项目。