A Collection is a subset of a Catalog, but can be used independently in Galleries


Property Type Notes
key string
label string
sortOption ISortOption
defaultQuery Optional string
facets Optional IFacet[]
filter Optional Filter<FilterType>
filterType Optional FilterType

Filter Type used in this collection

include Optional string[]

Specify the includes to be requested when working with this collection

scope Optional Array<IFilterGroup<FilterType>>

Scope is a set of FilterGroups which define the limits of the Collection. Typically it is just a set of group ids, but it may be arbitrarily complex. If one was to "search the collection", this is the description of what would be returned.

Interface defined in common/src/search/types/ICollection.ts:8