booleanWithin

描述

¥Description

Boolean-within returns true if the first geometry is completely within the second geometry.The interiors of both geometries must intersect and, the interior and boundary of the primary (geometry a) must not intersect the exterior of the secondary (geometry b).Boolean-within returns the exact opposite result of the @turf/boolean-contains.

参数

¥Parameters

名称	类型	描述
feature1	几何图形 | 特性<任意>	GeoJSON 要素或几何体
feature2	几何图形 | 特性<任意>	GeoJSON 要素或几何体

返回

¥Returns

boolean 真/假

¥boolean true/false

示例

¥Examples

var line = turf.lineString([
  [1, 1],
  [1, 2],
  [1, 3],
  [1, 4],
]);
var point = turf.point([1, 2]);

turf.booleanWithin(point, line);
//=true

安装

¥Installation

$ npm install @turf/boolean-within

import { booleanWithin } from "@turf/boolean-within";
const result = booleanWithin(...);

$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.booleanWithin(...);