Index (services-turf API)

A B C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

along(LineString, double, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a line and returns a point at a specified distance along the line.
along(List<Point>, double, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a list of points and returns a point at a specified distance along the line.
area(Feature) - Static method in class com.mapbox.turf.TurfMeasurement: Takes one Feature and returns it's area in square meters.
area(FeatureCollection) - Static method in class com.mapbox.turf.TurfMeasurement: Takes one FeatureCollection and returns it's area in square meters.
area(Geometry) - Static method in class com.mapbox.turf.TurfMeasurement: Takes one Geometry and returns its area in square meters.

B

bbox(Feature) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
bbox(FeatureCollection) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
bbox(GeoJson) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
bbox(Geometry) - Static method in class com.mapbox.turf.TurfMeasurement: Takes an arbitrary Geometry and calculates a bounding box.
bbox(LineString) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
bbox(MultiLineString) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
bbox(MultiPoint) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
bbox(MultiPolygon) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
bbox(Point) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
bbox(Polygon) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
bboxPolygon(double[]) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a bbox and uses its coordinates to create a Polygon geometry.
bboxPolygon(double[], JsonObject, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a bbox and uses its coordinates to create a Polygon geometry.
bboxPolygon(BoundingBox) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a BoundingBox and uses its coordinates to create a Polygon geometry.
bboxPolygon(BoundingBox, JsonObject, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a BoundingBox and uses its coordinates to create a Polygon geometry.
bearing(Point, Point) - Static method in class com.mapbox.turf.TurfMeasurement: Takes two Points and finds the geographic bearing between them.
build() - Method in class com.mapbox.turf.models.LineIntersectsResult.Builder: Builds a new instance of a LineIntersectsResult class.
builder() - Static method in class com.mapbox.turf.models.LineIntersectsResult: Builds a new instance of a lineIntersection.

C

center(Feature) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a Feature and returns the absolute center of the Feature.
center(FeatureCollection) - Static method in class com.mapbox.turf.TurfMeasurement: Takes FeatureCollection and returns the absolute center of the Features in the FeatureCollection.
center(FeatureCollection, JsonObject, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes FeatureCollection and returns the absolute center of the Features in the FeatureCollection.
center(Feature, JsonObject, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a Feature and returns the absolute center of the Feature.
circle(Point, double) - Static method in class com.mapbox.turf.TurfTransformation: Takes a Point and calculates the circle polygon given a radius in degrees, radians, miles, or kilometers; and steps for precision.
circle(Point, double, int, String) - Static method in class com.mapbox.turf.TurfTransformation: Takes a Point and calculates the circle polygon given a radius in the provided TurfConstants.TurfUnitCriteria; and steps for precision.
circle(Point, double, String) - Static method in class com.mapbox.turf.TurfTransformation: Takes a Point and calculates the circle polygon given a radius in the provided TurfConstants.TurfUnitCriteria; and steps for precision.
collectionOf(FeatureCollection, String, String) - Static method in class com.mapbox.turf.TurfAssertions: Enforce expectations about types of FeatureCollection inputs for Turf.
com.mapbox.turf - package com.mapbox.turf: Contains the Mapbox Java Services Turf methods.
com.mapbox.turf.models - package com.mapbox.turf.models: Contains the Mapbox Java Services classes.
combine(FeatureCollection) - Static method in class com.mapbox.turf.TurfConversion: Combines a FeatureCollection of geometries and returns a FeatureCollection with "Multi-" geometries in it.
convertLength(double, String) - Static method in class com.mapbox.turf.TurfConversion: Converts a distance to the default units.
convertLength(double, String, String) - Static method in class com.mapbox.turf.TurfConversion: Converts a distance to a different unit specified.
coordAll(FeatureCollection, boolean) - Static method in class com.mapbox.turf.TurfMeta: Get all coordinates from a FeatureCollection object, returning a List of Point objects.
coordAll(Feature, boolean) - Static method in class com.mapbox.turf.TurfMeta: Get all coordinates from a Feature object, returning a List of Point objects.
coordAll(LineString) - Static method in class com.mapbox.turf.TurfMeta: Get all coordinates from a LineString object, returning a List of Point objects.
coordAll(MultiLineString) - Static method in class com.mapbox.turf.TurfMeta: Get all coordinates from a MultiLineString object, returning a List of Point objects.
coordAll(MultiPoint) - Static method in class com.mapbox.turf.TurfMeta: Get all coordinates from a MultiPoint object, returning a List of Point objects.
coordAll(MultiPolygon, boolean) - Static method in class com.mapbox.turf.TurfMeta: Get all coordinates from a MultiPolygon object, returning a List of Point objects.
coordAll(Point) - Static method in class com.mapbox.turf.TurfMeta: Get all coordinates from a Point object, returning a List of Point objects.
coordAll(Polygon, boolean) - Static method in class com.mapbox.turf.TurfMeta: Get all coordinates from a Polygon object, returning a List of Point objects.

D

degreesToRadians(double) - Static method in class com.mapbox.turf.TurfConversion: Converts an angle in degrees to radians.
destination(Point, double, double, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a Point and calculates the location of a destination point given a distance in degrees, radians, miles, or kilometers; and bearing in degrees.
distance(Point, Point) - Static method in class com.mapbox.turf.TurfMeasurement: Calculates the distance between two points in kilometers.
distance(Point, Point, String) - Static method in class com.mapbox.turf.TurfMeasurement: Calculates the distance between two points in degress, radians, miles, or kilometers.

E

EARTH_RADIUS - Static variable in class com.mapbox.turf.TurfMeasurement: Earth's radius in meters.
envelope(GeoJson) - Static method in class com.mapbox.turf.TurfMeasurement: Takes any number of features and returns a rectangular Polygon that encompasses all vertices.
equals(Object) - Method in class com.mapbox.turf.models.LineIntersectsResult
explode(Feature) - Static method in class com.mapbox.turf.TurfConversion: Takes a Feature and returns its position as a Point objects.
explode(FeatureCollection) - Static method in class com.mapbox.turf.TurfConversion: Takes a FeatureCollection and returns all positions as Point objects.

F

featureOf(Feature, String, String) - Static method in class com.mapbox.turf.TurfAssertions: Enforce expectations about types of Feature inputs for Turf.

G

geojsonType(GeoJson, String, String) - Static method in class com.mapbox.turf.TurfAssertions: Enforce expectations about types of GeoJson objects for Turf.
getCoord(Feature) - Static method in class com.mapbox.turf.TurfAssertions: Deprecated.
use TurfMeta.getCoord(Feature)
getCoord(Feature) - Static method in class com.mapbox.turf.TurfMeta: Unwrap a coordinate Point from a Feature with a Point geometry.

H

hashCode() - Method in class com.mapbox.turf.models.LineIntersectsResult
horizontalIntersection() - Method in class com.mapbox.turf.models.LineIntersectsResult: If the lines intersect, use this method to get the intersecting point X value.
horizontalIntersection(Double) - Method in class com.mapbox.turf.models.LineIntersectsResult.Builder: If the lines intersect, use this method to get the intersecting point X value.

I

inside(Point, MultiPolygon) - Static method in class com.mapbox.turf.TurfJoins: Takes a Point and a MultiPolygon and determines if the point resides inside the polygon.
inside(Point, Polygon) - Static method in class com.mapbox.turf.TurfJoins: Takes a Point and a Polygon and determines if the point resides inside the polygon.

L

length(LineString, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a LineString and measures its length in the specified units.
length(MultiLineString, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a MultiLineString and measures its length in the specified units.
length(MultiPolygon, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a MultiPolygon and measures each polygons perimeter in the specified units.
length(Polygon, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a Polygon and measures its perimeter in the specified units.
length(List<Point>, String) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a List of Point and measures its length in the specified units.
lengthToDegrees(double, String) - Static method in class com.mapbox.turf.TurfConversion: Convert a distance measurement (assuming a spherical Earth) from a real-world unit into degrees Valid units: miles, nauticalmiles, inches, yards, meters, metres, centimeters, kilometres, feet.
lengthToRadians(double) - Static method in class com.mapbox.turf.TurfConversion: Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians.
lengthToRadians(double, String) - Static method in class com.mapbox.turf.TurfConversion: Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians.
LineIntersectsResult - Class in com.mapbox.turf.models: if the lines intersect, the result contains the x and y of the intersection (treating the lines as infinite) and booleans for whether line segment 1 or line segment 2 contain the point.
LineIntersectsResult.Builder - Class in com.mapbox.turf.models: Build a new LineIntersectsResult instance and define its features by passing in information through the offered methods.
lineSlice(Point, Point, Feature) - Static method in class com.mapbox.turf.TurfMisc: Takes a line, a start Point, and a stop point and returns the line in between those points.
lineSlice(Point, Point, LineString) - Static method in class com.mapbox.turf.TurfMisc: Takes a line, a start Point, and a stop point and returns the line in between those points.
lineSliceAlong(Feature, double, double, String) - Static method in class com.mapbox.turf.TurfMisc: Takes a LineString, a specified distance along the line to a start Point, and a specified distance along the line to a stop point and returns a subsection of the line in-between those points.
lineSliceAlong(LineString, double, double, String) - Static method in class com.mapbox.turf.TurfMisc: Takes a LineString, a specified distance along the line to a start Point, and a specified distance along the line to a stop point, returns a subsection of the line in-between those points.

M

midpoint(Point, Point) - Static method in class com.mapbox.turf.TurfMeasurement: Takes two Points and returns a point midway between them.
multiPolygonToLine(Feature) - Static method in class com.mapbox.turf.TurfConversion: Takes a Feature that contains MultiPolygon and covert it to a FeatureCollection that contains list of Feature of LineString or MultiLineString.
multiPolygonToLine(Feature, JsonObject) - Static method in class com.mapbox.turf.TurfConversion: Takes a Feature that contains MultiPolygon and a properties JsonObject and covert it to a FeatureCollection that contains list of Feature of LineString or MultiLineString.

N

nearestPoint(Point, List<Point>) - Static method in class com.mapbox.turf.TurfClassification: Takes a reference point and a list of Point geometries and returns the point from the set point list closest to the reference.
nearestPointOnLine(Point, List<Point>) - Static method in class com.mapbox.turf.TurfMisc: Takes a Point and a LineString and calculates the closest Point on the LineString.
nearestPointOnLine(Point, List<Point>, String) - Static method in class com.mapbox.turf.TurfMisc: Takes a Point and a LineString and calculates the closest Point on the LineString.

O

onLine1() - Method in class com.mapbox.turf.models.LineIntersectsResult: Determine if the intersecting point lands on line 1 or not.
onLine1(boolean) - Method in class com.mapbox.turf.models.LineIntersectsResult.Builder: Determine if the intersecting point lands on line 1 or not.
onLine2() - Method in class com.mapbox.turf.models.LineIntersectsResult: Determine if the intersecting point lands on line 2 or not.
onLine2(boolean) - Method in class com.mapbox.turf.models.LineIntersectsResult.Builder: Determine if the intersecting point lands on line 2 or not.

P

pointsWithinPolygon(FeatureCollection, FeatureCollection) - Static method in class com.mapbox.turf.TurfJoins: Takes a FeatureCollection of Point and a FeatureCollection of Polygon and returns the points that fall within the polygons.
polygonToLine(Feature) - Static method in class com.mapbox.turf.TurfConversion: Takes a Feature that contains Polygon and covert it to a Feature that contains LineString or MultiLineString.
polygonToLine(Feature, JsonObject) - Static method in class com.mapbox.turf.TurfConversion: Takes a Feature that contains Polygon and a properties JsonObject and covert it to a Feature that contains LineString or MultiLineString.
polygonToLine(MultiPolygon) - Static method in class com.mapbox.turf.TurfConversion: Takes a MultiPolygon and covert it to a FeatureCollection that contains list of Feature of LineString or MultiLineString.
polygonToLine(MultiPolygon, JsonObject) - Static method in class com.mapbox.turf.TurfConversion: Takes a MultiPolygon and a properties JsonObject and covert it to a FeatureCollection that contains list of Feature of LineString or MultiLineString.
polygonToLine(Polygon) - Static method in class com.mapbox.turf.TurfConversion: Takes a Polygon and covert it to a Feature that contains LineString or MultiLineString.
polygonToLine(Polygon, JsonObject) - Static method in class com.mapbox.turf.TurfConversion: Takes a Polygon and a properties JsonObject and covert it to a Feature that contains LineString or MultiLineString.

R

radiansToDegrees(double) - Static method in class com.mapbox.turf.TurfConversion: Converts an angle in radians to degrees.
radiansToLength(double) - Static method in class com.mapbox.turf.TurfConversion: Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.
radiansToLength(double, String) - Static method in class com.mapbox.turf.TurfConversion: Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.

S

square(BoundingBox) - Static method in class com.mapbox.turf.TurfMeasurement: Takes a bounding box and calculates the minimum square bounding box that would contain the input.

T

toBuilder() - Method in class com.mapbox.turf.models.LineIntersectsResult: Convert current instance values into another Builder to quickly change one or more values.
toString() - Method in class com.mapbox.turf.models.LineIntersectsResult
TurfAssertions - Class in com.mapbox.turf: Also called Assertions, these methods enforce expectations of a certain type or calculate various shapes from given points.
TurfClassification - Class in com.mapbox.turf: Methods found in this class are meant to consume a set of information and classify it according to a shared quality or characteristic.
TurfConstants - Class in com.mapbox.turf: This class holds the Turf constants which are useful when specifying additional information such as units prior to executing the Turf function.
TurfConstants.TurfUnitCriteria - Annotation Interface in com.mapbox.turf: Retention policy for the various Turf units.
TurfConversion - Class in com.mapbox.turf: This class is made up of methods that take in an object, convert it, and then return the object in the desired units or object.
TurfException - Exception in com.mapbox.turf: This indicates conditions that a reasonable application might want to catch.
TurfException(String) - Constructor for exception com.mapbox.turf.TurfException: A form of RuntimeException that indicates conditions that a reasonable application might want to catch.
TurfJoins - Class in com.mapbox.turf: Class contains methods that can determine if points lie within a polygon or not.
TurfMeasurement - Class in com.mapbox.turf: Class contains an assortment of methods used to calculate measurements such as bearing, destination, midpoint, etc.
TurfMeta - Class in com.mapbox.turf: Class contains methods that are useful for getting all coordinates from a specific GeoJson geometry.
TurfMisc - Class in com.mapbox.turf: Class contains all the miscellaneous methods that Turf can perform.
TurfTransformation - Class in com.mapbox.turf: Methods in this class consume one GeoJSON object and output a new object with the defined parameters provided.

U

UNIT_CENTIMETERS - Static variable in class com.mapbox.turf.TurfConstants: A centimeter (American spelling) is a unit of length in the metric system, equal to one hundredth of a meter.
UNIT_CENTIMETRES - Static variable in class com.mapbox.turf.TurfConstants: A centimetre (international spelling) is a unit of length in the metric system, equal to one hundredth of a meter.
UNIT_DEFAULT - Static variable in class com.mapbox.turf.TurfConstants: The default unit used in most Turf methods when no other unit is specified is kilometers.
UNIT_DEGREES - Static variable in class com.mapbox.turf.TurfConstants: A degree, is a measurement of a plane angle, defined so that a full rotation is 360 degrees.
UNIT_FEET - Static variable in class com.mapbox.turf.TurfConstants: The foot is a unit of length in the imperial and US customary systems of measurement.
UNIT_INCHES - Static variable in class com.mapbox.turf.TurfConstants: The inch (abbreviation: in or ") is a unit of length in the (British) imperial and United States customary systems of measurement now formally equal to 1/36th yard but usually understood as 1/12th of a foot.
UNIT_KILOMETERS - Static variable in class com.mapbox.turf.TurfConstants: The kilometer (American spelling) is a unit of length in the metric system, equal to one thousand meters.
UNIT_KILOMETRES - Static variable in class com.mapbox.turf.TurfConstants: The kilometre (international spelling) is a unit of length in the metric system, equal to one thousand metres.
UNIT_METERS - Static variable in class com.mapbox.turf.TurfConstants: The metre (international spelling) or meter (American spelling) is the base unit of length in the International System of Units (SI).
UNIT_METRES - Static variable in class com.mapbox.turf.TurfConstants: The metre (international spelling) is the base unit of length in the International System of Units (SI).
UNIT_MILES - Static variable in class com.mapbox.turf.TurfConstants: The mile is an English unit of length of linear measure equal to 5,280 feet, or 1,760 yards, and standardised as exactly 1,609.344 meters by international agreement in 1959.
UNIT_NAUTICAL_MILES - Static variable in class com.mapbox.turf.TurfConstants: The nautical mile per hour is known as the knot.
UNIT_RADIANS - Static variable in class com.mapbox.turf.TurfConstants: The radian is the standard unit of angular measure, used in many areas of mathematics.
UNIT_YARDS - Static variable in class com.mapbox.turf.TurfConstants: The yard (abbreviation: yd) is an English unit of length, in both the British imperial and US customary systems of measurement, that comprises 3 feet or 36 inches.

V

verticalIntersection() - Method in class com.mapbox.turf.models.LineIntersectsResult: If the lines intersect, use this method to get the intersecting point Y value.
verticalIntersection(Double) - Method in class com.mapbox.turf.models.LineIntersectsResult.Builder: If the lines intersect, use this method to get the intersecting point Y value.

A B C D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form