AbstractconstructorRest...args: [_properties?: InitializableBaseProperties]Protected Readonly_handlesReadonlyprovidersSearch providers that implement the search 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/search/SearchProvider!SearchProvider.isSupported).
Determines how a parent object should handle initialization failure in this object. The default is "warn".
"error": support/InitializeError!InitializeError is thrown."warn": Message is logged and
support/InitializableBase!InitializeWarningEvent is raised."ignore": support/InitializableBase!InitializeWarningEvent is
raised.Protected_getThe property keys and their metadata that are used to implement serializing and deserializing the class instance.
Protected_initializableCollections of child items to initialize. Items that fail to initialize are removed from the collection.
Protected_initializeProtected_onProtected_onCalled to perform initialization of the support/InitializableBase!InitializableBase. Subclasses should override this method rather than initialize() to perform custom initialization.
Protected_postProtected_toConverts the value to a PropertyDef object.
The value to convert.
Counts the number of features that match a search phrase in the given feature sources.
The feature sources to search.
The text to search for.
Optionaloptions: SearchOptionsOptions that affect the search.
An iterator of tasks/CountResult!CountResult containing count results. If the search is canceled, the returned iterator might end prematurely and reject with an instance of data/FeatureSet!FeatureSet, though it may still succeed and return all count results.
Counts the number of features that match a search phrase in the layers of the given mapping/MapExtension!MapExtension's associated map.
The map extension whose map will be searched.
The text to search for.
Optionaloptions: SearchOptionsOptions that affect the search.
An iterator of tasks/CountResult!CountResult containing count results. If the search is canceled, the returned iterator might end prematurely and reject with an instance of data/FeatureSet!FeatureSet, though it may still succeed and return all count results.
Counts the number of features that match a search phrase in the layers of the given map.
The map to search.
The text to search for.
Optionaloptions: SearchOptionsOptions that affect the search.
An iterator of tasks/CountResult!CountResult containing count results. If the search is canceled, the returned iterator might end prematurely and reject with an instance of data/FeatureSet!FeatureSet, though it may still succeed and return all count results.
Returns the serializable properties.
OptionalserializeMode: SerializeModeOptional. If specified, only properties that support the given serialization mode will be returned.
Determines whether this service is able to search the given source, i.e. Whether there is at least one registered provider for that source.
The source to check.
Searches the given feature sources for features that match a search phrase.
The feature sources to search.
The text to search for.
Optionaloptions: SearchOptionsOptions that affect the search.
An iterator of data/FeatureSet!FeatureSet containing search results. If the search 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.
Searches the layers of the given mapping/MapExtension!MapExtension's associated map for features that match a search phrase.
The map extension whose map will be searched.
The text to search for.
Optionaloptions: SearchOptionsOptions that affect the search.
An iterator of data/FeatureSet!FeatureSet containing search results. If the search is canceled, the returned iterator might end prematurely and reject with an instance of data/FeatureSet!FeatureSet, though it may still succeed and return all results.
Searches the layers of the given map for features that match a search phrase.
The map to search.
The text to search for.
Optionaloptions: SearchOptionsOptions that affect the search.
An iterator of data/FeatureSet!FeatureSet containing search results. If the search is canceled, the returned iterator might end prematurely and reject with an instance of data/FeatureSet!FeatureSet, though it may still succeed and return all results.
Provides search suggestions for the given feature sources.
The feature sources to use.
The text to provide suggestions for.
Optionaloptions: SearchOptionsOptions that affect the suggest operation.
An array of tasks/search/SearchSuggestion!SearchSuggestion containing suggest results. If the suggest is canceled, the returned promise may be rejected with an instance of data/FeatureSet!FeatureSet, but it may still succeed and return results.
Provides search suggestions for the layers of the given mapping/MapExtension!MapExtension's associated map.
The map extension that contains the map to use.
The text to provide suggestions for.
Optionaloptions: SearchOptionsOptions that affect the suggest operation.
An array of tasks/search/SearchSuggestion!SearchSuggestion containing suggest results. If the suggest is canceled, the returned promise may be rejected with an instance of data/FeatureSet!FeatureSet, but it may still succeed and return results.
Provides search suggestions for the layers of the given map.
The map to use.
The text to provide suggestions for.
Optionaloptions: SearchOptionsOptions that affect the suggest operation.
An array of tasks/search/SearchSuggestion!SearchSuggestion containing suggest results. If the suggest is canceled, the returned promise may be rejected with an instance of data/FeatureSet!FeatureSet, but it may still succeed and return results.
Allows searching for features by text phrase.