自定义页面API-智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

本文为您详细介绍自定义页面API。

Lifecycle

自定义页面本质是一个生命周期对象，请参见生命周期。

LifecycleProps

LifecycleProps描述的是传入自定义页面各个生命周期的props参数类型。包含了container和customProps两个属性，其接口如下。详情参考LifecycleProps。

interface LifecycleProps {
  container?: HTMLElement;
  customProps?: CustomPage;
}

customProps

props.customProps 为自定义页面的上下文信息。其接口为：

interface CustomPage {
  pageConfig: ComponentPageConfig;
}

customProps.pageConfig

当前宿主页面的上下文信息。其接口为：

interface ComponentPageConfig {
  /** 当前访问者 id */
  userId: string;
  /** 当前访问者 账号名称 */
  userName: string;
  /** 当前页面路由 key */
  routeKey?: RouteKey;
}

您可以按需传入页面信息，具体路由Key及对应页面实现效果如下：

名称	路由 key	功能示例
企业门户（宿主页）	viewPortal
自定义页面管理页	customPage
企业门户配置页（物料栏）	orgAdminPcPortalApp