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

initCatalogOnEntityCreate

Function

Initializes an returns a catalog to persist on Hub item entity upon creation based on user-configured options.

Initializes an returns a catalog to persist on Hub item entity upon creation based on user-configured options.

Parameters

Parameter Type Default Notes
entity Required IHubItemEntity

Hub item entity
catalogSetup Required ICatalogSetup

options for initializing the catalog
context Required IArcGISContext

contextual portal & auth information

Returns

Promise<IHubCatalog>
Property Type Notes
schemaVersion number

Schema Version
collections Optional IHubCollection[]

Collections within the Catalog
displayConfig Optional ICatalogDisplayConfig

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/initCatalogOnEntityCreate.ts:16