嵌入式分析SDK - 收集

⚠️此功能处于测试版。您可以随意尝试,但请注意,某些内容可能会更改(并且可能无法按预期工作)。

嵌入式分析SDK仅在Pro企业计划(自托管和Metabase Cloud)上提供。但是,您可以使用API密钥通过API密钥验证您的嵌入式内容,在本地机器上使用SDK进行测试,而无需许可证。

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

CollectionBrowser属性

属性 类型 描述
collectionId 数字 集合的数字ID。您可以在访问您的Metabase实例中的集合时在URL中找到此ID。例如,在https://127.0.0.1:3000/collection/1-my-collection中的集合ID将是1。如果没有提供ID,集合浏览器将从根集合我们的分析开始,其ID为0。
onClick (item: CollectionItem) => void 一个可选的点击处理程序,它发出被点击的实体。
pageSize 数字 每页显示的项目数量。默认值为25。
visibleEntityTypes ["question", "model", "dashboard", "collection"] 应可见的实体类型。如果没有提供,将显示所有实体。

使用CollectionBrowser的示例嵌入代码

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);
  };

  // Define the collection item types you want to be visible
  const visibleEntityTypes = ["dashboard", "question", "collection"];

  return (
    <CollectionBrowser
      collectionId={collectionId}
      onClick={handleItemClick}
      pageSize={10}
      visibleEntityTypes={visibleEntityTypes}
    />
  );
}

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

想要改进这些文档吗? 提出更改。