@magiclane/maps-sdk
↑↓ Navigate ⏎ Open Esc Close

Home > @magiclane/maps-sdk > SearchService > searchAlongRoute

SearchService.searchAlongRoute() method

Search for landmarks along the specified route.

Signature:

static searchAlongRoute(input: {
        route: Route;
        onCompleteCallback: (err: GemError, results: Landmark[]) => void;
        textFilter?: string;
        preferences?: SearchPreferences;
    }): TaskHandler | null;

Parameters

Parameter

Type

Description

{ route, onCompleteCallback, textFilter, preferences, }

(not declared)

input

{ route: Route; onCompleteCallback: (err: GemError, results: Landmark[]) => void; textFilter?: string; preferences?: SearchPreferences; }

input properties:

  • route: Route
  • onCompleteCallback: (err: GemError, results: Landmark[]) => void
  • Optional textFilter?: string
  • Optional preferences?: SearchPreferences

Returns:

TaskHandler | null

Associated TaskHandler for this operation if the search can be started otherwise null.

Exceptions

An exception if it fails.