KBE3D / KBCore / turf / findSegment

函数: findSegment()

findSegment<G, P>(geojson: G | Feature<G, P> | FeatureCollection<G, P>, options?: { featureIndex?: number; multiFeatureIndex?: number; geometryIndex?: number; segmentIndex?: number; properties?: P; bbox?: BBox; id?: Id; }): Feature<LineString, P>

Finds a particular 2-vertex LineString Segment from a GeoJSON using @turf/meta indexes.

Negative indexes are permitted. Point & MultiPoint will always return null.

类型参数

G

G extends LineString | MultiLineString | Polygon | MultiPolygon

P

P extends GeoJsonProperties = GeoJsonProperties

参数

geojson

Any GeoJSON Feature or Geometry

G | Feature<G, P> | FeatureCollection<G, P>

options?

Optional parameters

featureIndex?

number

Feature Index

multiFeatureIndex?

number

Multi-Feature Index

geometryIndex?

number

Geometry Index

segmentIndex?

number

Segment Index

properties?

P

Translate Properties to output LineString

bbox?

BBox

Translate BBox to output LineString

id?

Id

Translate Id to output LineString

返回

Feature<LineString, P>

2-vertex GeoJSON Feature LineString

示例

var multiLine = turf.multiLineString([
    [[10, 10], [50, 30], [30, 40]],
    [[-10, -10], [-50, -30], [-30, -40]]
]);

// First Segment (defaults are 0)
turf.findSegment(multiLine);
// => Feature<LineString<[[10, 10], [50, 30]]>>

// First Segment of 2nd Multi Feature
turf.findSegment(multiLine, {multiFeatureIndex: 1});
// => Feature<LineString<[[-10, -10], [-50, -30]]>>

// Last Segment of Last Multi Feature
turf.findSegment(multiLine, {multiFeatureIndex: -1, segmentIndex: -1});
// => Feature<LineString<[[-50, -30], [-30, -40]]>>