dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

SearchViewModel Class

Provides the logic for the Search widget, which performs search
operations on locator service(s),
map/feature service feature
layer(s), and/or table(s).
ArcGIS Maps SDK for JavaScript

public class SearchViewModel : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IGoTo

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 SearchViewModel

Implements IGoTo

Constructors

SearchViewModel() Constructor

Parameterless constructor for use as a Razor Component.

public SearchViewModel();

SearchViewModel(Nullable, string, Nullable, Nullable, Nullable, PopupTemplate, SearchViewModelDefaultSymbols, GoToOverride, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, PopupTemplate, Portal, Nullable, Nullable, Nullable, string, IReadOnlyList, Nullable, Nullable, Nullable, Func) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public SearchViewModel(System.Nullable<int> activeSourceIndex=null, string? allPlaceholder=null, System.Nullable<bool> autoNavigate=null, System.Nullable<bool> autoSelect=null, System.Nullable<bool> boolIncludeDefaultSources=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? defaultPopupTemplate=null, dymaptic.GeoBlazor.Core.Components.Symbols.SearchViewModelDefaultSymbols? defaultSymbols=null, dymaptic.GeoBlazor.Core.Functions.GoToOverride? goToOverride=null, System.Nullable<bool> locationEnabled=null, System.Nullable<double> maxInputLength=null, System.Nullable<double> maxResults=null, System.Nullable<double> maxSuggestions=null, System.Nullable<double> minSuggestCharacters=null, System.Nullable<bool> popupEnabled=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? popupTemplate=null, dymaptic.GeoBlazor.Core.Components.Portal? portal=null, System.Nullable<int> resultCount=null, System.Nullable<bool> resultGraphicEnabled=null, System.Nullable<bool> searchAllEnabled=null, string? searchTerm=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchSource>? sources=null, System.Nullable<int> suggestionCount=null, System.Nullable<double> suggestionDelay=null, System.Nullable<bool> suggestionsEnabled=null, System.Func<System.Threading.Tasks.Task>? taskCollectionIncludeDefaultSources=null);

Parameters

activeSourceIndex System.Nullable<System.Int32>

The selected source’s index.
default 0
ArcGIS Maps SDK for JavaScript

allPlaceholder System.String

String value used as a hint for input text when searching on multiple sources.
default “Find address or place”
ArcGIS Maps SDK for JavaScript

autoNavigate System.Nullable<System.Boolean>

Indicates whether to automatically navigate to the selected result.
ArcGIS Maps SDK for JavaScript

autoSelect System.Nullable<System.Boolean>

Indicates whether to automatically select and zoom to the first geocoded result.
default true
ArcGIS Maps SDK for JavaScript

boolIncludeDefaultSources System.Nullable<System.Boolean>

Indicates whether or not to include defaultSources in the Search UI.
default true
ArcGIS Maps SDK for JavaScript

defaultPopupTemplate PopupTemplate

The default popupTemplate.
ArcGIS Maps SDK for JavaScript

defaultSymbols SearchViewModelDefaultSymbols

The default symbol(s) for the search result.
ArcGIS Maps SDK for JavaScript

goToOverride GoToOverride(GoToOverrideParameters)

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
ArcGIS Maps SDK for JavaScript

locationEnabled System.Nullable<System.Boolean>

Indicates whether location services are enabled within the widget.
ArcGIS Maps SDK for JavaScript

maxInputLength System.Nullable<System.Double>

The maximum character length of the search text.
default 128
ArcGIS Maps SDK for JavaScript

maxResults System.Nullable<System.Double>

The maximum number of results returned by the widget if not specified by the source.
default 6
ArcGIS Maps SDK for JavaScript

maxSuggestions System.Nullable<System.Double>

The maximum number of suggestions returned by the widget if not specified by the source.
default 6
ArcGIS Maps SDK for JavaScript

minSuggestCharacters System.Nullable<System.Double>

The minimum number of characters needed for the search if not specified by the source.
default 1
ArcGIS Maps SDK for JavaScript

popupEnabled System.Nullable<System.Boolean>

Indicates whether to display the Popup on feature click.
default true
ArcGIS Maps SDK for JavaScript

