com.mapbox.mapboxsdk.style.sources

Class CustomGeometrySource

java.lang.Object

com.mapbox.mapboxsdk.style.sources.Source

com.mapbox.mapboxsdk.style.sources.CustomGeometrySource

public class CustomGeometrySource
extends Source

Custom Vector Source, allows using FeatureCollections.

CustomGeometrySource uses a coalescing model for frequent data updates targeting the same tile id, which means, that the in-progress request as well as the last scheduled request are guaranteed to finish. Any requests scheduled meanwhile can be canceled.

Field Summary

Fields

Modifier and Type	Field and Description
static int	THREAD_POOL_LIMIT
static java.lang.String	THREAD_PREFIX

Fields inherited from class com.mapbox.mapboxsdk.style.sources.Source

detached

Constructor Summary

Constructors

Constructor and Description
CustomGeometrySource(java.lang.String id, CustomGeometrySourceOptions options, GeometryTileProvider provider) Create a CustomGeometrySource with non-default CustomGeometrySourceOptions.
CustomGeometrySource(java.lang.String id, GeometryTileProvider provider) Create a CustomGeometrySource

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
protected void	initialize(java.lang.String sourceId, java.lang.Object options)
void	invalidateRegion(LatLngBounds bounds) Invalidate previously provided features within a given bounds at all zoom levels.
void	invalidateTile(int zoomLevel, int x, int y) Invalidate the geometry contents of a specific tile.
java.util.List<com.mapbox.geojson.Feature>	querySourceFeatures(Expression filter) Queries the source for features.
void	setTileData(int zoomLevel, int x, int y, com.mapbox.geojson.FeatureCollection data) Set or update geometry contents of a specific tile.

Methods inherited from class com.mapbox.mapboxsdk.style.sources.Source

checkThread, getAttribution, getId, getMaxOverscaleFactorForParentTiles, getMinimumTileUpdateInterval, getNativePtr, getPrefetchZoomDelta, isVolatile, nativeGetAttribution, nativeGetId, nativeGetMaxOverscaleFactorForParentTiles, nativeGetMinimumTileUpdateInterval, nativeGetPrefetchZoomDelta, nativeIsVolatile, nativeSetMaxOverscaleFactorForParentTiles, nativeSetMinimumTileUpdateInterval, nativeSetPrefetchZoomDelta, nativeSetVolatile, setDetached, setMaxOverscaleFactorForParentTiles, setMinimumTileUpdateInterval, setPrefetchZoomDelta, setVolatile

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

THREAD_PREFIX

public static final java.lang.String THREAD_PREFIX

See Also:

Constant Field Values

THREAD_POOL_LIMIT

public static final int THREAD_POOL_LIMIT

See Also:

Constant Field Values

Constructor Detail

CustomGeometrySource

@UiThread
public CustomGeometrySource(java.lang.String id,
                                      GeometryTileProvider provider)

Create a CustomGeometrySource

Parameters:

id - The source id.

provider - The tile provider that returns geometry data for this source.

CustomGeometrySource

@UiThread
public CustomGeometrySource(java.lang.String id,
                                      CustomGeometrySourceOptions options,
                                      GeometryTileProvider provider)

Create a CustomGeometrySource with non-default CustomGeometrySourceOptions.

Parameters:

id - The source id.

options - CustomGeometrySourceOptions.

provider - The tile provider that returns geometry data for this source.

Method Detail

invalidateRegion

public void invalidateRegion(LatLngBounds bounds)

Invalidate previously provided features within a given bounds at all zoom levels. Invoking this method will result in new requests to `GeometryTileProvider` for regions that contain, include, or intersect with the provided bounds.

Parameters:

bounds - The region in which features should be invalidated at all zoom levels

invalidateTile

public void invalidateTile(int zoomLevel,
                           int x,
                           int y)

Invalidate the geometry contents of a specific tile. Invoking this method will result in new requests to `GeometryTileProvider` for visible tiles.

Parameters:

zoomLevel - Tile zoom level.

x - Tile X coordinate.

y - Tile Y coordinate.

setTileData

public void setTileData(int zoomLevel,
                        int x,
                        int y,
                        com.mapbox.geojson.FeatureCollection data)

Set or update geometry contents of a specific tile. Use this method to update tiles for which `GeometryTileProvider` was previously invoked. This method can be called from background threads.

Parameters:

zoomLevel - Tile zoom level.

x - Tile X coordinate.

y - Tile Y coordinate.

data - Feature collection for the tile.

querySourceFeatures

@NonNull
public java.util.List<com.mapbox.geojson.Feature> querySourceFeatures(@Nullable
                                                                               Expression filter)

Queries the source for features.

Parameters:

filter - an optional filter expression to filter the returned Features

Returns:

the features

initialize

protected void initialize(java.lang.String sourceId,
                          java.lang.Object options)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable