https://turfjs.org/assets/js/0809bd77.96007ebd.js

1"use strict";(globalThis.webpackChunkturf_www||=[]).push([[11142],{33331(e,n,t){t.r(n),t.d(n,{Map0:()=>m,assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>g,metadata:()=>r,toc:()=>x});const r=JSON.parse('{"id":"api/lineOverlap","title":"lineOverlap","description":"Description","source":"@site/versioned_docs/version-7.3.0/api/lineOverlap.mdx","sourceDirName":"api","slug":"/api/lineOverlap","permalink":"/docs/7.3.0/api/lineOverlap","draft":false,"unlisted":false,"editUrl":"https://github.com/Turfjs/turf-www/tree/master/versioned_docs/version-7.3.0/api/lineOverlap.mdx","tags":[],"version":"7.3.0","frontMatter":{"title":"lineOverlap"},"sidebar":"apiSidebar","previous":{"title":"lineIntersect","permalink":"/docs/7.3.0/api/lineIntersect"},"next":{"title":"lineSegment","permalink":"/docs/7.3.0/api/lineSegment"}}');var i=t(86070),l=t(67028),o=t(15388),s=t(88371),a=t(64776),c={};t.r(c),t.d(c,{along:()=>a.Qwm,angle:()=>a.g7h,applyFilter:()=>a.$hf,area:()=>a.Wcw,areaFactors:()=>a.i26,azimuthToBearing:()=>a.Oe8,bbox:()=>a.Qk1,bboxClip:()=>a.ywB,bboxPolygon:()=>a.kJI,bearing:()=>a.dcc,bearingToAzimuth:()=>a.u8E,bezierSpline:()=>a.vKl,booleanClockwise:()=>a.D2R,booleanConcave:()=>a.U7O,booleanContains:()=>a.yxm,booleanCrosses:()=>a.hkq,booleanDisjoint:()=>a.t5S,booleanEqual:()=>a.x0k,booleanIntersects:()=>a.lgr,booleanOverlap:()=>a.cYD,booleanParallel:()=>a.Y5$,booleanPointInPolygon:()=>a.mFO,booleanPointOnLine:()=>a.O84,booleanTouches:()=>a.UsQ,booleanValid:()=>a.hxF,booleanWithin:()=>a.Cei,buffer:()=>a.ra8,center:()=>a.gXo,centerMean:()=>a.rb,centerMedian:()=>a.eZr,centerOfMass:()=>a.NAY,centroid:()=>a.vh2,circle:()=>a.n1W,cleanCoords:()=>a.ayX,clone:()=>a.o8B,cloneProperties:()=>a.Rdw,clusterEach:()=>a.UZ0,clusterReduce:()=>a.HYf,clusters:()=>a.qf7,clustersDbscan:()=>a.Zqw,clustersKmeans:()=>a.pPd,collect:()=>a.Fod,collectionOf:()=>a.iww,combine:()=>a.kg7,concave:()=>a.Ms8,containsNumber:()=>a.lOq,convertArea:()=>a.vnt,convertLength:()=>a.I3T,convex:()=>a.y5H,coordAll:()=>a.D3w,coordEach:()=>a.Fh1,coordReduce:()=>a.k7X,createBins:()=>a.f8u,degreesToRadians:()=>a.tRv,destination:()=>a.j_,difference:()=>a.iv2,directionalMean:()=>a.eFb,dissolve:()=>a.a1F,distance:()=>a.IoC,distanceWeight:()=>a.mJ,earthRadius:()=>a.zXD,ellipse:()=>a.pw2,envelope:()=>a.REH,explode:()=>a.Gdr,factors:()=>a.PgN,feature:()=>a.N4z,featureCollection:()=>a.Lrk,featureEach:()=>a.usj,featureOf:()=>a.mo4,featureReduce:()=>a.n4j,filterProperties:()=>a.qV7,findPoint:()=>a.Yd2,findSegment:()=>a.ptW,flatten:()=>a.Bqz,flattenEach:()=>a.iwz,flattenReduce:()=>a.VJK,flip:()=>a.UUz,geojsonRbush:()=>a.sZS,geojsonType:()=>a.e8v,geomEach:()=>a.kX6,geomReduce:()=>a.jEc,geometry:()=>a.lCx,geometryCollection:()=>a.zbs,getCluster:()=>a.dB3,getCoord:()=>a.uGX,getCoords:()=>a.$Rn,getGeom:()=>a.bgk,getType:()=>a.Pwh,greatCircle:()=>a.Glg,helpers:()=>a._$r,hexGrid:()=>a.O9B,interpolate:()=>a.GWP,intersect:()=>a.y$5,invariant:()=>a.V1S,isNumber:()=>a.EtT,isObject:()=>a.Gvm,isobands:()=>a.Mii,isolines:()=>a.LNI,kinks:()=>a.nUT,length:()=>a.Bw9,lengthToDegrees:()=>a.vlv,lengthToRadians:()=>a.GfV,lineArc:()=>a.FsR,lineChunk:()=>a.W26,lineEach:()=>a.Iet,lineIntersect:()=>a.kVe,lineOffset:()=>a.uO7,lineOverlap:()=>a._Jg,lineReduce:()=>a.t0h,lineSegment:()=>a.wdR,lineSlice:()=>a.ne9,lineSliceAlong:()=>a.qMT,lineSplit:()=>a.JQ7,lineString:()=>a.wiw,lineStrings:()=>a.Nls,lineToPolygon:()=>a.gP4,mask:()=>a.dKf,meta:()=>a.mIj,midpoint:()=>a.PVF,moranIndex:()=>a.KFB,multiLineString:()=>a.NUZ,multiPoint:()=>a.kBJ,multiPolygon:()=>a.g52,nearestNeighborAnalysis:()=>a.rBB,nearestPoint:()=>a.xCI,nearestPointOnLine:()=>a.W1F,nearestPointToLine:()=>a.K9N,planepoint:()=>a.xYr,point:()=>a.zx7,pointGrid:()=>a.hq2,pointOnFeature:()=>a.QwJ,pointToLineDistance:()=>a.d4V,pointToPolygonDistance:()=>a.fJX,points:()=>a.WRA,pointsWithinPolygon:()=>a.nj9,polygon:()=>a.n1,polygonSmooth:()=>a.bmV,polygonTangents:()=>a.v4M,polygonToLine:()=>a.CNZ,polygonize:()=>a.Tz9,polygons:()=>a.qFD,projection:()=>a.Qju,propEach:()=>a.nPV,propReduce:()=>a.qBo,propertiesContainsFilter:()=>a.NLl,quadratAnalysis:()=>a.txz,radiansToDegrees:()=>a.nv6,radiansToLength:()=>a.cJD,random:()=>a.yTv,randomLineString:()=>a.lWQ,randomPoint:()=>a._eC,randomPolygon:()=>a.myJ,randomPosition:()=>a.Dxs,rectangleGrid:()=>a.K1I,rewind:()=>a.KrA,rhumbBearing:()=>

1a.Fc$,rhumbDestination:()=>a.rmV,rhumbDistance:()=>a.EUY,round:()=>a.LIG,sample:()=>a.XM1,sector:()=>a.rkH,segmentEach:()=>a.RPu,segmentReduce:()=>a.OQs,shortestPath:()=>a._6q,simplify:()=>a.CRN,square:()=>a.EwI,squareGrid:()=>a.cS4,standardDeviationalEllipse:()=>a.C0c,tag:()=>a.TcI,tesselate:()=>a.nYW,tin:()=>a.ucs,toMercator:()=>a.FU4,toWgs84:()=>a.zY8,transformRotate:()=>a.qS_,transformScale:()=>a.nIv,transformTranslate:()=>a.tLh,triangleGrid:()=>a.Vwd,truncate:()=>a.xvE,union:()=>a.KCZ,unkinkPolygon:()=>a.BoU,validateBBox:()=>a.O6s,validateId:()=>a.GZo,voronoi:()=>a.B8d});var d=t(36796),h=t(35876),p=t(25333);const g={title:"lineOverlap"},u=void 0,f={};function m(){var e=o.lineString([[115,-35],[125,-30],[135,-30],[145,-35]]),n=o.lineString([[115,-25],[125,-30],[135,-30],[145,-25]]),t={line1:e,line2:n,overlapping:s._(e,n)};return(0,i.jsx)(d.A,{addToMap:t})}const x=[{value:"Description",id:"description",level:3},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Examples",id:"examples",level:3},{value:"Installation",id:"installation",level:3}];function j(e){const n={a:"a",code:"code",em:"em",h3:"h3",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h3,{id:"description",children:"Description"}),"\n",(0,i.jsx)(n.p,{children:"Takes any LineString or Polygon and returns the overlapping lines between both features."}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"Name"}),(0,i.jsx)(n.th,{children:"Type"}),(0,i.jsx)(n.th,{children:"Description"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"line1"}),(0,i.jsx)(n.td,{children:(0,i.jsxs)(n.strong,{children:[(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1",children:"Geometry"})," | ",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.2",children:"Feature"}),"<",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1.4",children:"LineString"})," | ",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1.5",children:"MultiLineString"})," | ",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1.6",children:"Polygon"})," | ",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1.7",children:"MultiPolygon"}),">"]})}),(0,i.jsx)(n.td,{children:"any LineString or Polygon"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:"line2"}),(0,i.jsx)(n.td,{children:(0,i.jsxs)(n.strong,{children:[(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1",children:"Geometry"})," | ",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.2",children:"Feature"}),"<",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1.4",children:"LineString"})," | ",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1.5",children:"MultiLineString"})," | ",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1.6",children:"Polygon"})," | ",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1.7",children:"MultiPolygon"}),">"]})}),(0,i.jsx)(n.td,{children:"any LineString or Polygon"})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:["options",(0,i.jsx)("i",{children:"?"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",children:"Object"})})}),(0,i.jsxs)(n.td,{children:["Optional parameters ",(0,i.jsx)(n.em,{children:"(default {})"})]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsxs)(n.td,{children:["options.tolerance",(0,i.jsx)("i",{children:"?"})]}),(0,i.jsx)(n.td,{children:(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number",children:"number"})})}),(0,i.jsxs)(n.td,{children:["Tolerance distance to match overlapping line segments (in kilometers) ",(0,i.jsx)(n.em,{children:"(default 0)"})]})]})]})]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsxs)(n.strong,{children:[(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.3",children:"FeatureCollection"}),"<",(0,i.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1.4",children:"LineString"}),">"]})," lines(s) that are overlapping between both features"]}),"\n",(0,i.jsx)(n.h3,{id:"examples",children:"Examples"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",children:"var line1 = turf.lineString([\n  [115, -35],\n  [125, -30],\n  [135, -30],\n  [145, -35],\n]);\nvar line2 = turf.lineString([\n  [115, -25],\n  [125, -30],\n  [135, -30],\n  [145, -25],\n]);\n\nvar overlapping = turf.lineOverlap(line1, line2);\n"})}),"\n",(0,i.jsx)(p.A,{children:()=>(0,i.jsx)(m,{})}),"\n",(0,i.jsx)(n.h3,{id:"installation",children:"Installation"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",children:'$ npm install @turf/line-overlap\n\nimport { lineOverlap } from "@turf/line-overlap";\nconst result = lineOverlap(...);\n'})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-javascript",children:'$ npm install @turf/turf\n\nimport * as turf from "@turf/turf";\nconst result = turf.lineOverlap(...);\n'})}),"\n",(0,i.jsx)(p.A,{children:()=>(0,i.jsx)(h.A,{turf:c})})]})}function v(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]);