@esri/hub.js
@esri/hub.js

buildCatalog

Function

Build an IHubCatalog definition JSON object based on a well-known catalog name, scope filters, and collections

Parameters

Parameter Type Default Notes
i18nScope Required string

i18n scope for the catalog title
catalogName Required string

well known catalog name
filters Required IFilter[]

filters to build the catalog scope
collections Required IHubCollection[]

collections to include in the catalog
targetEntity Required EntityType

target entity type for the catalog
title Optional string

optional title override for the catalog

Returns

IHubCatalog
Property Type Notes
schemaVersion number

Schema Version
collections Optional IHubCollection[]

Collections within the Catalog
displayConfig Optional IGalleryDisplayConfig

Optional display configuration to control a catalog's appearance in the UI
emojii Optional string

Optional Emoji to show in the UI
integrity Optional {
collections:
string
scopes:
string
}

Hashes to verify the integrity of the catalog Only verified when the catalog is loaded into the editor If the hashes do not match, the catalog will not be loaded and the user will simply have the option to reset the catalog
scopes Optional ICatalogScope

Filter defines the "scopes" of the Catalog, on a per entity type basis
title Optional string

Title for the Gallery
type Optional CatalogType
Function defined in common/src/search/_internal/buildCatalog.ts:15