一、即席查询宏界面

1、操作入口

即席查询宏入口：设置面板->交互->宏管理->设置

2、即席查询宏模块

• 类型

  • 客户端宏

• 对象

  • detailed_query

• 宏事件

  • onRender(打开报表后)

  • onBeforeRefresh(每次刷新前)

  • onAfterRefresh(每次刷新后)

3、宏代码编辑区

• main函数funcation main(...)

  • main函数是宏代码的入口函数，宏代码执行的时候会按照main函数里的逻辑顺序执行，声明的函数体不允许删除

• detailedQuery参数

  • detailedQuery即席查询宏内置的接口对象，属于IDetailedQuery的接口对象

二、即席查询宏演示

1、需求场景

即席查询有浏览模式和编辑模式可自由切换，有时候发布的报表不希望开放切换的入口的时候，就希望屏蔽掉其切换按钮。

2、代码示例

• 宏模块

• 示例代码

function main(detailedQuery: IDetailedQuery) {
    let toolbar: IDQueryToolbar = detailedQuery.getToolbar();
    toolbar.removeItem(1, 1);
}

• 关键对象方法

  • 获取即席查询工具栏：detailedQuery.getToolbar

  • 移除工具栏按钮：toolbar.removeItem(1,1)

• 参考示例

  • https://wiki.smartbi.com.cn/pages/viewpage.action?smt_poid=43&pageId=142967971

三、即席查询宏接口介绍

1、概述

即席查询宏需要使用TypeScript进行编写，提供的均为TypeScript接口。TypeScript是JavaScript类型的超集，它可以编译成纯JavaScript。

开发即席查询宏，就是通过Smartbi开放的TypeScript接口，对模型即席查询的页面或组件进行修改，实现定制化的效果。

2、组件接口说明

即席查询宏的接口如下表所示：

在实际的即席查询中，接口与实际页面的对应如下图所示：

四、视频教学

即席查询宏入门：https://my.smartbi.com.cn/edu/course-123