Collection

Class

Collection Class

Abstracts searching a Collection

For more information, check out the Catalog & Collection Guide

Implements

Accessors

Accessor Type Notes
include string[]
key string
label string
scope IQuery
sortDirection "asc" | "desc"
sortField string
targetEntity EntityType

Methods

Method Returns Notes
Collection

Create an instance of a Collection from a JSON object

Promise<IHubSearchResponse<IHubSearchResult>>

Search the collection using a string or IQuery

IHubCollection

Return the JSON object backing the instance

fromJson

Static Static Class Method

Create an instance of a Collection from a JSON object

Parameters

Parameter Type Default Notes
collection Required IHubCollection
context Required IArcGISContext

Returns

toJson

Class Method

Return the JSON object backing the instance

Returns


Class defined in common/src/search/Collection.ts:18