@turf/inside - npm Package Versions

5.0.0 🎉

⭐️ Major Updates

• TurfJS now supports ES Modules (Related PR's)
• Optional parameters are now defined as an Object.

🚀 New Modules

[@turf/voronoi][voronoi]

Takes a FeatureCollection of points, and a bounding box, and returns a FeatureCollection of Voronoi polygons. (PR https://github.com/Turfjs/turf/pull/1043 - Author @stevage)

[@turf/shortest-path][shortest-path]

Returns the shortest path from start to end without colliding with any feature in obstacles (PR https://github.com/Turfjs/turf/pull/956 - Author @stebogit)

[@turf/boolean-parallel][boolean-parallel]

Boolean-Parallel returns True if each segment of line1 is parallel to the correspondent segment of line2 (PR https://github.com/Turfjs/turf/pull/941 - Author @stebogit)

[@turf/nearest-point-on-line][nearest-point-on-line]

Takes a {@link Point} and a {@link LineString} and calculates the closest Point on the (Multi)LineString. (PR https://github.com/Turfjs/turf/pull/939 - Author @stebogit)

🏅 New Features/Enhancements

• Updates [@turf/unkink-polygon][unkink-polygon] testing & added flattenEach instead of using flatten. (PR https://github.com/Turfjs/turf/pull/889)

• Add multi-geomtry support to @turf/line-split (PR https://github.com/Turfjs/turf/pull/1078)

• Improve @turf/meta lineEach method to provide properties, id and bbox (PR https://github.com/Turfjs/turf/pull/1010)

🐛 Bug Fixes

• Fixes @turf/helpers earth radius variable (PR https://github.com/Turfjs/turf/pull/1012)

• Fixes @turf/polygon-tangents bug (PR https://github.com/Turfjs/turf/pull/1058)

• Fixes @turf/line-chunk bug when the number of segments is integer (PR https://github.com/Turfjs/turf/pull/1046)

• Fixes segmentEach and segmentReduce methods in @turf/meta to ensure something is returned (PR https://github.com/Turfjs/turf/pull/968)

⚠️ Breaking Change

• Optional parameters are now defined as an Object:

Before

var from = [-75.343, 39.984];
var to = [-75.534, 39.123];
var units = 'miles';
var distance = turf.distance(from, to, units);

After

var from = [-75.343, 39.984];
var to = [-75.534, 39.123];
var options = {units: 'miles'};
var distance = turf.distance(from, to, options);

• Reworked @turf/random PR https://github.com/Turfjs/turf/issues/994
• Deprecate @turf/idw Issue https://github.com/Turfjs/turf/issues/887
• Reworked Grid modules @turf/point-grid/hex/square/triangle PR https://github.com/Turfjs/turf/pull/1029
• Renamed Modules/Methods
  • [x] @turf/inside => @turf/boolean-point-in-polygon https://github.com/Turfjs/turf/issues/860#issuecomment-317216235
  • [x] @turf/within => @turf/points-within-polygon https://github.com/Turfjs/turf/issues/860#issuecomment-317216235
  • [x] @turf/bezier => @turf/bezier-spline Issue https://github.com/Turfjs/turf/issues/661
  • [x] @turf/nearest => @turf/nearest-point https://github.com/Turfjs/turf/pull/858#issuecomment-317197295
  • [x] @turf/point-on-line => @turf/nearest-point-on-line https://github.com/Turfjs/turf/pull/858#issuecomment-317197295
  • [x] @turf/lineDistance => @turf/length https://github.com/Turfjs/turf/issues/860#issuecomment-317229869
  • [x] @turf/helpers
    • [x] radians2degrees => radiansToDegrees
    • [x] degrees2radians => degreesToRadians
    • [x] distanceToDegrees => lengthToDegrees
    • [x] distanceToRadians => lengthToRadians
    • [x] radiansToDistance => radiansToLength
    • [x] bearingToAngle => bearingToAzimuth
    • [x] convertDistance => convertLength

4.7.0

🚀 New Modules

[@turf/projection][projection]

• toMercator: Converts a WGS84 GeoJSON object into Mercator (EPSG:900913) projection
• toWgs84: Converts a Mercator (EPSG:900913) GeoJSON object into WGS84 projection

(PR https://github.com/Turfjs/turf/pull/927 - Author @stebogit)

[@turf/point-to-line-distance][point-to-line-distance]

Returns the minimum distance between a {@link Point} and a {@link LineString}, being the distance from a line the minimum distance between the point and any segment of the LineString.

(PR https://github.com/Turfjs/turf/pull/925 - Author @stebogit)

[@turf/boolean-within][boolean-within]

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][boolean-contains].

(PR https://github.com/Turfjs/turf/pull/924 - Author @rowanwins)

🏅 New Features/Enhancements

• Updates [@turf/unkink-polygon][unkink-polygon] testing & added flattenEach instead of using flatten. (PR https://github.com/Turfjs/turf/pull/889)
• [@turf/concave][concave] refactoring, replacing [@turf/union][union] with geojson-dissolve to increase speed and added support to null geometries (PR https://github.com/Turfjs/turf/pull/907 - Contributor @stebogit @DenisCarriere)
• Adds doc note on [@turf/polygonize][polygonize] about "Edges must be correctly noded" (PR https://github.com/Turfjs/turf/pull/898 - Contributor @stebogit @NickCis)
• Adds support to foreign Members to [@turf/clone][clone] (PR https://github.com/Turfjs/turf/pull/904 - Contributor @DenisCarriere)
• Extends support of any GeoJSON to [@turf/simplify][simplify] (PR https://github.com/Turfjs/turf/pull/903 - Contributor @DenisCarriere @stebogit)
• Adds new isNumber function and improves type checking for few [@turf/helpers][helpers] methods (PR https://github.com/Turfjs/turf/pull/920 - Contributor @DenisCarriere @stebogit)
• Adds throw errors to invalid MultiPolygons for [@turf/simplify][simplify] (PR https://github.com/Turfjs/turf/pull/922 - Contributor @DenisCarriere)

🐛 Bug Fixes

• Fixes @turf/bbox-clip point intersection handling, adding sanity-checks the lineclip output (PR https://github.com/Turfjs/turf/pull/886)
• Fixes [@turf/line-split][line-split] endpoint case handling applying [@turf/truncate][truncate] on splitter (PR https://github.com/Turfjs/turf/pull/892 and https://github.com/Turfjs/turf/pull/855 - Contributor @stebogit)
• Fixes [@turf/intersect][intersect] throwing "uncaught exception", adding [@turf/truncate][truncate] to inputs and returning Feature<null> if no geometry (PR https://github.com/Turfjs/turf/pull/890 - Contributor @stebogit @vicvolk)
• Fixes [@turf/hex-grid][hex-grid] not properly cloning the last ring vertex (PR https://github.com/Turfjs/turf/pull/897 - Contributor @stebogit @DenisCarriere)
• Fixes [@turf/boolean-disjoint][boolean-disjoint] incorrect behaviour where a poly was completely contained within another poly (PR https://github.com/Turfjs/turf/pull/908 - Contributor @rowanwins)
• Fixes [@turf/simplify][simplify] process pending on particular geometries, applying [@turf/clean-coords][clean-coords] to input. (PR https://github.com/Turfjs/turf/pull/903 - Contributor @stebogit @DenisCarriere)
• Fixes boolean properties not being translated with [@turf/clone][clone] (PR https://github.com/Turfjs/turf/pull/909 - Contributor @DenisCarriere)
• Fixes [@turf/boolean-contains][boolean-contains] incorrect output when checking two polygons (PR https://github.com/Turfjs/turf/pull/923 - Contributor @rowanwins @DenisCarriere)

4.6.0

🚀 New Modules

• @turf/clean-coords Removes redundant coordinates from any GeoJSON Geometry. (PR https://github.com/Turfjs/turf/pull/875 - Author @stebogit)
• @turf/interpolate Takes a set of points and estimates their 'property' values on a grid using the Inverse Distance Weighting (IDW) method.. (PR https://github.com/Turfjs/turf/pull/832 - Author @stebogit)
• @turf/clusters-dbscan Takes a set of Points and partition them into clusters according to DBSCAN's data clustering algorithm. (PR https://github.com/Turfjs/turf/pull/812 and https://github.com/Turfjs/turf/pull/851 - Author @DenisCarriere)

  special mention to this incredibly instructive and fun interactive map by @DenisCarriere 😎👏

• @turf/clusters Provides getCluster, clusterEach, and clusterReduce functions. (PR https://github.com/Turfjs/turf/pull/847 - Author @DenisCarriere)
• @turf/boolean-point-on-line Returns true if a point is on a line. Accepts a optional parameter to ignore the start and end vertices of the linestring. (PR https://github.com/Turfjs/turf/pull/858 - Author @rowanwins)
• @turf/boolean-overlap Takes two features and returns true or false whether or not they overlap, i.e. whether any pair of edges on the two polygons intersect. If there are any edge intersections, the polygons overlap. (PR https://github.com/Turfjs/turf/pull/856 and https://github.com/Turfjs/turf/pull/868 - Author @stebogit @tcql)
• @turf/boolean-equal Determine whether two geometries of the same type have identical X,Y coordinate values. (PR https://github.com/Turfjs/turf/pull/869 - Author @stebogit @tcql)

🏅 New Features/Enhancements

• Sets centered param default to true in @turf/point-grid (PR https://github.com/Turfjs/turf/pull/836 - Contributor @stebogit)
• Adds MultiLineString support for @turf/point-on-line (PR https://github.com/Turfjs/turf/pull/838 - Contributor @stebogit)
• Renames @turf/clusters => @turf/clusters-kmeans, plus adds deprecated warning message to @turf/clusters@4.5.2 (See Issue https://github.com/Turfjs/turf/issues/845)
• Changes output type of @turf/clusters-kmeans (See Issue https://github.com/Turfjs/turf/issues/850 - Contributor @DenisCarriere)
• Adds segmentEach and segmentReduce functions to @turf/meta (See Issue https://github.com/Turfjs/turf/issues/850 - Contributor @DenisCarriere)
• Adds tests and linting on JSDoc in TurfJS core from turf-www; see Issue https://github.com/Turfjs/turf/issues/859 (PR https://github.com/Turfjs/turf/issues/857 + https://github.com/Turfjs/turf/issues/864 + https://github.com/Turfjs/turf/issues/870 - Contributor @DenisCarriere @stebogit)
• Introduces null Geometry support across TurfJS modules (See Issue https://github.com/Turfjs/turf/issues/853) (PR https://github.com/Turfjs/turf/issues/866 - Contributor @DenisCarriere)
• Includes feature(Sub)Index in coordEach/coordReduce (@turf/meta) 🎉 (PR https://github.com/Turfjs/turf/issues/872 - Contributor @DenisCarriere)
• Adds bbox and id params plus geometry method to @turf/helpers (PR https://github.com/Turfjs/turf/issues/877 - Contributor @DenisCarriere)

🐛 Bug Fixes

• Applies @turf/truncate to @turf/line-split splitter input to avoid approximation errors. Fixed #852 (PR https://github.com/Turfjs/turf/pull/855)
• Fixes @turf-mask error (See Issue https://github.com/Turfjs/turf/issues/837) (PR https://github.com/Turfjs/turf/pull/865 - Contributor @thiagoxvo)
• Fixes create-new-module script error on LICENSE file creation (See Issue https://github.com/Turfjs/turf/issues/861) (commit df6986e)
• Fixes @turf/isobands error on commonProperties (See Issue https://github.com/Turfjs/turf/issues/831) (commit 1663f07)

4.4.0

🚀 New Modules

• @turf/line-offset Adds a new lineOffset module as per this issue. Basically takes an input line and returns a new line offset by the distance. (PR https://github.com/Turfjs/turf/pull/729 - Author @rowanwins)
• @turf/polygonize Polygonizes (Multi)LineString(s) into Polygons. Implementation of GEOSPolygonize function (geos::operation::polygonize::Polygonizer). (PR https://github.com/Turfjs/turf/pull/767 - Author @NickCis)
• @turf/transform-rotate Rotates any geojson Feature or Geometry of a specified angle, around its centroid or a given pivot point; all rotations follow the right-hand rule. (Issue https://github.com/Turfjs/turf/issues/747 - Author @stebogit)
• @turf/transform-translate Moves any geojson Feature or Geometry of a specified distance along a Rhumb Line on the provided direction angle. (Issue https://github.com/Turfjs/turf/issues/747 - Author @stebogit)
• @turf/transform-scale Scale a GeoJSON from a given point by a factor of scaling (ex: factor=2 would make the GeoJSON 200% larger). If a FeatureCollection is provided, the origin point will be calculated based on each individual Feature. (Issue https://github.com/Turfjs/turf/issues/747 - Author @stebogit)

🏅 New Features

• Support z-coordinate as input for @turf/turf-tin (PR https://github.com/Turfjs/turf/pull/772)
• Adds properties parameter to @turf/centroid and @turf/center (PR https://github.com/Turfjs/turf/pull/769)
• Include Yarn.lock for all modules & Lerna uses Yarn (Issue https://github.com/Turfjs/turf/issues/704, https://github.com/Turfjs/turf/issues/765, PR https://github.com/Turfjs/turf/pull/766)
• Use Tap at root which enables code coverage reports (Issue https://github.com/Turfjs/turf/issues/328 & PR https://github.com/Turfjs/turf/pull/762)
• Support z-coordinate as input for @turf/pointplane (PR https://github.com/Turfjs/turf/pull/754)
• Add core tests - file management & package.json rules (PR https://github.com/Turfjs/turf/pull/749 & https://github.com/Turfjs/turf/pull/756)

🐛 Bug Fixes

• Website http://turfjs.org is back up and running (Issue https://github.com/Turfjs/turf/issues/777)
• @turf/rhumb-destination issue at 180th meridian (Issue https://github.com/Turfjs/turf/issues/770 & PR https://github.com/Turfjs/turf/pull/771)
• Getting too large numbers for Longitude (Issue https://github.com/Turfjs/turf/issues/758 & PR https://github.com/Turfjs/turf/pull/763)
• Throw error if FeatureCollection not array #751 (PR https://github.com/Turfjs/turf/pull/760)
• Change default param coordinates to 3 @turf/truncate (PR https://github.com/Turfjs/turf/pull/757)
• along returns a point that is not found by @turf/point-on-line (Issue https://github.com/Turfjs/turf/issues/691)
• Fix location of intersect point for @turf/point-on-line. (PR https://github.com/Turfjs/turf/pull/750)
• Handle empty geometries as undefined @turf/buffer (PR https://github.com/Turfjs/turf/pull/746)

4.3.0

🚀 New Modules

• Rhumb Line Modules (https://github.com/Turfjs/turf/pull/728)
  • @turf/rhumb-bearing
  • @turf/rhumb-distance
  • @turf/rhumb-destination
• @turf/polygon-tangents Finds the tangents of a (Multi)Polygon from a Point. (https://github.com/Turfjs/turf/pull/708)
• @turf/rewind Rewind LineString or Polygon outer ring ~clockwise~ counter-clockwise and inner rings ~counterclockwise~ clockwise (https://github.com/Turfjs/turf/pull/700 & https://github.com/Turfjs/turf/issues/66)
• @turf/isobands - Takes a grid FeatureCollection of Point features with z-values and an array of value breaks and generates filled contour isobands. (https://github.com/Turfjs/turf/pull/619)

🏅 New Features

• New function convertDistance to @turf/helpers (https://github.com/Turfjs/turf/pull/732)
• Add ignoreBoundary param @turf/inside (https://github.com/Turfjs/turf/pull/706)
• Add flattenEach/flattenReduce to @turf/meta. (https://github.com/Turfjs/turf/pull/712 & https://github.com/Turfjs/turf/issues/692)
• New Feature getGeom & getGeomType in @turf/invariant (https://github.com/Turfjs/turf/pull/720)
• Adds round(), radians2degrees() and degrees2radians() to turf-helpers (https://github.com/Turfjs/turf/pull/715)
• ⭐️ New Add FeatureCollection & GeometryCollection support to @turf/rewind (https://github.com/Turfjs/turf/pull/741)

🐛 Bug Fixes

• Fix @turf/circle translate properties (https://github.com/Turfjs/turf/pull/717)
• Apply equidistance @turf/buffer to polygons (https://github.com/Turfjs/turf/issues/660 & https://github.com/Turfjs/turf/pull/718)
• Fix jsts empty (Multi)Polygon error @turf/difference (https://github.com/Turfjs/turf/pull/725)
• Support Geometry Objects & Collection (https://github.com/Turfjs/turf/issues/710)
  • @turf/line-intersect (https://github.com/Turfjs/turf/pull/731)
  • @turf/line-chunk (https://github.com/Turfjs/turf/pull/726)
  • @turf/line-segment (https://github.com/Turfjs/turf/pull/727 & https://github.com/Turfjs/turf/pull/711)
  • @turf/line-overlap (https://github.com/Turfjs/turf/pull/711)
• New Reverse winding - Polygon CCW & Polygon CW @turf/rewind (https://github.com/Turfjs/turf/pull/741)
• ⭐️ New Fix Feature GeometryCollection to @turf/buffer (https://github.com/Turfjs/turf/pull/739)
• ⭐️ New Re-enable negative radius to @turf/buffer (https://github.com/Turfjs/turf/pull/736)

4.2.0

New Modules

• @turf/sector
• @turf/linestring-to-polygon

Enhancements

• Add mutate param to @turf/flip
• Add Geometry & GeometryCollection support to @turf/truncate
• @turf/inside performance increase
• Add properties param to @turf/circle
• Added bearingToAngle method to turf-helpers

Bug Fixes

• Fix @turf/buffer points in high latitudes
• lineIntersect returns the same point several times
• @turf/flip incorrect if z-elevation is present

Changes

• Change output types @turf/polygon-to-linestring

Documentation

• Update JSDocs examples
• Include many more AddToMap to modules