On this page
Constructors
Properties
Methods

Class SymbolBucket

The Bucket interface is the single point of knowledge about turning vector tiles into WebGL buffers.

Bucket is an abstract interface. An implementation exists for each style layer type. Create a bucket via the StyleLayer.createBucket method.

The concrete bucket types, using layout options from the style layer, transform feature geometries into vertex and index data for use by the vertex shader. They also (via ProgramConfiguration) use feature properties and the zoom level to populate the attributes needed for data-driven styling.

Buckets are designed to be built on a worker thread and then serialized and transferred back to the main thread for rendering. On the worker side, a bucket's vertex, index, and attribute data is stored in bucket.arrays: ArrayGroup. When a bucket's data is serialized and sent back to the main thread, is gets deserialized (using new Bucket(serializedBucketData), with the array data now stored in bucket.buffers: BufferGroup. BufferGroups hold the same data as ArrayGroups, but are tuned for consumption by WebGL.

Implements

Index

Constructors

constructor

Properties

allowVerticalPlacement bucketInstanceId canOverlap collisionArrays collisionBoxArray collisionCircleArray compareText fadeStartTime features featureSortOrder glyphOffsetArray hasDependencies hasRTLText icon iconCollisionBox iconsInText iconSizeData iconsNeedLinear index justReloaded layerIds layers lineVertexArray overscaling pixelRatio sdfIcons sortedAngle sortFeaturesByKey sortFeaturesByY sortKeyRanges sourceID sourceLayerIndex stateDependentLayerIds stateDependentLayers symbolInstanceIndexes symbolInstances text textAnchorOffsets textCollisionBox textSizeData tilePixelRatio uploaded writingModes zoom addDynamicAttributes MAX_GLYPHS

Methods

addCollisionDebugVertices addDebugCollisionBoxes addIndicesForPlacedSymbol addSymbols addToLineVertexArray addToSortKeyRanges createArrays deserializeCollisionBoxes destroy destroyDebugData generateCollisionDebugBuffers getSortedSymbolIndexes hasDebugData hasIconCollisionBoxData hasIconData hasTextCollisionBoxData hasTextData isEmpty populate sortFeatures update upload uploadPending

Constructors

Properties

allowVerticalPlacement: boolean
bucketInstanceId: number
canOverlap: boolean
collisionArrays: CollisionArrays[]
collisionBoxArray: CollisionBoxArray
collisionCircleArray: number[]
compareText: { [_: string]: Point[] }
fadeStartTime: number
features: SymbolFeature[]
featureSortOrder: number[]
glyphOffsetArray: GlyphOffsetArray
hasDependencies: boolean
hasRTLText: boolean
icon: SymbolBuffers
iconCollisionBox: CollisionBuffers
iconsInText: boolean
iconSizeData: SizeData
iconsNeedLinear: boolean
index: number
justReloaded: boolean
layerIds: string[]
layers: SymbolStyleLayer[]
lineVertexArray: SymbolLineVertexArray
overscaling: number
pixelRatio: number
sdfIcons: boolean
sortedAngle: number
sortFeaturesByKey: boolean
sortFeaturesByY: boolean
sortKeyRanges: SortKeyRange[]
sourceID: string
sourceLayerIndex: number
stateDependentLayerIds: string[]
stateDependentLayers: SymbolStyleLayer[]
symbolInstanceIndexes: number[]
symbolInstances: SymbolInstanceArray

text

text: SymbolBuffers
textAnchorOffsets: TextAnchorOffsetArray
textCollisionBox: CollisionBuffers
textSizeData: SizeData
tilePixelRatio: number
uploaded: boolean
writingModes: WritingMode[]
zoom: number
addDynamicAttributes: (
    dynamicLayoutVertexArray: StructArray,
    p: Point,
    angle: number,
) => void
MAX_GLYPHS: number

Methods

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns { lineLength: number; lineStartIndex: number }

  • Parameters

    • symbolInstanceIndex: number
    • sortKey: number

    Returns void

  • Returns void

  • Release the WebGL resources associated with the buffers. Note that because buckets are shared between layers having the same layout properties, they must be destroyed in groups (all buckets for a tile, or all symbol buckets).

    Returns void

  • Returns void

  • Returns void

  • Parameters

    • angle: number

    Returns any[]

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Parameters

    • angle: number

    Returns void

Was this helpful?
SDK JS
Reference
SymbolBucket