layout: default title: LocatorSearchSource parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Objects
LocatorSearchSource Class
The following properties define a source pointing to a url that represents a locator service, which may be used to geocode locations with a Search widget instance.
ArcGIS Maps SDK for JavaScript
public class LocatorSearchSource : dymaptic.GeoBlazor.Core.Objects.SearchSource
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 SearchSource 🡒 LocatorSearchSource
Properties
LocatorSearchSource.ApiKey Property
An authorization string used to access a resource or service. API keys are generated and managed in the ArcGIS Developer dashboard. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.
public string? ApiKey { get; set; }
Property Value
LocatorSearchSource.Categories Property
A string array which limits the results to one or more categories. For example, Populated Place or airport. Only applicable when using the World Geocode Service.
public System.Collections.Generic.IEnumerable<string>? Categories { get; set; }
Property Value
System.Collections.Generic.IEnumerable<System.String>
LocatorSearchSource.CountryCode Property
Constricts search results to a specified country code. For example, US for United States or SE for Sweden. Only applies to the World Geocode Service.
public string? CountryCode { get; set; }
Property Value
LocatorSearchSource.DefaultZoomScale Property
Sets the scale of the MapView or SceneView for the resulting search result, if the locator service doesn’t return an extent with a scale. An example of this is using the Use current location option in the Search bar.
If you want to override the scale returned by the locator service, use zoomScale instead.
public System.Nullable<double> DefaultZoomScale { get; set; }
Property Value
System.Nullable<System.Double>
LocatorSearchSource.Filter Property
For filtering suggests or search results. Setting a value here takes precedence over withinViewEnabled.
public dymaptic.GeoBlazor.Core.Objects.LocatorSearchSourceFilter? Filter { get; set; }
Property Value
LocatorSearchSource.LocalSearchDisabled Property
This property controls prioritization of Search widget result candidates depending on the view scale.
When this property is false (the default value), the location parameter is included in the request when the scale of the MapView or SceneView is less than or equal to 300,000. This prioritizes result candidates based on their distance from a specified point (the center of the view).
When this property is true, the location parameter is never included in the request, no matter the scale of the MapView or SceneView.
Default value is False.
public System.Nullable<bool> LocalSearchDisabled { get; set; }
Property Value
System.Nullable<System.Boolean>
LocatorSearchSource.LocationType Property
Defines the type of location, either street or rooftop, of the point returned from the World Geocoding Service.
public System.Nullable<dymaptic.GeoBlazor.Core.Objects.LocatorSearchLocationType> LocationType { get; set; }
Property Value
System.Nullable<LocatorSearchLocationType>
LocatorSearchSource.SingleLineFieldName Property
The field name of the Single Line Address Field in the REST services directory for the locator service. Common values are SingleLine and SingleLineFieldName.
public string? SingleLineFieldName { get; set; }
Property Value
LocatorSearchSource.Type Property
The type of source.
public override string Type { get; }
Property Value
LocatorSearchSource.Url Property
URL to the ArcGIS Server REST resource that represents a locator service. This is required.
public string Url { get; set; }
Property Value
Methods
LocatorSearchSource.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s 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.
LocatorSearchSource.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.