← See all guides

Configuring the Catalog Search View

This page provides instructions on how to customize a the main search page for a MetacatUI repository. This page is rendered by the Catalog Search View and includes a 3D map and a set of search filters. The map and filters can be set to suit the needs of the repository.

The 3D map uses the cesium.js library. For more information about Cesium and how to configure a Cesium Map model in general, see the general Cesium guide.

With the 2.25.0 release, MetacatUI introduced a new CatalogSearchView that renders the main search page. This new view replaces the DataCatalogView that used Google Maps. The DataCatalogView will be deprecated in a future release, but to give time for repositories to migrate to the new CatalogSearchView, the DataCatalogView will remain the default view for the time being.

To enable the new CatalogSearchView, set the following properties in your configuration file:

{
  "useDeprecatedDataCatalogView": false,
  "enableCesium": true,
  "cesiumToken": "YOUR-CESIUM-ION-TOKEN"
}

The cesiumToken only needs to be set in order to enable access to layers and assets from Cesium Ion. See the general Cesium guide for more information.

Customizing the search filters

The default filters to use on the left hand side of the Catalog Search View are set in the defaultFilterGroups property of the configuration file. This property is an array of objects that define the filters to use. See the guide about customizing search filters for more information.

Map config

Options for Search View’s map are set in the catalogSearchMapOptions property of the configuration file. This property is the same object used to define any Map model in MetacatUI. See the API docs for Map for complete documentation of the options.