dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

Search Class

Represents the search parameters set within the web scene or the web map.
ArcGIS Maps SDK for JavaScript

public class Search : dymaptic.GeoBlazor.Core.Components.MapComponent

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

Constructors

Search() Constructor

Parameterless constructor for use as a Razor Component.

public Search();

Search(Nullable, Nullable, string, IReadOnlyList, IReadOnlyList) Constructor

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

public Search(System.Nullable<bool> addressSearchEnabled=null, System.Nullable<bool> enabled=null, string? hintText=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchLayer>? layers=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.SearchTable>? tables=null);

Parameters

addressSearchEnabled System.Nullable<System.Boolean>

Indicates whether the place finder is enabled in the web scene or the web map.
ArcGIS Maps SDK for JavaScript

enabled System.Nullable<System.Boolean>

Whether search functionality is enabled in the web scene or the web map.
ArcGIS Maps SDK for JavaScript

hintText System.String

The hint provided with the search dialog.
ArcGIS Maps SDK for JavaScript

layers System.Collections.Generic.IReadOnlyList<SearchLayer>

A collection of layers to be included in search.
ArcGIS Maps SDK for JavaScript

tables System.Collections.Generic.IReadOnlyList<SearchTable>

A collection of tables to be included in search.
ArcGIS Maps SDK for JavaScript

Properties

Search.AddressSearchEnabled Property

Indicates whether the place finder is enabled in the web scene or the web map.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

Search.Enabled Property

Whether search functionality is enabled in the web scene or the web map.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

Search.HintText Property

The hint provided with the search dialog.
ArcGIS Maps SDK for JavaScript

public string? HintText { get; set; }

Property Value

System.String

Search.Layers Property

A collection of layers to be included in search.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Collections.Generic.IReadOnlyList<SearchLayer>

Search.Tables Property

A collection of tables to be included in search.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Collections.Generic.IReadOnlyList<SearchTable>

Methods

Search.AddToLayers(SearchLayer[]) Method

Asynchronously adds elements to the Layers property.

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

Parameters

values SearchLayer[]

The elements to add.

Returns

System.Threading.Tasks.Task

Search.AddToTables(SearchTable[]) Method

Asynchronously adds elements to the Tables property.

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

Parameters

values SearchTable[]

The elements to add.

Returns

System.Threading.Tasks.Task

Search.GetAddressSearchEnabled() Method

Asynchronously retrieve the current value of the AddressSearchEnabled property.

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

Returns

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

Search.GetEnabled() Method

Asynchronously retrieve the current value of the Enabled property.

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

Returns

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

Search.GetHintText() Method

Asynchronously retrieve the current value of the HintText property.

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

Returns

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

Search.GetLayers() Method

Asynchronously retrieve the current value of the Layers property.

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

Returns

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

Search.GetTables() Method

Asynchronously retrieve the current value of the Tables property.

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

Returns

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

Search.RemoveFromLayers(SearchLayer[]) Method

Asynchronously remove an element from the Layers property.

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

Parameters

values SearchLayer[]

The elements to remove.

Returns

System.Threading.Tasks.Task

Search.RemoveFromTables(SearchTable[]) Method

Asynchronously remove an element from the Tables property.

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

Parameters

values SearchTable[]

The elements to remove.

Returns

System.Threading.Tasks.Task

Search.SetAddressSearchEnabled(Nullable) Method

Asynchronously set the value of the AddressSearchEnabled property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

Search.SetEnabled(Nullable) Method

Asynchronously set the value of the Enabled property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

Search.SetHintText(string) Method

Asynchronously set the value of the HintText property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

Search.SetLayers(IReadOnlyList) Method

Asynchronously set the value of the Layers property after render.

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

Parameters

value System.Collections.Generic.IReadOnlyList<SearchLayer>

The value to set.

Returns

System.Threading.Tasks.Task

Search.SetTables(IReadOnlyList) Method

Asynchronously set the value of the Tables property after render.

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

Parameters

value System.Collections.Generic.IReadOnlyList<SearchTable>

The value to set.

Returns

System.Threading.Tasks.Task

Search.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()