@cube-dev/embed-sdk (英语)

将 Cube 分析器嵌入到您的应用程序中 .

安装

yarn add @cube-dev/embed-sdk

同伴依赖关系

此软件包需要以下对等依赖性:

yarn add react react-dom @tanstack/react-query

快速启动

import { useState } from 'react';
import { EmbedProvider, createDefaultReport, useReportContext } from '@cube-dev/embed-sdk';
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';

const queryClient = new QueryClient();

function App() {
  const [report, setReport] = useState(() => createDefaultReport({ title: 'My Report' }));

  return (
    <QueryClientProvider client={queryClient}>
      <EmbedProvider
        token={cubeApiToken}
        apiUrl={cubeApiUrl}
        report={report}
        onReportUpdate={(updates) => setReport((prev) => ({ ...prev, ...updates }))}
      >
        <YourAnalyticsComponent />
      </EmbedProvider>
    </QueryClientProvider>
  );
}

出口

供应商

• EmbedProvider - 联合提供者包罗所有上下文
• CubeApiContextProvider - 立方体 API 客户端背景
• DataAssetsContextProvider - 数据资产和语义视图上下文
• ReportProvider - 报告国家管理背景
• ChartBuilderProvider - 图表建筑公用事业背景

钩子

• useReportContext - 进入报告状态和行动
• useChartBuilderContext - 出入图绘制设施
• useDataAssetsContext - 获取数据资产和语义视图
• useActiveCubeApi - 访问 Cube API 客户端
• useReport - 独立报告管理钩

公用事业

• createDefaultReport - 创建一个带有可选标题和 SQL 查询的新默认报告
• parseSemanticSql - 解析语义SQL查询
• generateSemanticSql - 从逻辑查询生成语义 SQL
• prepareTableData - 为表格渲染准备数据
• prepareChartColumns - 准备图表渲染的列

许可证

麻省理工学院