https://turfjs.org/assets/js/2df32f9b.08396d2e.js

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

1i.Fc$,rhumbDestination:()=>i.rmV,rhumbDistance:()=>i.EUY,round:()=>i.LIG,sample:()=>i.XM1,sector:()=>i.rkH,segmentEach:()=>i.RPu,segmentReduce:()=>i.OQs,shortestPath:()=>i._6q,simplify:()=>i.CRN,square:()=>i.EwI,squareGrid:()=>i.cS4,standardDeviationalEllipse:()=>i.C0c,tag:()=>i.TcI,tesselate:()=>i.nYW,tin:()=>i.ucs,toMercator:()=>i.FU4,toWgs84:()=>i.zY8,transformRotate:()=>i.qS_,transformScale:()=>i.nIv,transformTranslate:()=>i.tLh,triangleGrid:()=>i.Vwd,truncate:()=>i.xvE,union:()=>i.KCZ,unkinkPolygon:()=>i.BoU,validateBBox:()=>i.O6s,validateId:()=>i.GZo,voronoi:()=>i.B8d});o(36796);var a=o(35876),c=o(25333);const d={title:"booleanCrosses"},h=void 0,u={},p=[{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 g(e){const n={a:"a",code:"code",h3:"h3",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(c.A,{children:()=>(0,r.jsx)(a.A,{turf:l})}),"\n",(0,r.jsx)(n.h3,{id:"description",children:"Description"}),"\n",(0,r.jsx)(n.p,{children:"Boolean-Crosses returns True if the intersection results in a geometry whose dimension is one less than\nthe maximum dimension of the two source geometries and the intersection set is interior to\nboth source geometries."}),"\n",(0,r.jsx)(n.p,{children:"Boolean-Crosses returns t (TRUE) for only multipoint/polygon, multipoint/linestring, linestring/linestring, linestring/polygon, and linestring/multipolygon comparisons.\nOther comparisons are not supported as they are outside the OpenGIS Simple Features spec and may give unexpected results."}),"\n",(0,r.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Name"}),(0,r.jsx)(n.th,{children:"Type"}),(0,r.jsx)(n.th,{children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"feature1"}),(0,r.jsx)(n.td,{children:(0,r.jsxs)(n.strong,{children:[(0,r.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1",children:"Geometry"})," | ",(0,r.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.2",children:"Feature"}),"<any>"]})}),(0,r.jsx)(n.td,{children:"GeoJSON Feature or Geometry"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"feature2"}),(0,r.jsx)(n.td,{children:(0,r.jsxs)(n.strong,{children:[(0,r.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.1",children:"Geometry"})," | ",(0,r.jsx)(n.a,{href:"https://tools.ietf.org/html/rfc7946#section-3.2",children:"Feature"}),"<any>"]})}),(0,r.jsx)(n.td,{children:"GeoJSON Feature or Geometry"})]})]})]}),"\n",(0,r.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)("ul",{children:(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"boolean"})," true/false"]})}),"\n",(0,r.jsx)(n.h3,{id:"examples",children:"Examples"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-javascript",children:"var line1 = turf.lineString([\n  [-2, 2],\n  [4, 2],\n]);\nvar line2 = turf.lineString([\n  [1, 1],\n  [1, 2],\n  [1, 3],\n  [1, 4],\n]);\n\nvar cross = turf.booleanCrosses(line1, line2);\n//=true\n"})}),"\n",(0,r.jsx)(n.h3,{id:"installation",children:"Installation"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-javascript",children:'$ npm install @turf/boolean-crosses\n\nimport { booleanCrosses } from "@turf/boolean-crosses";\nconst result = booleanCrosses(...);\n'})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-javascript",children:'$ npm install @turf/turf\n\nimport * as turf from "@turf/turf";\nconst result = turf.booleanCrosses(...);\n'})})]})}function m(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(g,{...e})}):g(e)}}}]);