-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2127 from NCEAS/feature-#1720-cesium-data-catalog
New CatalogSearchView with configurable filters & Cesium map
- Loading branch information
Showing
85 changed files
with
9,493 additions
and
4,667 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
layout: guide | ||
title: Configuring the Catalog Search View | ||
id: catalog-view-config | ||
toc: true | ||
--- | ||
|
||
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](/guides/maps/cesium.html). | ||
|
||
With the x.x.x release, MetacatUI introduced a new [`CatalogSearchView`](/docs/CatalogSearchView.html) 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](/docs/AppConfig.html): | ||
|
||
```js | ||
{ | ||
"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](https://cesium.com/learn/ion/global-base-layers/). See the general [Cesium guide](/docs/guides/maps/cesium) 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`](/docs/AppConfig.html#defaultFilterGroups) property of the [configuration file](/docs/AppConfig.html). This property is an array of objects that define the filters to use. See the guide about [customizing search filters](/guides/filters/configuring-filters.html) for more information. | ||
|
||
## Map config | ||
|
||
Options for Search View's map are set in the [`catalogSearchMapOptions`](docs/AppConfig.html#catalogSearchMapOptions) property of the [configuration file](/docs/AppConfig.html). This property is the same object used to define any `Map` model in MetacatUI. See the API docs for [`Map`](/docs/MapConfig.html) for complete documentation of the options. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,12 @@ | ||
# MetacatUI Guides | ||
|
||
The following is a list of How To guides for customizing the display and functionality | ||
of your MetacatUI application. Is something missing? [Email us](mailto:metacat-dev@ecoinformatics.org) or join us on [Slack](https://slack.dataone.org/) and we'll add it. | ||
of your MetacatUI application. | ||
|
||
- <a href="{{ site.url }}/guides/accesspolicy.html">Access Policies</a> | ||
- <a href="{{ site.url }}/guides/filters/configuring-filters.html">Search Filters</a> | ||
- <a href="{{ site.url }}/guides/maps/cesium.html">Cesium Map</a> | ||
- <a href="{{ site.url }}/guides/accesspolicy.html">👥 Access Policies</a> | ||
- <a href="{{ site.url }}/guides/filters/configuring-filters.html">🔎 Search Filters</a> | ||
- <a href="{{ site.url }}/guides/catalog-view-config.html">📑 Catalog Search View</a> | ||
- <a href="{{ site.url }}/guides/maps/cesium.html">🌎 Cesium Map</a> | ||
- <a href="{{ site.url }}/guides/maps/cesium-for-portals.html">📍 Cesium Map for Portals</a> | ||
|
||
<b>ℹ️ Is something missing? [Email us](mailto:metacat-dev@ecoinformatics.org) or join us on [Slack](https://slack.dataone.org/) and we'll add it!</b> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
layout: guide | ||
title: Configuring Cesium Maps for Portals | ||
id: cesium-for-portals | ||
toc: true | ||
--- | ||
|
||
This page outlines the process of integrating a Cesium Map into a [Portal document](https://github.com/DataONEorg/collections-portals-schemas/blob/master/schemas/portals.xsd). | ||
|
||
For background on Cesium, as well as detailed guidelines on how to customize a Cesium Map model, please refer to our [Cesium guide](cesium). | ||
|
||
## How to Configure a Cesium Map Section within a Portal Document | ||
|
||
To integrate a Cesium map visualization into a portal XML document, you need to define the map's appearance and layering structure using JSON. This JSON configuration is then embedded into an `<option>` element which lies within a `<section>` element. The `<option>` element requires two distinct components: an `<optionName>` set as `mapConfig` and an `<optionValue>` that encompasses the aforementioned JSON configuration. Please ensure that the JSON is enclosed within `CDATA` tags. | ||
|
||
Here's an example: | ||
|
||
```xml | ||
<section> | ||
<label>My Cesium Map</label> | ||
<title>My Cesium Map</title> | ||
<option> | ||
<optionName>sectionType</optionName> | ||
<optionValue>visualization</optionValue> | ||
</option> | ||
<option> | ||
<optionName>visualizationType</optionName> | ||
<optionValue>cesium</optionValue> | ||
</option> | ||
<option> | ||
<optionName>mapConfig</optionName> | ||
<optionValue> | ||
<![CDATA[{ | ||
"homePosition": {...}, | ||
... | ||
"showFeatureInfo": false | ||
}]]> | ||
</optionValue> | ||
</option> | ||
</section> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.