Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents search query parameters for a Geocortex Search.

Hierarchy

  • SearchQuery

Index

Properties

contains

contains: boolean

The 'contains' parameter determines whether to look for an exact match of the search text or not. If "true", searches for a value that contains the searchText provided. This is a case-insensitive search. If "false", searches for an exact match of the searchText string. The exact match is case-sensitive. The default is "true".

extent

extent: Extent

The extent to search within.

maxResults

maxResults: number

The maximum number of results to return.

outSpatialReference

outSpatialReference: SpatialReference

The {@link esri.SpatialReference} for the returned geometries. If not specified, the output geometries are returned in the default spatial reference of WKID 4326 (WGS84).

returnCountOnly

returnCountOnly: boolean

If "true", the response only includes the count (number of features / records) that would be returned by a search. Otherwise the response is a feature set. The default is "false". This option supersedes the returnIdsOnly parameter.

returnGeometry

returnGeometry: boolean

If "true", the result set will include the geometry associated with each result. The default is "false".

returnHighlights

returnHighlights: boolean

Indicates whether or not to return the results of the search highlighted in the given fields. Those results can be found on the feature's extended attributes property.

returnIdsOnly

returnIdsOnly: boolean

If "true", the response only includes an array of object IDs. Otherwise the response is a feature set. The default is "false".

searchLayers

searchLayers: Layer[]

The layers to search.

searchText

searchText: string

The search text string parameter.

Methods

toJson

  • toJson(esriMap: Map, essentialsMap: Map): any
  • Converts these parameters into a JSON object.

    Parameters

    • esriMap: Map
    • essentialsMap: Map

      The {@link essentials.Map}.

    Returns any