Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface widgetsSearchProperties

Hierarchy

Index

Properties

Optional activeMenu

activeMenu: "none" | "source" | "warning" | "suggestion"

The current active menu of the Search widget.

Read more...

Optional activeSourceIndex

activeSourceIndex: number

The selected source's index.

Read more...

Optional allPlaceholder

allPlaceholder: string

String value used as a hint for input text when searching on multiple sources.

Read more...

Optional autoSelect

autoSelect: boolean

Indicates whether to automatically select and zoom to the first geocoded result.

Read more...

Optional container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Read more...

Optional disabled

disabled: boolean

When true, the widget is visually withdrawn and cannot be interacted with.

Read more...

Optional goToOverride

goToOverride: GoToOverride

This function provides the ability to override either the IMapView goTo() or SceneView goTo() methods.

Read more...

Optional iconClass

iconClass: string

The widget's default CSS icon class.

Read more...

Optional id

id: string

The unique ID assigned to the widget when the widget is created.

Read more...

Optional includeDefaultSources

includeDefaultSources: boolean | Function

Indicates whether or not to include defaultSources in the Search UI.

Read more...

Optional label

label: string

The widget's label.

Read more...

Optional locationEnabled

locationEnabled: boolean

Enables location services within the widget.

Read more...

Optional maxResults

maxResults: number

The maximum number of results returned by the widget if not specified by the source.

Read more...

Optional maxSuggestions

maxSuggestions: number

The maximum number of suggestions returned by the widget if not specified by the source.

Read more...

Optional minSuggestCharacters

minSuggestCharacters: number

The minimum number of characters needed for the search if not specified by the source.

Read more...

Optional popupEnabled

popupEnabled: boolean

Indicates whether to display the Popup on feature click.

Read more...

Optional popupTemplate

A customized PopupTemplate for the selected feature.

Read more...

Optional portal

It is possible to search a specified portal instance's locator services Use this property to set this ArcGIS Portal instance to search.

Read more...

Optional resultGraphicEnabled

resultGraphicEnabled: boolean

Indicates if the resultGraphic will display at the location of the selected feature.

Read more...

Optional searchAllEnabled

searchAllEnabled: boolean

Indicates whether to display the option to search all sources.

Read more...

Optional searchTerm

searchTerm: string

The value of the search box input text string.

Read more...

Optional sources

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.

Read more...

Optional suggestionsEnabled

suggestionsEnabled: boolean

Enable suggestions for the widget.

Read more...

Optional view

view: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" })

A reference to the MapView or SceneView.

Read more...

Optional viewModel

The view model for this widget.

Read more...

Optional visible

visible: boolean

Indicates whether the widget is visible.

Read more...

Generated using TypeDoc