Smartbi报表宏api

显示:

spreadsheetReport

电子表格对象

方法

cellIndexToString

(
  • row
  • column
  • dollar
)
String

获取单元格下标

参数:

  • row int

    行

  • column int

    列

  • dollar Boolean

    是否添加 $ 符号

返回值:

String:

单元格下标

示例:

function main(spreadsheetReport, isAjaxRefreshCallback) {
    var str = spreadsheetReport.cellIndexToString(0, 0, false);
    console.log(str); // 输出："A1"
    str = spreadsheetReport.cellIndexToString(0, 0, true);
    console.log(str); // 输出："$A$1"
}

doAjaxRefresh

()

局部刷新

doRefresh

()

刷新

getCell

(
  • row
  • column
)
Object

获取单元格

参数:

  • row int

    行

  • column int

    列

返回值:

Object:

单元格所在的HTML DOM元素

getCell

(
  • cellName
)
Object

获取单元格

参数:

  • cellName String

    单元格名称，如 "A1"、"B2"、"C3"等

返回值:

Object:

单元格所在的HTML DOM元素

getColumnCount

() int

获取列数

返回值:

int:

列数

getExpandedPositions

(
  • row
  • column
)
Array

获取单元格扩展后的位置

参数:

  • row int

    行索引

  • column int

    列索引

返回值:

Array:

扩展后的位置

示例:

//先在服务端宏中打印展开后的所有单元格到客户端：
function main(spreadsheetReport) {
    spreadsheetReport.printExpandedPositions();//打印展开后所有单元格
}

//在客户端宏中即可根据单元格名称获取到单元格位置：
function main(spreadsheetReport, isAjaxRefreshCallback) {
    var Pos = spreadsheetReport.getExpandedPositions("B3");
}

getParameterDisplayValue

(
  • name
  • [alias]
)
String

根据参数名称，获取参数显示值

参数:

  • name String

    参数名称

  • [alias] String optional

    参数别名

返回值:

String:

参数显示值

getParameterValue

(
  • name
)
String | Number

根据参数名称，获取参数真实值

参数:

  • name String

    参数名称

返回值:

String | Number:

参数真实值

getPictureFrameCell

(
  • name
  • cellName
)
Object

根据图形名称和单元格名称，获取单元格

参数:

  • name String

    图片名称

  • cellName String

    单元格名称

返回值:

Object:

单元格所在的HTML DOM元素

getPictureFrameCell

(
  • name
  • row
  • column
)
Object

根据图形名称、行索引、列索引，获取单元格

参数:

  • name String

    图片名称

  • row int

    行索引

  • column int

    列索引

返回值:

Object:

单元格所在的HTML DOM元素

getRowCount

() int

获取行数

返回值:

int:

行数

parseCellIndex

(
  • cellName
)
Array

解析单元格名称

参数:

  • cellName String

    单元格名称，如 "A1"、"B2"、"C3"等

返回值:

Array:

数组第一个值为行索引， 第二个值为列索引

示例:

function main(spreadsheetReport, isAjaxRefreshCallback) {
    var array = spreadsheetReport.parseCellIndex('C6');
    console.log(array); // 输出：[5, 2]
}

setParamsInfo

(
  • paramsInfo
)

设置参数值

参数:

  • paramsInfo Array

    参数信息数组

示例:

function main(spreadsheetReport) {
    var paramsInfo = spreadsheetReport.getParamsInfoValue();
    console.log(paramsInfo);
    // [{ alias: "年", displayValue: "2020", id: "OutputParameter.I8a8a9....kaohe_年", name: "年", value: "2020" }]
    paramsInfo.value = '2021';
    paramsInfo.displayValue = '2021';
    spreadsheetReport.setParamsInfo(paramsInfo);
}

setParamValue

(
  • paramId
  • paramValue
)

设置参数值

参数:

  • paramId String

    参数id

  • paramValue String

    参数值

示例:

function main(spreadsheetReport) {
    // 获取第一个参数的id并设置参数值为2020。
    var paramId = spreadsheetReport.params[0].id;
    spreadsheetReport.setParamValue(paramId, '2020');
}

属性

command

spreadsheetReportCommand

电子表格报表命令处理器

customProperties

Object

自定义属性

shapesMap

Object

当前工作表的图形，以spreadsheetReport.shapesMap["图形名称"]获取指定的图形

spreadsheetReportWriteBack

spreadsheetReportWriteBack

回写对象