MapLibre Native Android/org.maplibre.android.offline/OfflineTilePyramidRegionDefinition

OfflineTilePyramidRegionDefinition

class OfflineTilePyramidRegionDefinition : OfflineRegionDefinition

An offline region defined by a style URL, geographic bounding box, zoom range, and device pixel ratio.

Both minZoom and maxZoom must be ≥ 0, and maxZoom must be ≥ minZoom.

maxZoom may be ∞, in which case for each tile source, the region will include tiles from minZoom up to the maximum zoom level provided by that source.

pixelRatio must be ≥ 0 and should typically be 1.0 or 2.0.

if includeIdeographs is false, offline region will not include CJK glyphs

Constructors

OfflineTilePyramidRegionDefinition

constructor(styleURL: String?, bounds: LatLngBounds, minZoom: Double, maxZoom: Double, pixelRatio: Float)

Constructor to create an OfflineTilePyramidDefinition from parameters.

constructor(styleURL: String?, bounds: LatLngBounds, minZoom: Double, maxZoom: Double, pixelRatio: Float, includeIdeographs: Boolean)

Constructor to create an OfflineTilePyramidDefinition from parameters.

constructor(parcel: Parcel)

Constructor to create an OfflineTilePyramidDefinition from a Parcel.

Types

Companion

object Companion

Properties

bounds

open override val bounds: LatLngBounds?

Gets the bounds of the OfflineRegion.

includeIdeographs

open override var includeIdeographs: Boolean

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.

maxZoom

open override var maxZoom: Double

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

minZoom

open override var minZoom: Double

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

pixelRatio

open override var pixelRatio: Float

Gets the pixel ratio of the OfflineRegion map.

styleURL

open override var styleURL: String?

Returns the map style url of the OfflineRegion.