Class FeatureIndex

constructor

• new FeatureIndex(
      tileID: OverscaledTileID,
      promoteId?: PromoteIdSpecification | null,
  ): FeatureIndex

  Parameters

  • tileID: OverscaledTileID
  • OptionalpromoteId: PromoteIdSpecification | null

  Returns FeatureIndex

bucketLayerIDs

encoding

featureIndexArray

grid

grid3D

OptionalpromoteId

rawTileData

sourceLayerCoder

tileID

vtLayers

x

y

z

getId

• getId(feature: VectorTileFeatureLike, sourceLayerId: string): string | number

  Parameters

  • feature: VectorTileFeatureLike
  • sourceLayerId: string

  Returns string | number

hasLayer

• hasLayer(id: string): boolean

  Parameters

  • id: string

  Returns boolean

insert

• insert(
      feature: VectorTileFeatureLike,
      geometry: Point[][],
      featureIndex: number,
      sourceLayerIndex: number,
      bucketIndex: number,
      is3D?: boolean,
  ): void

  Parameters

  • feature: VectorTileFeatureLike
  • geometry: Point[][]
  • featureIndex: number
  • sourceLayerIndex: number
  • bucketIndex: number
  • Optionalis3D: boolean

  Returns void

loadMatchingFeature

• loadMatchingFeature(
      result: QueryResults,
      bucketIndex: number,
      sourceLayerIndex: number,
      featureIndex: number,
      filter: FeatureFilter,
      filterLayerIDs: Set<string> | undefined,
      availableImages: string[],
      styleLayers: { [_: string]: StyleLayer },
      serializedLayers: { [_: string]: any },
      sourceFeatureState?: SourceFeatureState,
      intersectionTest?: (
          feature: VectorTileFeatureLike,
          styleLayer: StyleLayer,
          featureState: any,
          id: string | number | void,
      ) => number | boolean,
  ): void

  Parameters

  • result: QueryResults
  • bucketIndex: number
  • sourceLayerIndex: number
  • featureIndex: number
  • filter: FeatureFilter
  • filterLayerIDs: Set<string> | undefined
  • availableImages: string[]
  • styleLayers: { [_: string]: StyleLayer }
  • serializedLayers: { [_: string]: any }
  • OptionalsourceFeatureState: SourceFeatureState
  • OptionalintersectionTest: (
        feature: VectorTileFeatureLike,
        styleLayer: StyleLayer,
        featureState: any,
        id: string | number | void,
    ) => number | boolean

  Returns void

loadVTLayers

• loadVTLayers(): { [_: string]: VectorTileLayerLike }

  Returns { [_: string]: VectorTileLayerLike }

lookupSymbolFeatures

• lookupSymbolFeatures(
      symbolFeatureIndexes: number[],
      serializedLayers: { [_: string]: StyleLayer },
      bucketIndex: number,
      sourceLayerIndex: number,
      filterParams: {
          filterSpec: FilterSpecification;
          globalState: Record<string, any>;
      },
      filterLayerIDs: Set<string> | null,
      availableImages: string[],
      styleLayers: { [_: string]: StyleLayer },
  ): QueryResults

  Parameters

  • symbolFeatureIndexes: number[]
  • serializedLayers: { [_: string]: StyleLayer }
  • bucketIndex: number
  • sourceLayerIndex: number
  • filterParams: { filterSpec: FilterSpecification; globalState: Record<string, any> }
  • filterLayerIDs: Set<string> | null
  • availableImages: string[]
  • styleLayers: { [_: string]: StyleLayer }

  Returns QueryResults

query

• query(
      args: QueryParameters,
      styleLayers: { [_: string]: StyleLayer },
      serializedLayers: { [_: string]: any },
      sourceFeatureState: SourceFeatureState,
  ): QueryResults

  Parameters

  • args: QueryParameters
  • styleLayers: { [_: string]: StyleLayer }
  • serializedLayers: { [_: string]: any }
  • sourceFeatureState: SourceFeatureState

  Returns QueryResults