> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# Analytics Catalog

> Embed the AnalyticsCatalog explorer to let users browse and search the metrics, attributes, facts, datasets, visualizations, and dashboards of a workspace.

API reference: [AnalyticsCatalog()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.analyticscatalog/index.md) (function)

[`AnalyticsCatalog`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.analyticscatalog/index.md) from `@gooddata/sdk-ui-catalog` renders an interactive explorer of the objects in a workspace, with search, filters, and a detail view of each object.

The explorer lists these object types:

| Object type | What it is |
| --- | --- |
| Metrics | Saved calculations defined in MAQL |
| Attributes | Descriptive dimensions for slicing data |
| Facts | Raw numeric columns available for aggregation |
| Datasets | Tables of the logical data model (LDM) that link facts and attributes |
| Visualizations | Saved visualizations |
| Dashboards | Saved dashboards |

## [Basic usage](https://www.gooddata.ai/docs/gooddata-ui/latest/ai-modules/analytics-catalog/#basic-usage)

[`AnalyticsCatalog`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.analyticscatalog/index.md) takes the backend and workspace from [`BackendProvider`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.backendprovider/index.md) and [`WorkspaceProvider`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.workspaceprovider/index.md), or from the `backend` and `workspace` props.

```tsx
import { AnalyticsCatalog } from "@gooddata/sdk-ui-catalog";

import "@gooddata/sdk-ui-catalog/styles/css/main.css";

export const CatalogPage = () => <AnalyticsCatalog workspace="<workspace-id>" />;
```

To handle a click on an object, for example to route to your own page, use `onCatalogItemNavigation` or `onCatalogItemOpenClick`. To open the detail of an object on first render, pass its reference in `openCatalogItemRef`.

## [Catalog objects in code](https://www.gooddata.ai/docs/gooddata-ui/latest/ai-modules/analytics-catalog/#catalog-objects-in-code)

The explorer is a UI. To use catalog objects in your own code:

- For typed references at build time, generate a catalog file with `catalog-export`. See [Export catalog](https://www.gooddata.ai/docs/gooddata-ui/latest/data-layer/data-model/export-catalog/index.md) and [typed references with the metadata catalog](https://www.gooddata.ai/docs/gooddata-ui/latest/getting-started/installation/index.md#optional-typed-references-with-the-metadata-catalog).
- To load the catalog at runtime, use `backend.workspace(workspaceId).catalog().load()`. See [Load the workspace catalog at runtime](https://www.gooddata.ai/docs/gooddata-ui/latest/data-layer/data-model/workspace-catalog/index.md).

## [Props](https://www.gooddata.ai/docs/gooddata-ui/latest/ai-modules/analytics-catalog/#props)

| Prop | Type | Required | Description | Inherited from |
|------|------|----------|-------------|----------------|
| [`backend`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.ianalyticscatalogprops/index.md#ianalyticscatalogpropsbackend) | [`IAnalyticalBackend`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | No | An analytical backend to use within the analytics catalog. Can be omitted and taken from context. | — |
| [`locale`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.ianalyticscatalogprops/index.md#ianalyticscatalogpropslocale) | `string` | No | A locale to use for translations. Can be omitted and taken from context. | — |
| [`onCatalogDetailClosed`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.ianalyticscatalogprops/index.md#ianalyticscatalogpropsoncatalogdetailclosed) | `() => void` | No | Handler when closing catalog detail. | — |
| [`onCatalogDetailOpened`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.ianalyticscatalogprops/index.md#ianalyticscatalogpropsoncatalogdetailopened) | `(ref:` [`ICatalogItemRef`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.icatalogitemref/index.md)`) => void` | No | Handler when opening catalog detail. | — |
| [`onCatalogItemNavigation`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.ianalyticscatalogprops/index.md#ianalyticscatalogpropsoncatalogitemnavigation) | `(event: MouseEvent, ref:` [`ICatalogItemRef`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.icatalogitemref/index.md)`) => void` | No | Handler for navigating to a catalog item. Consumers can handle route changes. | — |
| [`onCatalogItemOpenClick`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.ianalyticscatalogprops/index.md#ianalyticscatalogpropsoncatalogitemopenclick) | `(e: MouseEvent, linkClickEvent:` [`OpenHandlerEvent`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.openhandlerevent/index.md)`) => void` | No | Handler for opening catalog items. | — |
| [`onCreateObject`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.ianalyticscatalogprops/index.md#ianalyticscatalogpropsoncreateobject) | `(objectType:` [`CatalogCreateObjectType`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.catalogcreateobjecttype/index.md)`) => void` | No | Handler for creating a new object from the catalog header. | — |
| [`openCatalogItemRef`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.ianalyticscatalogprops/index.md#ianalyticscatalogpropsopencatalogitemref) | [`ICatalogItemRef`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.icatalogitemref/index.md) | No | Reference to the catalog item to open on initial render. | — |
| [`workspace`](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-catalog/sdk-ui-catalog.ianalyticscatalogprops/index.md#ianalyticscatalogpropsworkspace) | `string` | No | A workspace to use within the analytics catalog. Can be omitted and taken from context. | — |