向下钻取 API

  • 版本 :2023.1(当前版本)

向下钻取 API

向下钻取 API 支持创建一个无需用户交互即可自行触发向下钻取操作的视觉对象。

API 使视觉对象能够根据传递给 API 的参数显示下一个级别、扩展到下一个级别或向上钻取。 有关向下钻取的详细信息,请参阅向下钻取支持。

备注

向下钻取 API 从 API 版本 4.7 开始提供。若要了解正在使用的版本,请查看 pbiviz.json 文件中的 apiVersion

如何使用向下钻取 API

将以下内容添加到 capabilities.json 文件中:

JSON复制

    "drilldown": {        "roles": ["Rows", "Columns"]
}

示例:向下钻取 API

以下示例显示视觉对象如何调用向下钻取操作。

TypeScript复制

public update(options: VisualUpdateOptions) {        
if ((options.dataViews[0].metadata.dataRoles.drillableRoles['Columns']).indexOf(powerbi.DrillType.Down) >= 0) {
let args: powerbi.DrillDownArgs = {
roleName: "Columns",
drillType: powerbi.DrillType.Down
}; this.host.drill(args);
}