diff options
Diffstat (limited to 'platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/GeoJsonOptions.java')
-rw-r--r-- | platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/GeoJsonOptions.java | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/GeoJsonOptions.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/GeoJsonOptions.java index d7a9282371..55a9799cb7 100644 --- a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/GeoJsonOptions.java +++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/sources/GeoJsonOptions.java @@ -3,13 +3,17 @@ package com.mapbox.mapboxsdk.style.sources; import java.util.HashMap; /** - * Options for the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">GeoJsonSource</a> + * Options for the {@link GeoJsonSource} + * + * @see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-geojson">The online documentation</a> */ public class GeoJsonOptions extends HashMap<String, Object> { /** - * Defaults to 18. * Maximum zoom level at which to create vector tiles (higher means greater detail at high zoom levels). + * + * @param maxZoom the maximum zoom - Defaults to 18. + * @return the current instance for chaining */ public GeoJsonOptions withMaxZoom(int maxZoom) { this.put("maxzoom", maxZoom); @@ -17,8 +21,10 @@ public class GeoJsonOptions extends HashMap<String, Object> { } /** - * Defaults to 128. * Tile buffer size on each side (measured in 1/512ths of a tile; higher means fewer rendering artifacts near tile edges but slower performance). + * + * @param buffer the buffer size - Defaults to 128. + * @return the current instance for chaining */ public GeoJsonOptions withBuffer(int buffer) { this.put("buffer", buffer); @@ -26,8 +32,10 @@ public class GeoJsonOptions extends HashMap<String, Object> { } /** - * Defaults to 0.375. * Douglas-Peucker simplification tolerance (higher means simpler geometries and faster performance). + * + * @param tolerance the tolerance - Defaults to 0.375 + * @return the current instance for chaining */ public GeoJsonOptions withTolerance(float tolerance) { this.put("tolerance", tolerance); @@ -35,8 +43,10 @@ public class GeoJsonOptions extends HashMap<String, Object> { } /** - * Defaults to false. * If the data is a collection of point features, setting this to true clusters the points by radius into groups. + * + * @param cluster cluster? - Defaults to false + * @return the current instance for chaining */ public GeoJsonOptions withCluster(boolean cluster) { this.put("cluster", cluster); @@ -44,8 +54,10 @@ public class GeoJsonOptions extends HashMap<String, Object> { } /** - * Defaults to 50. - * Radius of each cluster when clustering points, measured in 1/512ths of a tile. + * Max zoom to cluster points on. + * + * @param clusterMaxZoom clusterMaxZoom cluster maximum zoom - Defaults to one zoom less than maxzoom (so that last zoom features are not clustered) + * @return the current instance for chaining */ public GeoJsonOptions withClusterMaxZoom(int clusterMaxZoom) { this.put("clusterMaxZoom", clusterMaxZoom); @@ -53,7 +65,10 @@ public class GeoJsonOptions extends HashMap<String, Object> { } /** - * Max zoom to cluster points on. Defaults to one zoom less than maxzoom (so that last zoom features are not clustered). + * Radius of each cluster when clustering points, measured in 1/512ths of a tile. + * + * @param clusterRadius cluster radius - Defaults to 50 + * @return the current instance for chaining */ public GeoJsonOptions withClusterRadius(int clusterRadius) { this.put("clusterRadius", clusterRadius); |