Class Placement

constructor

• new Placement(
      transform: ITransform,
      terrain: Terrain,
      fadeDuration: number,
      crossSourceCollisions: boolean,
      prevPlacement?: Placement,
  ): Placement

  Parameters

  • transform: ITransform
  • terrain: Terrain
  • fadeDuration: number
  • crossSourceCollisions: boolean
  • OptionalprevPlacement: Placement

  Returns Placement

collisionBoxArrays

collisionCircleArrays

collisionGroups

collisionIndex

commitTime

fadeDuration

lastPlacementChangeTime

opacities

placedOrientations

placements

prevPlacement

prevZoomAdjustment

retainedQueryData

stale

terrain

transform

variableOffsets

zoomAtLastRecencyCheck

attemptAnchorPlacement

• attemptAnchorPlacement(
      textAnchorOffset: TextAnchorOffsetStruct,
      textBox: SingleCollisionBox,
      width: number,
      height: number,
      textBoxScale: number,
      rotateWithMap: boolean,
      pitchWithMap: boolean,
      textPixelRatio: number,
      tileID: OverscaledTileID,
      unwrappedTileID: any,
      collisionGroup: CollisionGroup,
      textOverlapMode: OverlapMode,
      symbolInstance: SymbolInstanceStruct,
      bucket: SymbolBucket,
      orientation: number,
      translationText: [number, number],
      translationIcon: [number, number],
      iconBox?: SingleCollisionBox | null,
      getElevation?: (x: number, y: number) => number,
      simpleProjectionMatrix?: mat4,
  ): { placedGlyphBoxes: PlacedBox; shift: Point }

  Parameters

  • textAnchorOffset: TextAnchorOffsetStruct
  • textBox: SingleCollisionBox
  • width: number
  • height: number
  • textBoxScale: number
  • rotateWithMap: boolean
  • pitchWithMap: boolean
  • textPixelRatio: number
  • tileID: OverscaledTileID
  • unwrappedTileID: any
  • collisionGroup: CollisionGroup
  • textOverlapMode: OverlapMode
  • symbolInstance: SymbolInstanceStruct
  • bucket: SymbolBucket
  • orientation: number
  • translationText: [number, number]
  • translationIcon: [number, number]
  • OptionaliconBox: SingleCollisionBox | null
  • OptionalgetElevation: (x: number, y: number) => number
  • OptionalsimpleProjectionMatrix: mat4

  Returns { placedGlyphBoxes: PlacedBox; shift: Point }

commit

• commit(now: number): void

  Parameters

  • now: number

  Returns void

getBucketParts

• getBucketParts(
      results: BucketPart[],
      styleLayer: StyleLayer,
      tile: Tile,
      sortAcrossTiles: boolean,
  ): void

  Parameters

  • results: BucketPart[]
  • styleLayer: StyleLayer
  • tile: Tile
  • sortAcrossTiles: boolean

  Returns void

hasTransitions

• hasTransitions(now: number): boolean

  Parameters

  • now: number

  Returns boolean

markUsedJustification

• markUsedJustification(
      bucket: SymbolBucket,
      placedAnchor:
          | "top"
          | "bottom"
          | "right"
          | "left"
          | "top-left"
          | "top-right"
          | "bottom-left"
          | "bottom-right"
          | "center",
      symbolInstance: SymbolInstanceStruct,
      orientation: number,
  ): void

  Parameters

  • bucket: SymbolBucket
  • placedAnchor:
        | "top"
        | "bottom"
        | "right"
        | "left"
        | "top-left"
        | "top-right"
        | "bottom-left"
        | "bottom-right"
        | "center"
  • symbolInstance: SymbolInstanceStruct
  • orientation: number

  Returns void

markUsedOrientation

• markUsedOrientation(
      bucket: SymbolBucket,
      orientation: number,
      symbolInstance: SymbolInstanceStruct,
  ): void

  Parameters

  • bucket: SymbolBucket
  • orientation: number
  • symbolInstance: SymbolInstanceStruct

  Returns void

placeLayerBucketPart

• placeLayerBucketPart(
      bucketPart: BucketPart,
      seenCrossTileIDs: { [key: string]: boolean; [key: number]: boolean },
      showCollisionBoxes: boolean,
  ): void

  Parameters

  • bucketPart: BucketPart
  • seenCrossTileIDs: { [key: string]: boolean; [key: number]: boolean }
  • showCollisionBoxes: boolean

  Returns void

setStale

• setStale(): void

  Returns void

stillRecent

• stillRecent(now: number, zoom: number): boolean

  Parameters

  • now: number
  • zoom: number

  Returns boolean

storeCollisionData

• storeCollisionData(
      bucketInstanceId: number,
      symbolIndex: number,
      collisionArrays: CollisionArrays,
      placedGlyphBoxes: PlacedBox,
      placedIconBoxes: PlacedBox,
      placedGlyphCircles: PlacedCircles,
  ): void

  Parameters

  • bucketInstanceId: number
  • symbolIndex: number
  • collisionArrays: CollisionArrays
  • placedGlyphBoxes: PlacedBox
  • placedIconBoxes: PlacedBox
  • placedGlyphCircles: PlacedCircles

  Returns void

symbolFadeChange

• symbolFadeChange(now: number): number

  Parameters

  • now: number

  Returns number

updateBucketOpacities

• updateBucketOpacities(
      bucket: SymbolBucket,
      tileID: OverscaledTileID,
      seenCrossTileIDs: { [key: string]: boolean; [key: number]: boolean },
      collisionBoxArray?: CollisionBoxArray | null,
  ): void

  Parameters

  • bucket: SymbolBucket
  • tileID: OverscaledTileID
  • seenCrossTileIDs: { [key: string]: boolean; [key: number]: boolean }
  • OptionalcollisionBoxArray: CollisionBoxArray | null

  Returns void

updateLayerOpacities

• updateLayerOpacities(styleLayer: StyleLayer, tiles: Tile[]): void

  Parameters

  • styleLayer: StyleLayer
  • tiles: Tile[]

  Returns void

zoomAdjustment

• zoomAdjustment(zoom: number): number

  Parameters

  • zoom: number

  Returns number