popupTemplate PopupTemplate

A customized PopupTemplate for the selected feature.
default null
ArcGIS Maps SDK for JavaScript

portal Portal

It is possible to search a specified portal instance’s locator services
Use this property to set this ArcGIS Portal instance to search.
ArcGIS Maps SDK for JavaScript

resultCount System.Nullable<System.Int32>

The number of results found in the search.
ArcGIS Maps SDK for JavaScript

resultGraphicEnabled System.Nullable<System.Boolean>

Indicates if the resultGraphic will display at the
location of the selected feature.
default true
ArcGIS Maps SDK for JavaScript

searchAllEnabled System.Nullable<System.Boolean>

Indicates whether to display the option to search all sources.
default true
ArcGIS Maps SDK for JavaScript

searchTerm System.String

The value of the search box input text string.
ArcGIS Maps SDK for JavaScript

sources System.Collections.Generic.IReadOnlyList<SearchSource>

The Search widget may be used to search features in a
FeatureLayer or table,
or geocode locations with a locator.
ArcGIS Maps SDK for JavaScript

suggestionCount System.Nullable<System.Int32>

The number of suggestions found for the search.
ArcGIS Maps SDK for JavaScript

suggestionDelay System.Nullable<System.Double>

The millisecond delay after keyup and before making a suggest network request.
default 350
ArcGIS Maps SDK for JavaScript

suggestionsEnabled System.Nullable<System.Boolean>

Enable suggestions for the widget.
default true
ArcGIS Maps SDK for JavaScript

taskCollectionIncludeDefaultSources System.Func<System.Threading.Tasks.Task>

Indicates whether or not to include defaultSources in the Search UI.
default true
ArcGIS Maps SDK for JavaScript

Properties

SearchViewModel.ActiveSource Property

The source object currently selected.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.SearchSource? ActiveSource { get; set; }

Property Value

SearchSource

SearchViewModel.ActiveSourceIndex Property

The selected source’s index.
default 0
ArcGIS Maps SDK for JavaScript

public System.Nullable<int> ActiveSourceIndex { get; set; }

Property Value

System.Nullable<System.Int32>

SearchViewModel.AllPlaceholder Property

String value used as a hint for input text when searching on multiple sources.
default “Find address or place”
ArcGIS Maps SDK for JavaScript

public string? AllPlaceholder { get; set; }

Property Value

System.String

SearchViewModel.AllSources Property

