Class SearchPreferences

Search preferences

Hierarchy

GemAutoreleaseObject
- SearchPreferences

Index

Constructors

Accessors

allowFuzzyResults easyAccessOnlyResults estimateMissingHouseNumbers exactMatch landmarks maxMatches overlays pointerId searchAddresses searchMapPOIs searchOnlyOnboard thresholdDistance

Methods

dispose registerAutoReleaseObject create

Constructors

constructor

new SearchPreferences(id: any): SearchPreferences
Internal
Parameters
- id: any
Returns SearchPreferences
Overrides GemAutoreleaseObject.constructor
- Defined in core/searchpreferences.ts:35

Accessors

allowFuzzyResults

get allowFuzzyResults(): boolean
Test if fuzzy search results are allowed

Default is true

Returns boolean
True if fuzzy search results are allowed, false otherwise

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:49
set allowFuzzyResults(value: boolean): void
Enable or disable the inclusion of fuzzy search results

Default is true
Parameters
- value: boolean
  True if fuzzy search results are allowed, false otherwise
Returns void
Throws
An exception if it fails
- Defined in core/searchpreferences.ts:62

easyAccessOnlyResults

get easyAccessOnlyResults(): boolean
Test if easy access filter is enabled

Default is false

Returns boolean
True if easy access filter is enabled, false otherwise

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:256
set easyAccessOnlyResults(value: boolean): void
Enable or disable the easy access filter for results

Default is false
Parameters
- value: boolean
  True if easy access filter is enabled, false otherwise
Returns void
Throws
An exception if it fails
- Defined in core/searchpreferences.ts:269

estimateMissingHouseNumbers

get estimateMissingHouseNumbers(): boolean
Test if estimating house numbers not present in map data is allowed

Default is true

Returns boolean
True if estimating house numbers not present in map data is allowed, false otherwise

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:74
set estimateMissingHouseNumbers(value: boolean): void
Enable or disable the estimation of house number results not found in map data

Default is true
Parameters
- value: boolean
  True if estimating house numbers not present in map data is allowed, false otherwise
Returns void
Throws
An exception if it fails
- Defined in core/searchpreferences.ts:91

exactMatch

get exactMatch(): boolean
Test if exact match is used.

Default is false.

Returns boolean
True if exact match is used, false otherwise

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:103
set exactMatch(value: boolean): void
Set/unset the exact match.

If set to true, only an exact match of free text search token is returned as result

Default is false.
Parameters
- value: boolean
  True if exact match is used, false otherwise
Returns void
Throws
An exception if it fails
- Defined in core/searchpreferences.ts:118

landmarks

get landmarks(): LandmarkStoreCollection
Get access to the search target landmark stores collection

Returns LandmarkStoreCollection
The landmark stores collection

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:279

maxMatches

get maxMatches(): number
Get the max number of matches.

Default is 40

Returns number
Max number of matches

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:130
set maxMatches(value: number): void
Set the max number of matches.

Default is 40
Parameters
- value: number
  Max number of matches
Returns void
Throws
An exception if it fails
- Defined in core/searchpreferences.ts:143

overlays

get overlays(): OverlayMutableCollection
Get access to the search target overlays collection

Returns OverlayMutableCollection
The overlays collection

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:290

pointerId

get pointerId(): any
Returns any
- Defined in core/searchpreferences.ts:30

searchAddresses

get searchAddresses(): boolean
Check if search through addresses is enabled.

Default is true.

Returns boolean
True if search through addresses is enabled, false otherwise

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:155
set searchAddresses(value: boolean): void
Enable or disable search through addresses.

Default is true
Parameters
- value: boolean
  True if search through addresses is enabled, false otherwise
Returns void
Throws
An exception if it fails
- Defined in core/searchpreferences.ts:168

searchMapPOIs

get searchMapPOIs(): boolean
Check if search through addresses is enabled.

Default is true

Returns boolean
True if search through map POIs is enabled, false otherwise

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:180
set searchMapPOIs(value: boolean): void
Enable or disable search through map POIs.

Default is true
Parameters
- value: boolean
  True if search through map POIs is enabled, false otherwise
Returns void
Throws
An exception if it fails
- Defined in core/searchpreferences.ts:193

searchOnlyOnboard

get searchOnlyOnboard(): boolean
Get the flag for onboard search.

Default is false

Returns boolean
True if the search will be done using only onboard data, false otherwise

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:205
set searchOnlyOnboard(value: boolean): void
Set the flag for onboard search.

If this flag is true then the search will be done using only onboard data. Default is false
Parameters
- value: boolean
Returns void
- Defined in core/searchpreferences.ts:216

thresholdDistance

get thresholdDistance(): number
Get the threshold distance for the request.

Default is the maximum value of int

Returns number
The threshold distance for the request

Throws
An exception if it fails
- Defined in core/searchpreferences.ts:228
set thresholdDistance(value: number): void
Set the threshold distance for the operation.

This may be used to control the reverse geocoding and search along route lookup area. When searching along route, the threshold is the result maximum distance from the target route When searching around position, the threshold is the result maximum distance from the reference point Default is the maximum value of int
Parameters
- value: number
  The threshold distance for the request
Returns void
Throws
An exception if it fails
- Defined in core/searchpreferences.ts:244

Methods

dispose

dispose(): void
Returns void
- Defined in core/searchpreferences.ts:330

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from GemAutoreleaseObject.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:24

`Static`create

create(
    __namedParameters?: {
        allowFuzzyResults?: boolean;
        easyAccessOnlyResults?: boolean;
        estimateMissingHouseNumbers?: boolean;
        exactMatch?: boolean;
        maxMatches?: number;
        searchAddresses?: boolean;
        searchMapPOIs?: boolean;
        searchOnlyOnboard?: boolean;
        thresholdDistance?: number;
    },
): SearchPreferences
Creates a new SearchPreferences instance with default or specified values
Parameters
- __namedParameters: {
      allowFuzzyResults?: boolean;
      easyAccessOnlyResults?: boolean;
      estimateMissingHouseNumbers?: boolean;
      exactMatch?: boolean;
      maxMatches?: number;
      searchAddresses?: boolean;
      searchMapPOIs?: boolean;
      searchOnlyOnboard?: boolean;
      thresholdDistance?: number;
  } = {}
Returns SearchPreferences
- Defined in core/searchpreferences.ts:298

Class SearchPreferences

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SearchPreferences

Accessors

allowFuzzyResults

Returns boolean

Throws

Parameters

Returns void

Throws

easyAccessOnlyResults

Returns boolean

Throws

Parameters

Returns void

Throws

estimateMissingHouseNumbers

Returns boolean

Throws

Parameters

Returns void

Throws

exactMatch

Returns boolean

Throws

Parameters

Returns void

Throws

landmarks

Returns LandmarkStoreCollection

Throws

maxMatches

Returns number

Throws

Parameters

Returns void

Throws

overlays

Returns OverlayMutableCollection

Throws

pointerId

Returns any

searchAddresses

Returns boolean

Throws

Parameters

Returns void

Throws

searchMapPOIs

Returns boolean

Throws

Parameters

Returns void

Throws

searchOnlyOnboard

Returns boolean

Throws

Parameters

Returns void

thresholdDistance

Returns number

Throws

Parameters

Returns void

Throws

Methods

dispose

Returns void

ProtectedregisterAutoReleaseObject

Parameters

Returns void

Staticcreate

Parameters

`Protected`registerAutoReleaseObject

`Static`create