For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
Class Tile
Index
Constructors
Properties
abortController
aborted
actor
buckets
collisionBoxArray
dashPositions
dem
demMatrix
demTexture
dependencies
etag?
expirationTime
expiredRequestCount
fadeEndTime
fadeOpacity
fadingDirection
fadingParentID
fadingRole
fbo
glyphAtlasImage
glyphAtlasTexture
hasRTLText
hasSymbolBuckets
imageAtlas
imageAtlasTexture
latestEncoding
latestFeatureIndex
latestRawTileData
needsHillshadePrepare
needsTerrainPrepare
neighboringTiles
placementSource
queryPadding
redoWhenDone
refreshedUponExpiration
reloadPromise
resourceTiming
rtt
rttFingerprint
selfFading
showCollisionBoxes
state
symbolFadeHoldUntil
texture
tileID
tileSize
timeAdded
uid
uses
vtLayers
Methods
clearSymbolFadeHold
clearTextures
getBucket
getExpiryTimeout
hasData
hasDependency
holdingForSymbolFade
isRenderable
loadVectorData
patternsLoaded
prepare
queryRenderedFeatures
querySourceFeatures
resetFadeLogic
setCrossFadeLogic
setDependencies
setExpiryData
setFeatureState
setSelfFadeLogic
setSymbolHoldDuration
symbolFadeFinished
unloadVectorData
upload
wasRequested
Constructors
constructor
-
Parameters
- tileID: OverscaledTileID
the tile ID
- size: number
The tile size
Returns Tile
- tileID: OverscaledTileID
Properties
abortController
abortController: AbortController
aborted
aborted: boolean
actor
buckets
collisionBoxArray
dashPositions
dem
demMatrix
demTexture
dependencies
dependencies: any
Optionaletag
etag?: string
expirationTime
expirationTime: any
expiredRequestCount
expiredRequestCount: number
fadeEndTime
fadeEndTime: number
fadeOpacity
fadeOpacity: number
fadingDirection
fadingParentID
fadingRole
fbo
glyphAtlasImage
glyphAtlasTexture
hasRTLText
hasRTLText: boolean
hasSymbolBuckets
hasSymbolBuckets: boolean
imageAtlas
imageAtlasTexture
latestEncoding
latestEncoding: string
latestFeatureIndex
latestRawTileData
latestRawTileData: ArrayBuffer
needsHillshadePrepare
needsHillshadePrepare: boolean
needsTerrainPrepare
needsTerrainPrepare: boolean
neighboringTiles
placementSource
placementSource: any
queryPadding
queryPadding: number
redoWhenDone
redoWhenDone: boolean
refreshedUponExpiration
refreshedUponExpiration: boolean
reloadPromise
reloadPromise: { reject: () => void; resolve: () => void }
resourceTiming
resourceTiming: PerformanceResourceTiming[]
rtt
rtt: { id: number; stamp: number }[]
rttFingerprint
rttFingerprint: { [sourceId: string]: string }
selfFading
selfFading: boolean
showCollisionBoxes
showCollisionBoxes: boolean
state
symbolFadeHoldUntil
symbolFadeHoldUntil: number
texture
texture: any
tileID
tileSize
tileSize: number
timeAdded
timeAdded: number
uid
uid: number
uses
uses: number
vtLayers
Methods
clearSymbolFadeHold
-
Returns void
clearTextures
-
Parameters
- painter: any
Returns void
getBucket
-
Parameters
- layer: StyleLayer
Returns Bucket
getExpiryTimeout
-
Returns number
hasData
-
Returns boolean
hasDependency
-
Parameters
- namespaces: string[]
- keys: string[]
Returns boolean
holdingForSymbolFade
-
Returns boolean
isRenderable
-
Parameters
- symbolLayer: boolean
Returns boolean
loadVectorData
-
Given a data object with a 'buffers' property, load it into this tile's elementGroups and buffers properties and set loaded to true. If the data is null, like in the case of an empty GeoJSON tile, no-op but still set loaded to true.
Parameters
- data: WorkerTileResult
The data from the worker
- painter: Painter
the painter
OptionaljustReloaded: boolean | nulltrueto just reload
Returns void
- data: WorkerTileResult
patternsLoaded
-
Returns boolean
prepare
-
Parameters
- imageManager: ImageManager
Returns void
queryRenderedFeatures
-
queryRenderedFeatures(
layers: { [_: string]: StyleLayer },
serializedLayers: { [_: string]: any },
sourceFeatureState: SourceFeatureState,
queryGeometry: Point[],
cameraQueryGeometry: Point[],
scale: number,
params:
| Pick<
QueryRenderedFeaturesOptionsStrict,
"filter"
| "layers"
| "availableImages",
>
| undefined,
transform: IReadonlyTransform,
maxPitchScaleFactor: number,
pixelPosMatrix: mat4,
getElevation: ((x: number, y: number) => number) | undefined,
): QueryResultsParameters
- layers: { [_: string]: StyleLayer }
- serializedLayers: { [_: string]: any }
- sourceFeatureState: SourceFeatureState
- queryGeometry: Point[]
- cameraQueryGeometry: Point[]
- scale: number
- params:
| Pick<
QueryRenderedFeaturesOptionsStrict,
"filter"
| "layers"
| "availableImages",
>
| undefined - transform: IReadonlyTransform
- maxPitchScaleFactor: number
- pixelPosMatrix: mat4
- getElevation: ((x: number, y: number) => number) | undefined
Returns QueryResults
querySourceFeatures
-
Parameters
- result: GeoJSONFeature[]
Optionalparams: QuerySourceFeatureOptionsStrict
Returns void
resetFadeLogic
-
Returns void
setCrossFadeLogic
-
Parameters
- __namedParameters: CrossFadeArgs
Returns void
setDependencies
-
Parameters
- namespace: string
- dependencies: string[]
Returns void
setExpiryData
-
Parameters
- data: ExpiryData
Returns void
setFeatureState
-
Parameters
- states: LayerFeatureStates
- painter: any
Returns void
setSelfFadeLogic
-
Self fading for edge tiles (when panning map)
Parameters
- fadeEndTime: number
Returns void
setSymbolHoldDuration
-
Parameters
- duration: number
Returns void
symbolFadeFinished
-
Returns boolean
unloadVectorData
-
Release any data or WebGL resources referenced by this tile.
Returns void
upload
-
Parameters
- context: Context
Returns void
wasRequested
-
Returns boolean
A tile object is the combination of a Coordinate, which defines its place, as well as a unique ID and data tracking for its content