Allows identifying features by geometry.

Hierarchy (view full)

Constructors

Properties

_handles: Handles<unknown, ResourceHandle>

Do not directly reference this property. Use EventNames and EventTypes helpers from @arcgis/core/Evented.

providers: Collection<IdentifyProvider> = ...

Providers that implement the identify functionality. The collection is initially populated with built-in Geocortex providers, however providers can be added or removed. The order is significant -- the first registered provider that is able to handle a given data/FeatureSource!FeatureSource will be used for that source (see tasks/identify/IdentifyProvider!IdentifyProvider.isSupported).

Accessors

Methods

  • Called to perform cleanup. Subclasses should override this method rather than destroy() to perform custom cleanup.

    Returns Promise<void>

  • Called after normal initialization. Note: Child items are initialized before this is called.

    Returns Promise<void>

  • Counts the features that intersect a given geometry.

    Parameters

    • sources: Iterable<FeatureSource, any, any> | Collection<FeatureSource>

      The feature sources to identify.

    • geometry: GeometryUnion

      The geometry to match.

    • Optionaloptions: IdentifyOptions

      Options that affect the identify operation.

    Returns AsyncIterable<CountResult, any, any>

    An iterator of tasks/CountResult!CountResult containing count results. If the operation is canceled, the returned iterator might end prematurely and reject with an instance of support/Cancellable!Cancellation, though it may still succeed and return all count results.

  • Count the features that intersect a given geometry.

    Parameters

    • mapExtension: MapExtension

      The extension of the map to identify.

    • geometry: GeometryUnion

      The geometry to match.

    • Optionaloptions: IdentifyOptions

      Options that affect the identify operation.

    Returns AsyncIterable<CountResult, any, any>

    An iterator of tasks/CountResult!CountResult containing count results. If the operation is canceled, the returned iterator might end prematurely and reject with an instance of support/Cancellable!Cancellation, though it may still succeed and return all count results.

  • Count the features that intersect a given geometry.

    Parameters

    • map: Map

      The map to identify.

    • geometry: GeometryUnion

      The geometry to match.

    • Optionaloptions: IdentifyOptions

      Options that affect the identify operation.

    Returns AsyncIterable<CountResult, any, any>

    An iterator of tasks/CountResult!CountResult containing count results. If the operation is canceled, the returned iterator might end prematurely and reject with an instance of support/Cancellable!Cancellation, though it may still succeed and return all count results.

  • A clean-up function that should get called whenever the item is disposed of.

    Returns Promise<void>

  • Identifies features that intersect a given geometry.

    Parameters

    • sources: Iterable<FeatureSource, any, any> | Collection<FeatureSource>

      The feature sources to identify.

    • geometry: GeometryUnion | GeometryUnion[]

      The geometry to match.

    • Optionaloptions: IdentifyOptions

      Options that affect the identify operation.

    Returns AsyncIterable<Feature, any, any>

    An iterator of data/FeatureSet!FeatureSet containing identify results. If the operation is canceled, the returned iterator might end prematurely and reject with an instance of support/Cancellable!Cancellation, though it may still succeed and return all results.

  • Identifies features that intersect a given geometry.

    Parameters

    • mapExtension: MapExtension

      The extension of the map to identify.

    • geometry: GeometryUnion | GeometryUnion[]

      The geometry to match.

    • Optionaloptions: IdentifyOptions

      Options that affect the identify operation.

    Returns AsyncIterable<Feature, any, any>

    An iterator of data/FeatureSet!FeatureSet containing identify results. If the operation is canceled, the returned iterator might end prematurely and reject with an instance of support/Cancellable!Cancellation, though it may still succeed and return all results.

  • Identifies features that intersect a given geometry.

    Parameters

    • map: Map

      The map to identify.

    • geometry: GeometryUnion | GeometryUnion[]

      The geometry to match.

    • Optionaloptions: IdentifyOptions

      Options that affect the identify operation.

    Returns AsyncIterable<Feature, any, any>

    An iterator of data/FeatureSet!FeatureSet containing identify results. If the operation is canceled, the returned iterator might end prematurely and reject with an instance of support/Cancellable!Cancellation, though it may still succeed and return all results.

  • Determines whether this service supports identify operations for the given source, i.e. whether there is at least one registered provider for that source.

    Parameters

    • source: FeatureSource

      The source to check.

    • geometry: GeometryUnion

      The geometry to check.

    • Optionaloptions: IdentifyOptions

      The options to check.

    Returns boolean