com.mapbox.mapboxsdk.offline

Interface OfflineRegionDefinition

All Superinterfaces:

android.os.Parcelable

All Known Implementing Classes:

OfflineGeometryRegionDefinition, OfflineTilePyramidRegionDefinition

public interface OfflineRegionDefinition
extends android.os.Parcelable

This is the interface that all Offline Region definitions have to implement.

For the present, a tile pyramid is the only type of offline region.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
LatLngBounds	getBounds() Gets the bounds of the OfflineRegion.
boolean	getIncludeIdeographs() Specifies whether to include ideographic glyphs in downloaded font data.
double	getMaxZoom() Gets the maximum zoom level the OfflineRegion map can be displayed at.
double	getMinZoom() Gets the minimum zoom level the OfflineRegion map can be displayed at.
float	getPixelRatio() Gets the pixel ratio of the OfflineRegion map.
java.lang.String	getStyleURL() Returns the map style url of the OfflineRegion.
java.lang.String	getType() Gets the type of the OfflineRegionDefinition for telemetry ("tileregion", "shaperegion").

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Method Detail

getBounds

LatLngBounds getBounds()

Gets the bounds of the OfflineRegion.

Returns:

the bounds of the OfflineRegion.

getStyleURL

java.lang.String getStyleURL()

Returns the map style url of the OfflineRegion.

Returns:

The URL of the map style.

getMinZoom

double getMinZoom()

Gets the minimum zoom level the OfflineRegion map can be displayed at.

Returns:

The minimum zoom level.

getMaxZoom

double getMaxZoom()

Gets the maximum zoom level the OfflineRegion map can be displayed at.

Returns:

The maximum zoom level.

getPixelRatio

float getPixelRatio()

Gets the pixel ratio of the OfflineRegion map.

Returns:

The pixel ratio of the OfflineRegion map.

getIncludeIdeographs

boolean getIncludeIdeographs()

Specifies whether to include ideographic glyphs in downloaded font data. Ideographic glyphs make up the majority of downloaded font data, but it is possible to configure the renderer to use locally installed fonts instead of relying on fonts downloaded as part of the offline pack. Defaults to `true`

Returns:

true if offline region will include ideographic glyphs

See Also:

MapboxMapOptions.localIdeographFontFamily(String)

getType

java.lang.String getType()

Gets the type of the OfflineRegionDefinition for telemetry ("tileregion", "shaperegion").

Returns:

The type of the OfflineRegionDefinition.