Options
All
  • Public
  • Public/Protected
  • All
Menu

Very similar to the SearchProviderBase.

Hierarchy

Index

Constructors

constructor

Properties

app

isEnabled

isEnabled: boolean

libraryId

libraryId: string

pixelTolerance

pixelTolerance: number

polygonPixelTolerance

polygonPixelTolerance: number

Methods

Protected applyTolerance

  • applyTolerance(geometry: Geometry, pixelTolerance: number): Geometry
  • Creates a tolerance envelope around a point. Only applies to points; other geometries are returned as-is.

    Parameters

    • geometry: Geometry

      The geometry to create an envelope for.

    • pixelTolerance: number

      A positive integer that defines the maximum number of pixels away from the point geometry. Determines the width of the generated envelope.

    Returns Geometry

Abstract cancelSearch

  • cancelSearch(): void
  • Cancels the last search. May be called repeatedly.

    Returns void

getResource

  • getResource(resourceKey: string, locale?: string): string
  • Gets a language resource from the Application's resource dictionary, given a key, and optional locale. Returns null if the resource does not exist.

    Parameters

    • resourceKey: string
    • Optional locale: string

      The locale of the resource to fetch. Defaults to the current application locale.

    Returns string

Abstract initialize

  • initialize(config: any): void
  • Initialize the provider.

    Parameters

    • config: any

      The configuration object.

    Returns void

Abstract search

  • Performs the search. New implementations should return a promise to take advantage of 2.8 map tip enhancements, though methods that do not will still be supported

    Parameters

    Returns void | Promise<any>