Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OptionalSearchParameters

OptionalSearchParameters serves as a data class holding location parameters for image search

Hierarchy

  • OptionalSearchParameters

Index

Constructors

constructor

  • new OptionalSearchParameters(searchRegion?: Region, confidence?: undefined | number, searchMultipleScales?: undefined | false | true, abort?: AbortSignal): OptionalSearchParameters
  • OptionalSearchParameters class constructor

    Parameters

    • Optional searchRegion: Region

      Optional Region to limit the search space to

    • Optional confidence: undefined | number

      Optional confidence value to configure image match confidence

    • Optional searchMultipleScales: undefined | false | true

      Optional flag to indicate if the search should be conducted at different scales

    • Optional abort: AbortSignal

      An {@link AbortSignal} to cancel an ongoing call to waitFor

    Returns OptionalSearchParameters

Properties

Optional abort

abort: AbortSignal

An {@link AbortSignal} to cancel an ongoing call to waitFor

Optional confidence

confidence: undefined | number

Optional confidence value to configure image match confidence

Optional searchMultipleScales

searchMultipleScales: undefined | false | true

Optional flag to indicate if the search should be conducted at different scales

Optional searchRegion

searchRegion: Region

Optional Region to limit the search space to