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

getWellKnownCatalog

Function

Get a single catalog based on the catalog name, entity type and optional requests

Parameters

Parameter Type Default Notes
i18nScope Required string

Translation scope to be interpolated into the catalog
catalogName Required WellKnownCatalog
entityType Required EntityType
options Optional IGetWellKnownCatalogOptions

An opitional IGetWellKnownCatalogOptions definition JSON object

Returns

An IHubCatalog definition JSON object

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/wellKnownCatalog.ts:72