嵌入式分析 SDK - 集合

嵌入式分析 SDK 仅在 ProEnterprise 计划(包括自托管和 Metabase Cloud)中可用。

嵌入式集合浏览器

您可以嵌入 Metabase 的集合浏览器,以便用户可以从您的应用程序中探索 Metabase 中的项目。

CollectionBrowser

API参考

示例

import React from "react";
import { CollectionBrowser } from "@metabase/embedding-sdk-react";

export default function App() {
  const collectionId = 123; // This is the collection ID you want to browse
  const handleItemClick = item => {
    console.log("Clicked item:", item);
  };

  return (
    <CollectionBrowser
      collectionId={collectionId}
      onClick={handleItemClick}
      pageSize={10}
      // Define the collection item types you want to be visible
      visibleEntityTypes={["dashboard", "question", "collection"]}
    />
  );
}

属性

属性 类型 描述
className? 字符串 要添加到根元素的自定义类名。
collectionId? SdkCollectionId 集合的数字 ID,“personal” 表示用户的个人集合,或“root” 表示根集合。您可以在访问 Metabase 实例中的集合时在 URL 中找到此 ID。例如,在 https://:3000/collection/1-my-collection 中,集合 ID 将是 1。默认为“personal”。
EmptyContentComponent? | null | ComponentType 当集合中没有项目时显示的组件。
onClick? (item: MetabaseCollectionItem) => void 点击项目时调用的函数。
pageSize? number 每页显示的项目数量。默认为25。
style? CSSProperties 要添加到根元素的自定义样式对象。
visibleColumns? CollectionBrowserListColumns[] 集合项目表中要显示的列。如果未提供,则显示所有列。
visibleEntityTypes? ("collection" | "dashboard" | "question" | "model")[] 应可见的实体类型。如果未提供,则显示所有实体。

隐藏集合选择器,并硬编码用户可以保存内容的集合。

对于静态问题,您可以将特定集合设置为用户可以保存项目的集合,这样他们就不必费心选择集合。要硬编码一个集合,

  1. isSaveEnabled 设置为 true。
  2. targetCollection 设置为您希望用户保存项目的集合 ID。

有关更多选项,请参阅 问题属性

阅读其他版本的 Metabase 的文档。

这有帮助吗?

感谢您的反馈!
想改进这些文档吗? 提议更改。
© . This site is unofficial and not affiliated with Metabase, Inc.