@datafinder/embed-sdk/dist/types/rendering.d.ts

Embed SDK for DataFinder

export interface ViewRenderingCallbacks {
    onReady?(): void;
}
/**
 * 渲染 DataFinder 页面的相关参数
 */
export interface ViewRenderingOptions extends Partial<ViewRenderingCallbacks> {
    /**
     * 嵌入 DataFinder 的应用 ID
     */
    appId: number;
    /**
     * 嵌入页面的域名
     *
     * 例如你需要接入 https://xxx.volces.com 提供的 Finder 页面，请传入 "https://xxx.volces.com"
     *
     * - 置空则默认为同域，并使用当前页面的域名
     */
    customDomain?: string;
    /**
     * DataFinder 应用的路径
     *
     * - 默认是 `'/datafinder'`
     */
    basePath?: string;
    /**
     * 如传入了 dorToken，则会通过 dorToken 作为鉴权方式渲染页面
     */
    dorToken?: string;
    /**
     * 接入方来源，用于数据统计
     */
    from?: string;
    /**
     * 是否需要 minibase 的重定向
     */
    needsMinibaseRedirect?: boolean;
    /**
     * 渲染 iframe 节点时的自定义 attrs。
     *
     * 默认为 `{ width: '100%', height: '100%', frameBorder: '0' }`
     */
    iframeAttrs?: Omit<HTMLIFrameElement, 'src'>;
    /**
     * 额外携带的 search params
     */
    customSearchParams?: Record<string, string>;
    /**
     * 自定义嵌入页面内请求的 headers
     */
    customRequestHeaders?: Record<string, string>;
}