dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
SearchSource Class
The following properties define generic sources properties
for use in the Search widget.
ArcGIS Maps SDK for JavaScript
public abstract class SearchSource : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 SearchSource
Derived
↳ LayerSearchSource
↳ LocatorSearchSource
Properties
SearchSource.AutoNavigate Property
Indicates whether to automatically navigate to the selected result once selected.
public System.Nullable<bool> AutoNavigate { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchSource.Filter Property
For filtering suggests or search results.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.SearchSourceFilter? Filter { get; set; }
Property Value
SearchSource.GetResultsHandler Property
Function used to get search results.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.GetResultsHandler? GetResultsHandler { get; set; }
Property Value
SearchSource.GetSuggestionsHandler Property
Function used to get search suggestions.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.GetSuggestionsHandler? GetSuggestionsHandler { get; set; }
Property Value
GetSuggestionsHandler(Nullable<int>, Nullable<int>, SpatialReference, string, Nullable<Guid>)
SearchSource.HasGetResults Property
A convenience property that signifies whether a custom GetResultsHandler function was registered.
public bool HasGetResults { get; }
Property Value
SearchSource.HasGetSuggestions Property
A convenience property that signifies whether a custom GetSuggestionsHandler function was registered.
public bool HasGetSuggestions { get; }
Property Value
SearchSource.MaxResults Property
Indicates the maximum number of search results to return. Default value is 6.
public System.Nullable<int> MaxResults { get; set; }
Property Value
SearchSource.MaxSuggestions Property
Indicates the maximum number of suggestions
to return for the widget’s input.
default 6
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MaxSuggestions { get; set; }
Property Value
System.Nullable<System.Double>
SearchSource.MinSuggestCharacters Property
Indicates the minimum number of characters required before querying for a suggestion. Default value is 1.
public System.Nullable<int> MinSuggestCharacters { get; set; }
Property Value
SearchSource.OutFields Property
Specifies the fields returned with the search results.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? OutFields { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
SearchSource.Placeholder Property
Used as a hint for the source input text.
public string? Placeholder { get; set; }
Property Value
SearchSource.PopupEnabled Property
Indicates whether to display a Popup when a selected result is clicked.
public System.Nullable<bool> PopupEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchSource.PopupTemplate Property
The popup template used to display search results.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? PopupTemplate { get; set; }
Property Value
SearchSource.Prefix Property
Specify this to prefix the user’s input of the search text.
public string? Prefix { get; set; }
Property Value
SearchSource.ResultGraphicEnabled Property
Indicates whether to show a graphic on the map for the selected source using the resultSymbol.
public System.Nullable<bool> ResultGraphicEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchSource.ResultSymbol Property
The symbol used to display the result.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? ResultSymbol { get; set; }
Property Value
SearchSource.Suffix Property
Specify this to add a suffix to the user’s input for the search value.
public string? Suffix { get; set; }
Property Value
SearchSource.SuggestionsEnabled Property
Indicates whether to display suggestions as the user enters input text in the widget. Default value is true.
public System.Nullable<bool> SuggestionsEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchSource.Type Property
The type of source.
public abstract dymaptic.GeoBlazor.Core.Enums.SearchSourceType Type { get; }
Property Value
SearchSource.WithinViewEnabled Property
Indicates whether to constrain the search results to the view’s extent. Default value is false.
public System.Nullable<bool> WithinViewEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SearchSource.ZoomScale Property
The set zoom scale for the resulting search result. This scale is automatically honored. Default value is null.
public System.Nullable<double> ZoomScale { get; set; }
Property Value
System.Nullable<System.Double>
Methods
SearchSource.AddToOutFields(string[]) Method
Asynchronously adds elements to the OutFields property.
public System.Threading.Tasks.Task AddToOutFields(params string[] values);
Parameters
values System.String[]
The elements to add.
Returns
SearchSource.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>>
SearchSource.GetFilter() Method
Asynchronously retrieve the current value of the Filter property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.SearchSourceFilter?> GetFilter();
Returns
System.Threading.Tasks.Task<SearchSourceFilter>
SearchSource.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>>
SearchSource.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>>
SearchSource.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>>
SearchSource.GetOutFields() Method
Asynchronously retrieve the current value of the OutFields property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetOutFields();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
SearchSource.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>
SearchSource.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>>
SearchSource.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>
SearchSource.GetPrefix() Method
Asynchronously retrieve the current value of the Prefix property.
public System.Threading.Tasks.Task<string?> GetPrefix();
Returns
System.Threading.Tasks.Task<System.String>
SearchSource.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>>
SearchSource.GetResultSymbol() Method
Asynchronously retrieve the current value of the ResultSymbol property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Symbols.Symbol?> GetResultSymbol();
Returns
System.Threading.Tasks.Task<Symbol>
SearchSource.GetSuffix() Method
Asynchronously retrieve the current value of the Suffix property.
public System.Threading.Tasks.Task<string?> GetSuffix();
Returns
System.Threading.Tasks.Task<System.String>
SearchSource.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>>
SearchSource.GetWithinViewEnabled() Method
Asynchronously retrieve the current value of the WithinViewEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetWithinViewEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
SearchSource.GetZoomScale() Method
Asynchronously retrieve the current value of the ZoomScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetZoomScale();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
SearchSource.OnJsGetResults(Nullable, Point, Nullable, Nullable, SpatialReference, SuggestResult, Nullable) Method
JS-invokable method that triggers the GetResultsHandler function.
Should not be called by consuming code.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Results.SearchResult>?> OnJsGetResults(System.Nullable<bool> exactMatch, dymaptic.GeoBlazor.Core.Components.Geometries.Point? location, System.Nullable<int> maxResults, System.Nullable<int> sourceIndex, dymaptic.GeoBlazor.Core.Components.SpatialReference? spatialReference, dymaptic.GeoBlazor.Core.Results.SuggestResult suggestResult, System.Nullable<System.Guid> viewId);
Parameters
exactMatch System.Nullable<System.Boolean>
location Point
maxResults System.Nullable<System.Int32>
sourceIndex System.Nullable<System.Int32>
spatialReference SpatialReference
suggestResult SuggestResult
viewId System.Nullable<System.Guid>
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SearchResult>>
SearchSource.OnJsGetSuggestions(Nullable, Nullable, SpatialReference, string, Nullable) Method
JS-invokable method that triggers the GetSuggestionsHandler function.
Should not be called by consuming code.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Results.SuggestResult>?> OnJsGetSuggestions(System.Nullable<int> maxSuggestions, System.Nullable<int> sourceIndex, dymaptic.GeoBlazor.Core.Components.SpatialReference? spatialReference, string? suggestTerm, System.Nullable<System.Guid> viewId);
Parameters
maxSuggestions System.Nullable<System.Int32>
sourceIndex System.Nullable<System.Int32>
spatialReference SpatialReference
suggestTerm System.String
viewId System.Nullable<System.Guid>
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SuggestResult>>
SearchSource.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.
SearchSource.RemoveFromOutFields(string[]) Method
Asynchronously remove an element from the OutFields property.
public System.Threading.Tasks.Task RemoveFromOutFields(params string[] values);
Parameters
values System.String[]
The elements to remove.
Returns
SearchSource.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
SearchSource.SetFilter(SearchSourceFilter) Method
Asynchronously set the value of the Filter property after render.
public System.Threading.Tasks.Task SetFilter(dymaptic.GeoBlazor.Core.Model.SearchSourceFilter? value);
Parameters
value SearchSourceFilter
The value to set.
Returns
SearchSource.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
SearchSource.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
SearchSource.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
SearchSource.SetOutFields(IReadOnlyList) Method
Asynchronously set the value of the OutFields property after render.
public System.Threading.Tasks.Task SetOutFields(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
SearchSource.SetPlaceholder(string) Method
Asynchronously set the value of the Placeholder property after render.
public System.Threading.Tasks.Task SetPlaceholder(string? value);
Parameters
value System.String
The value to set.
Returns
SearchSource.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
SearchSource.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
SearchSource.SetPrefix(string) Method
Asynchronously set the value of the Prefix property after render.
public System.Threading.Tasks.Task SetPrefix(string? value);
Parameters
value System.String
The value to set.
Returns
SearchSource.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
SearchSource.SetResultSymbol(Symbol) Method
Asynchronously set the value of the ResultSymbol property after render.
public System.Threading.Tasks.Task SetResultSymbol(dymaptic.GeoBlazor.Core.Components.Symbols.Symbol? value);
Parameters
value Symbol
The value to set.
Returns
SearchSource.SetSuffix(string) Method
Asynchronously set the value of the Suffix property after render.
public System.Threading.Tasks.Task SetSuffix(string? value);
Parameters
value System.String
The value to set.
Returns
SearchSource.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
SearchSource.SetWithinViewEnabled(Nullable) Method
Asynchronously set the value of the WithinViewEnabled property after render.
public System.Threading.Tasks.Task SetWithinViewEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
SearchSource.SetZoomScale(Nullable) Method
Asynchronously set the value of the ZoomScale property after render.
public System.Threading.Tasks.Task SetZoomScale(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
SearchSource.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.
SearchSource.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()