dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
SearchWidget Class
The Search widget provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer, BuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). ArcGIS Maps SDK for JavaScript
public class SearchWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget, dymaptic.GeoBlazor.Core.Interfaces.IGoTo
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 SearchWidget
Implements IGoTo
Constructors
SearchWidget() Constructor
Parameterless constructor for use as a Razor Component.
public SearchWidget();
SearchWidget(IReadOnlyList, SearchViewModel, Nullable, Nullable, string, Nullable, string, Nullable, GoToOverride, string, Nullable, string, Nullable, MapView, Nullable, Nullable, Nullable, Nullable, PopupTemplate, Portal, Nullable, Nullable, Nullable, string, Nullable, Nullable, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public SearchWidget(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchSource> sources, dymaptic.GeoBlazor.Core.Components.SearchViewModel viewModel, System.Nullable<dymaptic.GeoBlazor.Core.Enums.SearchMenu> activeMenu=null, System.Nullable<int> activeSourceIndex=null, string? allPlaceholder=null, System.Nullable<bool> autoSelect=null, string? containerId=null, System.Nullable<bool> disabled=null, dymaptic.GeoBlazor.Core.Functions.GoToOverride? goToOverride=null, string? icon=null, System.Nullable<bool> includeDefaultSources=null, string? label=null, System.Nullable<bool> locationEnabled=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<int> maxResults=null, System.Nullable<int> maxSuggestions=null, System.Nullable<int> minSuggestCharacters=null, System.Nullable<bool> popupEnabled=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? popupTemplate=null, dymaptic.GeoBlazor.Core.Components.Portal? portal=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, System.Nullable<bool> resultGraphicEnabled=null, System.Nullable<bool> searchAllEnabled=null, string? searchTerm=null, System.Nullable<bool> suggestionsEnabled=null, System.Nullable<bool> visible=null, string? widgetId=null);
Parameters
sources System.Collections.Generic.IReadOnlyList<SearchSource>
The Search widget may be used to search features in a map/feature service feature layer(s), SceneLayers with an associated feature layer, BuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer or OGCFeatureLayer, or table, or geocode locations with a locator. ArcGIS Maps SDK for JavaScript
viewModel SearchViewModel
The view model for this widget. ArcGIS Maps SDK for JavaScript
activeMenu System.Nullable<SearchMenu>
The current active menu of the Search widget. default “none” ArcGIS Maps SDK for JavaScript
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
autoSelect System.Nullable<System.Boolean>
Indicates whether to automatically select and zoom to the first geocoded result. default true ArcGIS Maps SDK for JavaScript
containerId System.String
The id of an external HTML Element (div). If provided, the widget will be placed inside that element, instead of on the map.
disabled System.Nullable<System.Boolean>
When true, the widget is visually withdrawn and cannot be interacted with. default false 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
icon System.String
Icon which represents the widget. default “search” ArcGIS Maps SDK for JavaScript
includeDefaultSources System.Nullable<System.Boolean>
Indicates whether or not to include defaultSources in the Search UI. default true ArcGIS Maps SDK for JavaScript
label System.String
The widget’s default label. ArcGIS Maps SDK for JavaScript
locationEnabled System.Nullable<System.Boolean>
Enables location services within the widget. default true ArcGIS Maps SDK for JavaScript
mapView MapView
If the Widget is defined outside of the MapView, this link is required to connect them together.
maxResults System.Nullable<System.Int32>
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.Int32>
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.Int32>
The minimum number of characters needed for the search if not specified by the source. default 3 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. 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
position System.Nullable<OverlayPosition>
The position of the widget in relation to the map view.
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
suggestionsEnabled System.Nullable<System.Boolean>
Enable suggestions for the widget. default true ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
Indicates whether the widget is visible. default true ArcGIS Maps SDK for JavaScript
widgetId System.String
The unique ID assigned to the widget when the widget is created. ArcGIS Maps SDK for JavaScript
Properties
SearchWidget.ActiveMenu Property
Sets the current active menu of the Search widget. Default value is None.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.SearchMenu> ActiveMenu { get; set; }
Property Value
SearchWidget.ActiveSource Property
The source object currently selected. default null ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SearchSource? ActiveSource { get; }
Property Value
SearchWidget.ActiveSourceIndex Property
Sets the selected source’s index. Default value is 0.
public System.Nullable<int> ActiveSourceIndex { get; set; }
Property Value
SearchWidget.AllPlaceholder Property
String value used as a hint for input text when searching on multiple sources. See the image below to view the location and style of this text in the context of the widget. Default Value: “Find address or place”
public string? AllPlaceholder { get; set; }
Property Value
SearchWidget.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; }
Property Value
System.Collections.Generic.IReadOnlyList<SearchSource>
SearchWidget.AutoSelect Property
Indicates whether to automatically select and zoom to the first geocoded result. If false, the findAddressCandidates operation will still geocode the input string, but the top result will not be selected. To work with the geocoded results, you can set up a search-complete event handler and get the results through the event object. Default value is True.
public System.Nullable<bool> AutoSelect { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchWidget.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; }
Property Value
System.Collections.Generic.IReadOnlyList<SearchSource>
SearchWidget.Disabled Property
When true, the widget is visually withdrawn and cannot be interacted with. Default value is False.
public System.Nullable<bool> Disabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchWidget.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)
SearchWidget.HasGoToOverride Property
A convenience property that signifies whether a custom GoToOverride function was registered.
public bool HasGoToOverride { get; }
Implements HasGoToOverride
Property Value
SearchWidget.HasSearchBlurListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSearchBlurListener { get; }
Property Value
SearchWidget.HasSearchClearListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSearchClearListener { get; }
Property Value
SearchWidget.HasSearchCompleteListener Property
Used in JavaScript to determine if the event listener is set.
public bool HasSearchCompleteListener { get; }
Property Value
SearchWidget.HasSearchFocusListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSearchFocusListener { get; }
Property Value
SearchWidget.HasSearchStartListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSearchStartListener { get; }
Property Value
SearchWidget.HasSelectResultListener Property
Used in JavaScript to determine if the event listener is set.
public bool HasSelectResultListener { get; }
Property Value
SearchWidget.HasSuggestCompleteListener Property
Used in JavaScript to determine if the event listener is set.
public bool HasSuggestCompleteListener { get; }
Property Value
SearchWidget.HasSuggestStartListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSuggestStartListener { get; }
Property Value
SearchWidget.IncludeDefaultSources Property
Indicates whether or not to include defaultSources in the Search UI.
public System.Nullable<bool> IncludeDefaultSources { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchWidget.LocationEnabled Property
Enables location services within the widget. Default value is True.
public System.Nullable<bool> LocationEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
The use of this property is only supported on secure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered “potentially secure” and can be used for easy testing in browsers that supports Window.isSecureContext (currently Chrome and Firefox).
SearchWidget.MaxResults Property
The maximum number of results returned by the widget if not specified by the source. Default value is 6.
public System.Nullable<int> MaxResults { get; set; }
Property Value
SearchWidget.MaxSuggestions Property
The maximum number of suggestions returned by the widget if not specified by the source. If working with the default ArcGIS Online Geocoding service, the default remains at 5. Default Value:6
public System.Nullable<int> MaxSuggestions { get; set; }
Property Value
SearchWidget.MinSuggestCharacters Property
The minimum number of characters needed for the search if not specified by the source. Default Value:3
public System.Nullable<int> MinSuggestCharacters { get; set; }
Property Value
SearchWidget.OnSearchBlur Property
Event Listener for SearchBlur.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchBlurEvent> OnSearchBlur { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SearchBlurEvent>
SearchWidget.OnSearchClear Property
Event Listener for SearchClear.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchClearEvent> OnSearchClear { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SearchClearEvent>
SearchWidget.OnSearchComplete Property
Event Listener for SearchComplete.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchCompleteEvent> OnSearchComplete { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SearchCompleteEvent>
SearchWidget.OnSearchFocus Property
Event Listener for SearchFocus.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchFocusEvent> OnSearchFocus { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SearchFocusEvent>
SearchWidget.OnSearchSelectResultEvent Property
A delegate for a handler of search selection result events. Function must take in a SearchResult parameter, and return a System.Threading.Tasks.Task
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Results.SearchResult> OnSearchSelectResultEvent { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SearchResult>
SearchWidget.OnSearchStart Property
Event Listener for SearchStart.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchStartEvent> OnSearchStart { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SearchStartEvent>
SearchWidget.OnSelectResult Property
Event Listener for SelectResult.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchSelectResultEvent> OnSelectResult { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SearchSelectResultEvent>
SearchWidget.OnSuggestComplete Property
Event Listener for SuggestComplete.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchSuggestCompleteEvent> OnSuggestComplete { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SearchSuggestCompleteEvent>
SearchWidget.OnSuggestStart Property
Event Listener for SuggestStart.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.SearchSuggestStartEvent> OnSuggestStart { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SearchSuggestStartEvent>
SearchWidget.PopupEnabled Property
Indicates whether to display the Popup on feature click. The graphic can be clicked to display a Popup. Default Value:true
public System.Nullable<bool> PopupEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchWidget.PopupTemplate Property
A customized PopupTemplate for the selected feature. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? PopupTemplate { get; set; }
Property Value
SearchWidget.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
SearchWidget.ResultGraphic Property
The graphic used to highlight the resulting feature or location. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Graphic? ResultGraphic { get; }
Property Value
SearchWidget.ResultGraphicEnabled Property
Indicates if the resultGraphic will display at the location of the selected feature. Default Value:true
public System.Nullable<bool> ResultGraphicEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchWidget.Results Property
An array of objects, each containing a SearchResult from the search. ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Results.SearchResultResponse>? Results { get; }
Property Value
System.Collections.Generic.IReadOnlyList<SearchResultResponse>
SearchWidget.SearchAllEnabled Property
Indicates whether to display the option to search all sources. When true, the “All” option is displayed by default. When false, no option to search all sources at once is available. Default Value is True.
public System.Nullable<bool> SearchAllEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchWidget.SearchTerm Property
The value of the search box input text string.
public string? SearchTerm { get; set; }
Property Value
Remarks
Only use to set an initial value. Use SetSearchTerm() and GetSearchTerm() to update or read.
SearchWidget.SelectedResult Property
The result selected from a search. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Results.SearchResult? SelectedResult { get; }
Property Value
SearchWidget.Sources Property
The Search widget may be used to search features in a map/feature service feature layer(s), SceneLayers with an associated feature layer, BuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer or OGCFeatureLayer, 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>
SearchWidget.Suggestions Property
An array of results from the suggest method. ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Results.SuggestResult>? Suggestions { get; }
Property Value
System.Collections.Generic.IReadOnlyList<SuggestResult>
SearchWidget.SuggestionsEnabled Property
Enable suggestions for the widget. This is only available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true. Default Value:true
public System.Nullable<bool> SuggestionsEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
SearchWidget.ViewModel Property
The view model for this widget. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SearchViewModel? ViewModel { get; set; }
Property Value
Methods
SearchWidget.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
SearchWidget.Blur() Method
Unfocuses the widget’s text input. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task Blur();
Returns
SearchWidget.Clear() Method
Clears the current searchTerm, search results, suggest results, graphic, and graphics layer. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task Clear();
Returns
SearchWidget.Focus() Method
Brings focus to the widget’s text input. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task Focus();
Returns
SearchWidget.GetActiveMenu() Method
Asynchronously retrieve the current value of the ActiveMenu property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.SearchMenu>> GetActiveMenu();
Returns
System.Threading.Tasks.Task<System.Nullable<SearchMenu>>
SearchWidget.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>
SearchWidget.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>>
SearchWidget.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>
SearchWidget.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>>
SearchWidget.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>>
SearchWidget.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>>
SearchWidget.GetDisabled() Method
Asynchronously retrieve the current value of the Disabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetDisabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SearchWidget.GetIncludeDefaultSources() Method
Asynchronously retrieve the current value of the IncludeDefaultSources property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetIncludeDefaultSources();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SearchWidget.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>>
SearchWidget.GetMaxResults() Method
Asynchronously retrieve the current value of the MaxResults property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetMaxResults();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
SearchWidget.GetMaxSuggestions() Method
Asynchronously retrieve the current value of the MaxSuggestions property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetMaxSuggestions();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
SearchWidget.GetMinSuggestCharacters() Method
Asynchronously retrieve the current value of the MinSuggestCharacters property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetMinSuggestCharacters();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
SearchWidget.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>>
SearchWidget.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>
SearchWidget.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>
SearchWidget.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>
SearchWidget.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>>
SearchWidget.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>>
SearchWidget.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>>
SearchWidget.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>
SearchWidget.GetSelectedResult() Method
Retrieves the result selected from a search.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.SearchResult> GetSelectedResult();
Returns
System.Threading.Tasks.Task<SearchResult>
SearchWidget.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>>
SearchWidget.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>>
SearchWidget.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>>
SearchWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SearchViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<SearchViewModel>
SearchWidget.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
SearchWidget.OnJsSearchBlur(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsSearchBlur(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
SearchWidget.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
SearchWidget.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
SearchWidget.OnJsSearchFocus(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsSearchFocus(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
SearchWidget.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
SearchWidget.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
SearchWidget.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
SearchWidget.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
SearchWidget.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
Exceptions
InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.
SearchWidget.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
SearchWidget.Search(double[][]) Method
Depending on the sources specified, search() queries the feature layer(s) and/or performs address matching using any specified locator(s) and returns any applicable results.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SearchResponse> Search(double[][] searchTerm);
Parameters
searchTerm System.Double[][]
The array of long/lat coordinate pairs to search for.
Returns
System.Threading.Tasks.Task<SearchResponse>
SearchWidget.Search(Geometry) Method
Depending on the sources specified, search() queries the feature layer(s) and/or performs address matching using any specified locator(s) and returns any applicable results.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SearchResponse> Search(dymaptic.GeoBlazor.Core.Components.Geometries.Geometry searchTerm);
Parameters
searchTerm Geometry
The geometry to search for.
Returns
System.Threading.Tasks.Task<SearchResponse>
SearchWidget.Search(SuggestResult) Method
Depending on the sources specified, search() queries the feature layer(s) and/or performs address matching using any specified locator(s) and returns any applicable results.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SearchResponse> Search(dymaptic.GeoBlazor.Core.Results.SuggestResult searchTerm);
Parameters
searchTerm SuggestResult
The SuggestResult to search for.
Returns
System.Threading.Tasks.Task<SearchResponse>
SearchWidget.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 any applicable results.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SearchResponse> Search(string searchTerm);
Parameters
searchTerm System.String
The term to search for.
Returns
System.Threading.Tasks.Task<SearchResponse>
SearchWidget.SetActiveMenu(Nullable) Method
Asynchronously set the value of the ActiveMenu property after render.
public System.Threading.Tasks.Task SetActiveMenu(System.Nullable<dymaptic.GeoBlazor.Core.Enums.SearchMenu> value);
Parameters
value System.Nullable<SearchMenu>
The value to set.
Returns
SearchWidget.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
SearchWidget.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
SearchWidget.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
SearchWidget.SetDisabled(Nullable) Method
Asynchronously set the value of the Disabled property after render.
public System.Threading.Tasks.Task SetDisabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SearchWidget.SetIncludeDefaultSources(Nullable) Method
Asynchronously set the value of the IncludeDefaultSources property after render.
public System.Threading.Tasks.Task SetIncludeDefaultSources(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SearchWidget.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
SearchWidget.SetMaxResults(Nullable) Method
Asynchronously set the value of the MaxResults property after render.
public System.Threading.Tasks.Task SetMaxResults(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
SearchWidget.SetMaxSuggestions(Nullable) Method
Asynchronously set the value of the MaxSuggestions property after render.
public System.Threading.Tasks.Task SetMaxSuggestions(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
SearchWidget.SetMinSuggestCharacters(Nullable) Method
Asynchronously set the value of the MinSuggestCharacters property after render.
public System.Threading.Tasks.Task SetMinSuggestCharacters(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
SearchWidget.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
SearchWidget.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
SearchWidget.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
SearchWidget.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
SearchWidget.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
SearchWidget.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
SearchWidget.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
SearchWidget.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
SearchWidget.SetViewModel(SearchViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Core.Components.SearchViewModel value);
Parameters
value SearchViewModel
The value to set.
Returns
SearchWidget.Suggest(string) Method
Performs a suggest() request on the active Locator. It also uses the current value of the widget or one that is passed in.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SuggestResponse> Suggest(string? value=null);
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>
Remarks
Suggestions are available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.
SearchWidget.UnregisterChildComponent(MapComponent) Method
Undoes the “Registration” of a child with its parent.
public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The child to unregister
Returns
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.
SearchWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()