Place Search Input

organizing infoorganizing info

The Place Search Input Web Control can find locations by address, returning a formatted address and location point to display on a Map Web Control. The default behavior for this control is to search the Google Maps Place Autocomplete API to return a list of suitable addresses.

General

Control Properties

Placeholder Text

Expects type text.

The text that is displayed in the search input before the user enters text.

Location

Expects type Place Object.

Displays the Place Object that can be entered as the point around which to retrieve place information. The important properties within the Place Object are the lattitude and longitude values.

Aria Label

Expects type text.

Defines a value to the aria-label of the control for accessibility. For more information see here.

Advanced Control Properties

Search Radius

Expects type number.

Distance within which to preference the search for place results within a specified distance (in meters). Inputting this value instructs the Google Places API to prefer showing results within that circle; results outside of the defined area may still be displayed.

Place Type

Displayes the string representing the type of place based on the available place types. Selecting this value restricts the types of places that can be returned.

Search Type

Displays the style of search. Supported types are:

  • Atocomplete
  • Query
  • Nearby

Rank By

Displays how returned search results are ordered. Options are:

  • Prominence: where search results are ordered by their prominence according to Google
  • Distance: where places are ordered by their distance from the set Location

If no Location has been set, search results will be ordered by Prominence, even if Distance is selected.

Data Binding

Expects type text.

By default, a Variable of type Text Functions is generated at the Web Page level to store the data from the input. Users can also edit the Data Binding property and create their own Variables.

Style and Layout

This control Variant has styles for the following states:

Default - When first rendered without state
Focused - when the control is focused
Disabled - When the control is disabled

Check Common style properties of web controls for further details on how to style your Place Input Web Control.

Actions

Changed

Events will be triggered upon user selection of a Place.

Search Results Changed

Events will be triggered upon the returned search results changing based on the user's input, only after a Place has already been selected by the user as indicated by actions being triggered under the Changed trigger.

Value Changed

Events will be triggered upon the text value entered by the app user changing. Each character change of the user's input is recognized as a value change.

Advanced

State

Is Visible

Expects type boolean.

If TRUE the control will be visible. If FALSE the control will not be displayed. If the field is empty, the control will be visible.

Is Disabled

Expects type boolean.

If TRUE the control will be disabled and the user will not be able to interact with the control. If FALSE the control will be enabled. If the field is empty, the control will be enabled.

Example

organizing infoorganizing info

User text input returns Places from the Google Places Autocomplete API.