The combined collection of defaultSources
and sources.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchSource>? AllSources { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<SearchSource>

SearchViewModel.AutoNavigate Property

Indicates whether to automatically navigate to the selected result.
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> AutoNavigate { get; set; }

Property Value

System.Nullable<System.Boolean>

SearchViewModel.AutoSelect Property

Indicates whether to automatically select and zoom to the first geocoded result.
default true
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> AutoSelect { get; set; }

Property Value

System.Nullable<System.Boolean>

SearchViewModel.BoolIncludeDefaultSources Property

Indicates whether or not to include defaultSources in the Search UI.
default true
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> BoolIncludeDefaultSources { get; set; }

Property Value

System.Nullable<System.Boolean>

SearchViewModel.DefaultPopupTemplate Property

The default popupTemplate.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? DefaultPopupTemplate { get; set; }

Property Value

PopupTemplate

SearchViewModel.DefaultSources Property

A read-only property that is a Collection
of LayerSearchSource
and/or LocatorSearchSource.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchSource>? DefaultSources { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<SearchSource>

SearchViewModel.DefaultSymbols Property

The default symbol(s) for the search result.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Symbols.SearchViewModelDefaultSymbols? DefaultSymbols { get; set; }

Property Value

SearchViewModelDefaultSymbols

SearchViewModel.GoToOverride Property

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Functions.GoToOverride? GoToOverride { get; set; }

Implements GoToOverride

Property Value

GoToOverride(GoToOverrideParameters)

SearchViewModel.HasGoToOverride Property

A convenience property that signifies whether a custom GoToOverride function was registered.

public bool HasGoToOverride { get; }

Implements HasGoToOverride

Property Value

System.Boolean

SearchViewModel.HasSearchClearListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasSearchClearListener { get; }

Property Value

System.Boolean

SearchViewModel.HasSearchCompleteListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasSearchCompleteListener { get; }

Property Value

System.Boolean

SearchViewModel.HasSearchStartListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasSearchStartListener { get; }

Property Value

System.Boolean

SearchViewModel.HasSelectResultListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasSelectResultListener { get; }

Property Value

System.Boolean

SearchViewModel.HasSuggestCompleteListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasSuggestCompleteListener { get; }

Property Value

System.Boolean

SearchViewModel.HasSuggestStartListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasSuggestStartListener { get; }

Property Value

System.Boolean

SearchViewModel.LocationEnabled Property

Indicates whether location services are enabled within the widget.
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> LocationEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

SearchViewModel.MaxInputLength Property

The maximum character length of the search text.
default 128
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> MaxInputLength { get; set; }

Property Value

System.Nullable<System.Double>

SearchViewModel.MaxResults Property

The maximum number of results returned by the widget if not specified by the source.
default 6
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> MaxResults { get; set; }

Property Value

System.Nullable<System.Double>

SearchViewModel.MaxSuggestions Property

The maximum number of suggestions returned by the widget if not specified by the source.
default 6
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> MaxSuggestions { get; set; }

Property Value

System.Nullable<System.Double>

SearchViewModel.MinSuggestCharacters Property

The minimum number of characters needed for the search if not specified by the source.
default 1
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> MinSuggestCharacters { get; set; }

Property Value

System.Nullable<System.Double>

SearchViewModel.OnSearchClear Property

Fires when a result is cleared from the input box or a new result is selected.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchViewModelSearchClearEvent> OnSearchClear { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<SearchViewModelSearchClearEvent>

SearchViewModel.OnSearchComplete Property

Fires when the search() method is called and returns its results.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchViewModelSearchCompleteEvent> OnSearchComplete { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<SearchViewModelSearchCompleteEvent>

SearchViewModel.OnSearchStart Property

Fires when the search() method starts.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchViewModelSearchStartEvent> OnSearchStart { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<SearchViewModelSearchStartEvent>

SearchViewModel.OnSelectResult Property

Fires when a search result is selected.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchViewModelSelectResultEvent> OnSelectResult { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<SearchViewModelSelectResultEvent>

SearchViewModel.OnSuggestComplete Property

Fires when the suggest method is called and returns its results.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchViewModelSuggestCompleteEvent> OnSuggestComplete { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<SearchViewModelSuggestCompleteEvent>

SearchViewModel.OnSuggestStart Property

Fires when the suggest() method starts.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchViewModelSuggestStartEvent> OnSuggestStart { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<SearchViewModelSuggestStartEvent>

SearchViewModel.Placeholder Property

The placeholder used by the activeSource.
ArcGIS Maps SDK for JavaScript

public string? Placeholder { get; set; }

Property Value

System.String

SearchViewModel.PopupEnabled Property

Indicates whether to display the Popup on feature click.
default true
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> PopupEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

SearchViewModel.PopupTemplate Property

A customized PopupTemplate for the selected feature.
default null
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? PopupTemplate { get; set; }

Property Value

PopupTemplate

SearchViewModel.Portal Property

It is possible to search a specified portal instance’s locator services
Use this property to set this ArcGIS Portal instance to search.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Portal? Portal { get; set; }

Property Value

Portal

SearchViewModel.ResultCount Property

The number of results found in the search.
ArcGIS Maps SDK for JavaScript

public System.Nullable<int> ResultCount { get; set; }

Property Value

System.Nullable<System.Int32>

SearchViewModel.ResultGraphic Property

The graphic used to highlight the resulting feature or location.
default null
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Graphic? ResultGraphic { get; set; }

Property Value

Graphic

SearchViewModel.ResultGraphicEnabled Property

Indicates if the resultGraphic will display at the
location of the selected feature.
default true
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> ResultGraphicEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

SearchViewModel.Results Property

An array of current results from the search.
default null
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Results.SearchResultResponse>? Results { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<SearchResultResponse>

SearchViewModel.SearchAllEnabled Property

Indicates whether to display the option to search all sources.
default true
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> SearchAllEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

SearchViewModel.SearchTerm Property

The value of the search box input text string.
ArcGIS Maps SDK for JavaScript

public string? SearchTerm { get; set; }

Property Value

System.String

SearchViewModel.SelectedResult Property

The result selected from a search.
default null
ArcGIS Maps SDK for JavaScript

public string? SelectedResult { get; set; }

Property Value

System.String

SearchViewModel.SelectedSuggestion Property

The selected SuggestResult.
default null
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Results.SuggestResult? SelectedSuggestion { get; set; }

Property Value

SuggestResult

SearchViewModel.Sources Property

The Search widget may be used to search features in a
FeatureLayer or table,
or geocode locations with a locator.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchSource>? Sources { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<SearchSource>

SearchViewModel.State Property

The current state of the widget.
default “ready”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SearchViewModelState> State { get; set; }

Property Value

System.Nullable<SearchViewModelState>

SearchViewModel.SuggestionCount Property

The number of suggestions found for the search.
ArcGIS Maps SDK for JavaScript

public System.Nullable<int> SuggestionCount { get; set; }

Property Value

System.Nullable<System.Int32>

SearchViewModel.SuggestionDelay Property

The millisecond delay after keyup and before making a suggest network request.
default 350
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> SuggestionDelay { get; set; }

Property Value

System.Nullable<System.Double>

SearchViewModel.Suggestions Property

An array of results from the suggest method.
default null
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Results.SuggestResult>? Suggestions { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<SuggestResult>

SearchViewModel.SuggestionsEnabled Property

Enable suggestions for the widget.
default true
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> SuggestionsEnabled { get; set; }

Property Value

System.Nullable<System.Boolean>

SearchViewModel.TaskCollectionIncludeDefaultSources Property

Indicates whether or not to include defaultSources in the Search UI.
default true
ArcGIS Maps SDK for JavaScript

public System.Func<System.Threading.Tasks.Task>? TaskCollectionIncludeDefaultSources { get; set; }

Property Value

System.Func<System.Threading.Tasks.Task>

SearchViewModel.Updating Property

Indicates whether the View or Portal is loading resources prior to use.
default false
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> Updating { get; set; }

Property Value

System.Nullable<System.Boolean>

Methods

SearchViewModel.AddToSources(SearchSource[]) Method

Asynchronously adds elements to the Sources property.

public System.Threading.Tasks.Task AddToSources(params dymaptic.GeoBlazor.Core.Components.SearchSource[] values);

Parameters

values SearchSource[]

The elements to add.

Returns

System.Threading.Tasks.Task

SearchViewModel.Clear() Method

Clears the current value, search results, suggest results, graphic, and graphics layer.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task Clear();

Returns

System.Threading.Tasks.Task

SearchViewModel.GetActiveSource() Method

Asynchronously retrieve the current value of the ActiveSource property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SearchSource?> GetActiveSource();

Returns

System.Threading.Tasks.Task<SearchSource>

SearchViewModel.GetActiveSourceIndex() Method

Asynchronously retrieve the current value of the ActiveSourceIndex property.

public System.Threading.Tasks.Task<System.Nullable<int>> GetActiveSourceIndex();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

SearchViewModel.GetAllPlaceholder() Method

Asynchronously retrieve the current value of the AllPlaceholder property.

public System.Threading.Tasks.Task<string?> GetAllPlaceholder();

Returns

System.Threading.Tasks.Task<System.String>

SearchViewModel.GetAllSources() Method

Asynchronously retrieve the current value of the AllSources property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchSource>?> GetAllSources();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SearchSource>>

SearchViewModel.GetAutoNavigate() Method

Asynchronously retrieve the current value of the AutoNavigate property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetAutoNavigate();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

SearchViewModel.GetAutoSelect() Method

Asynchronously retrieve the current value of the AutoSelect property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetAutoSelect();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

SearchViewModel.GetBoolIncludeDefaultSources() Method

Asynchronously retrieve the current value of the BoolIncludeDefaultSources property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetBoolIncludeDefaultSources();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

SearchViewModel.GetDefaultPopupTemplate() Method

Asynchronously retrieve the current value of the DefaultPopupTemplate property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate?> GetDefaultPopupTemplate();

Returns

System.Threading.Tasks.Task<PopupTemplate>

SearchViewModel.GetDefaultSources() Method

Asynchronously retrieve the current value of the DefaultSources property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchSource>?> GetDefaultSources();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SearchSource>>

SearchViewModel.GetDefaultSymbols() Method

Asynchronously retrieve the current value of the DefaultSymbols property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.SearchViewModelDefaultSymbols?> GetDefaultSymbols();

Returns

System.Threading.Tasks.Task<SearchViewModelDefaultSymbols>

SearchViewModel.GetLocationEnabled() Method

Asynchronously retrieve the current value of the LocationEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetLocationEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

SearchViewModel.GetMaxInputLength() Method

Asynchronously retrieve the current value of the MaxInputLength property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxInputLength();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

SearchViewModel.GetMaxResults() Method

Asynchronously retrieve the current value of the MaxResults property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxResults();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

SearchViewModel.GetMaxSuggestions() Method

Asynchronously retrieve the current value of the MaxSuggestions property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxSuggestions();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

SearchViewModel.GetMinSuggestCharacters() Method

Asynchronously retrieve the current value of the MinSuggestCharacters property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetMinSuggestCharacters();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

SearchViewModel.GetPlaceholder() Method

Asynchronously retrieve the current value of the Placeholder property.

public System.Threading.Tasks.Task<string?> GetPlaceholder();

Returns

System.Threading.Tasks.Task<System.String>

SearchViewModel.GetPopupEnabled() Method

Asynchronously retrieve the current value of the PopupEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetPopupEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

SearchViewModel.GetPopupTemplate() Method

Asynchronously retrieve the current value of the PopupTemplate property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate?> GetPopupTemplate();

Returns

System.Threading.Tasks.Task<PopupTemplate>

SearchViewModel.GetPortal() Method

Asynchronously retrieve the current value of the Portal property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Portal?> GetPortal();

Returns

System.Threading.Tasks.Task<Portal>

SearchViewModel.GetResultCount() Method

Asynchronously retrieve the current value of the ResultCount property.

public System.Threading.Tasks.Task<System.Nullable<int>> GetResultCount();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

SearchViewModel.GetResultGraphic() Method

Asynchronously retrieve the current value of the ResultGraphic property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic?> GetResultGraphic();

Returns

System.Threading.Tasks.Task<Graphic>

SearchViewModel.GetResultGraphicEnabled() Method

Asynchronously retrieve the current value of the ResultGraphicEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetResultGraphicEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

SearchViewModel.GetResults() Method

Asynchronously retrieve the current value of the Results property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Results.SearchResultResponse>?> GetResults();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SearchResultResponse>>

SearchViewModel.GetSearchAllEnabled() Method

Asynchronously retrieve the current value of the SearchAllEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetSearchAllEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

SearchViewModel.GetSearchTerm() Method

Asynchronously retrieve the current value of the SearchTerm property.

public System.Threading.Tasks.Task<string?> GetSearchTerm();

Returns

System.Threading.Tasks.Task<System.String>

SearchViewModel.GetSelectedResult() Method

Asynchronously retrieve the current value of the SelectedResult property.

public System.Threading.Tasks.Task<string?> GetSelectedResult();

Returns

System.Threading.Tasks.Task<System.String>

SearchViewModel.GetSelectedSuggestion() Method

Asynchronously retrieve the current value of the SelectedSuggestion property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.SuggestResult?> GetSelectedSuggestion();

Returns

System.Threading.Tasks.Task<SuggestResult>

SearchViewModel.GetSources() Method

Asynchronously retrieve the current value of the Sources property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchSource>?> GetSources();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SearchSource>>

SearchViewModel.GetState() Method

Asynchronously retrieve the current value of the State property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.SearchViewModelState>> GetState();

Returns

System.Threading.Tasks.Task<System.Nullable<SearchViewModelState>>

SearchViewModel.GetSuggestionCount() Method

Asynchronously retrieve the current value of the SuggestionCount property.

public System.Threading.Tasks.Task<System.Nullable<int>> GetSuggestionCount();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

SearchViewModel.GetSuggestionDelay() Method

Asynchronously retrieve the current value of the SuggestionDelay property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetSuggestionDelay();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

SearchViewModel.GetSuggestions() Method

Asynchronously retrieve the current value of the Suggestions property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Results.SuggestResult>?> GetSuggestions();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SuggestResult>>

SearchViewModel.GetSuggestionsEnabled() Method

Asynchronously retrieve the current value of the SuggestionsEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetSuggestionsEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

SearchViewModel.GetTaskCollectionIncludeDefaultSources() Method

Asynchronously retrieve the current value of the TaskCollectionIncludeDefaultSources property.

public System.Threading.Tasks.Task<System.Func<System.Threading.Tasks.Task>?> GetTaskCollectionIncludeDefaultSources();

Returns

System.Threading.Tasks.Task<System.Func<System.Threading.Tasks.Task>>

SearchViewModel.GetUpdating() Method

Asynchronously retrieve the current value of the Updating property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetUpdating();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

SearchViewModel.OnJsGoToOverride(IJSStreamReference) Method

JS-invokable method that triggers the GoToOverride function.
Should not be called by consuming code.

public System.Threading.Tasks.Task OnJsGoToOverride(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Implements OnJsGoToOverride(IJSStreamReference)

Returns

System.Threading.Tasks.Task

SearchViewModel.OnJsSearchClear(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsSearchClear(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

SearchViewModel.OnJsSearchComplete(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsSearchComplete(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

SearchViewModel.OnJsSearchStart(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsSearchStart(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

SearchViewModel.OnJsSelectResult(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsSelectResult(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

SearchViewModel.OnJsSuggestComplete(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsSuggestComplete(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

SearchViewModel.OnJsSuggestStart(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsSuggestStart(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

SearchViewModel.RemoveFromSources(SearchSource[]) Method

Asynchronously remove an element from the Sources property.

public System.Threading.Tasks.Task RemoveFromSources(params dymaptic.GeoBlazor.Core.Components.SearchSource[] values);

Parameters

values SearchSource[]

The elements to remove.

Returns

System.Threading.Tasks.Task

SearchViewModel.Search(string) Method

Depending on the sources specified, search() queries the feature layer(s) and/or performs
address matching using any specified Locator(s) and
returns the applicable results.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SearchResponse?> Search(string searchItem);

Parameters

searchItem System.String

This searchItem can be a string, point geometry, suggest candidate object, or an array containing [latitude,longitude]. If a geometry is supplied, then it will reverse geocode (locator) or findAddressCandidates with geometry instead of text (featurelayer).

Returns

System.Threading.Tasks.Task<SearchResponse>

SearchViewModel.SearchNearby() Method

Returns search results near your current location.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SearchResponse?> SearchNearby();

Returns

System.Threading.Tasks.Task<SearchResponse>

SearchViewModel.Select(string) Method

Selects a result.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.SearchViewModelSearchResult?> Select(string value);

Parameters

value System.String

The result object to select.

Returns

System.Threading.Tasks.Task<SearchViewModelSearchResult>

SearchViewModel.SetActiveSourceIndex(Nullable) Method

Asynchronously set the value of the ActiveSourceIndex property after render.

public System.Threading.Tasks.Task SetActiveSourceIndex(System.Nullable<int> value);

Parameters

value System.Nullable<System.Int32>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetAllPlaceholder(string) Method

Asynchronously set the value of the AllPlaceholder property after render.

public System.Threading.Tasks.Task SetAllPlaceholder(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetAutoNavigate(Nullable) Method

Asynchronously set the value of the AutoNavigate property after render.

public System.Threading.Tasks.Task SetAutoNavigate(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetAutoSelect(Nullable) Method

Asynchronously set the value of the AutoSelect property after render.

public System.Threading.Tasks.Task SetAutoSelect(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetBoolIncludeDefaultSources(Nullable) Method

Asynchronously set the value of the BoolIncludeDefaultSources property after render.

public System.Threading.Tasks.Task SetBoolIncludeDefaultSources(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetDefaultPopupTemplate(PopupTemplate) Method

Asynchronously set the value of the DefaultPopupTemplate property after render.

public System.Threading.Tasks.Task SetDefaultPopupTemplate(dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? value);

Parameters

value PopupTemplate

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetDefaultSymbols(SearchViewModelDefaultSymbols) Method

Asynchronously set the value of the DefaultSymbols property after render.

public System.Threading.Tasks.Task SetDefaultSymbols(dymaptic.GeoBlazor.Core.Components.Symbols.SearchViewModelDefaultSymbols? value);

Parameters

value SearchViewModelDefaultSymbols

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetLocationEnabled(Nullable) Method

Asynchronously set the value of the LocationEnabled property after render.

public System.Threading.Tasks.Task SetLocationEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetMaxInputLength(Nullable) Method

Asynchronously set the value of the MaxInputLength property after render.

public System.Threading.Tasks.Task SetMaxInputLength(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetMaxResults(Nullable) Method

Asynchronously set the value of the MaxResults property after render.

public System.Threading.Tasks.Task SetMaxResults(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetMaxSuggestions(Nullable) Method

Asynchronously set the value of the MaxSuggestions property after render.

public System.Threading.Tasks.Task SetMaxSuggestions(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetMinSuggestCharacters(Nullable) Method

Asynchronously set the value of the MinSuggestCharacters property after render.

public System.Threading.Tasks.Task SetMinSuggestCharacters(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetPopupEnabled(Nullable) Method

Asynchronously set the value of the PopupEnabled property after render.

public System.Threading.Tasks.Task SetPopupEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetPopupTemplate(PopupTemplate) Method

Asynchronously set the value of the PopupTemplate property after render.

public System.Threading.Tasks.Task SetPopupTemplate(dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? value);

Parameters

value PopupTemplate

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetPortal(Portal) Method

Asynchronously set the value of the Portal property after render.

public System.Threading.Tasks.Task SetPortal(dymaptic.GeoBlazor.Core.Components.Portal? value);

Parameters

value Portal

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetResultCount(Nullable) Method

Asynchronously set the value of the ResultCount property after render.

public System.Threading.Tasks.Task SetResultCount(System.Nullable<int> value);

Parameters

value System.Nullable<System.Int32>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetResultGraphicEnabled(Nullable) Method

Asynchronously set the value of the ResultGraphicEnabled property after render.

public System.Threading.Tasks.Task SetResultGraphicEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetSearchAllEnabled(Nullable) Method

Asynchronously set the value of the SearchAllEnabled property after render.

public System.Threading.Tasks.Task SetSearchAllEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetSearchTerm(string) Method

Asynchronously set the value of the SearchTerm property after render.

public System.Threading.Tasks.Task SetSearchTerm(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetSources(IReadOnlyList) Method

Asynchronously set the value of the Sources property after render.

public System.Threading.Tasks.Task SetSources(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchSource>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<SearchSource>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetSuggestionCount(Nullable) Method

Asynchronously set the value of the SuggestionCount property after render.

public System.Threading.Tasks.Task SetSuggestionCount(System.Nullable<int> value);

Parameters

value System.Nullable<System.Int32>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetSuggestionDelay(Nullable) Method

Asynchronously set the value of the SuggestionDelay property after render.

public System.Threading.Tasks.Task SetSuggestionDelay(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetSuggestionsEnabled(Nullable) Method

Asynchronously set the value of the SuggestionsEnabled property after render.

public System.Threading.Tasks.Task SetSuggestionsEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.SetTaskCollectionIncludeDefaultSources(Func) Method

Asynchronously set the value of the TaskCollectionIncludeDefaultSources property after render.

public System.Threading.Tasks.Task SetTaskCollectionIncludeDefaultSources(System.Func<System.Threading.Tasks.Task>? value);

Parameters

value System.Func<System.Threading.Tasks.Task>

The value to set.

Returns

System.Threading.Tasks.Task

SearchViewModel.Suggest(string) Method

Performs a suggest() request on the active Locator.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SuggestResponse?> Suggest(string value);

Parameters

value System.String

The string value used to suggest() on an active Locator or feature layer. If nothing is passed in, takes the current value of the widget.

Returns

System.Threading.Tasks.Task<SuggestResponse>

SearchViewModel.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()