dingtalk-docs-cool-app

export interface Workbook { /** * insertSheet() * 插入工作表 * @return {Sheet} 新增加的工作表 */ insertSheet(): Sheet; /** * insertSheet(name) * 插入工作表，并指定名字 * @param {string} name 指定新工作表名字 * @return {Sheet} 新增加的工作表 */ insertSheet(name: string): Sheet; /** * insertSheet(index) * 插入工作表，并指定位置 * @param {number} index 指定新工作表位置，从 0 开始 * @return {Sheet} 新增加的工作表 */ insertSheet(index: number): Sheet; /** * insertSheet(name, index) * 插入工作表，并指定名字和位置 * @param {string} name 指定新工作表名字 * @param {number} index 指定新工作表位置，从 0 开始 * @return {Sheet} 新增加的工作表 */ insertSheet(name: string, index: number): Sheet; /** * moveSheet(sheet, targetIndex) * * 移动 Worksheet 到指定位置 * @param {Sheet | string} sheet 要移动的目标工作表对象、ID或名字。 * @param {number} targetIndex 目标的索引位置 * @return {Workbook} workbook 实例本身，便于链式调用 */ moveSheet(sheet: Sheet | string, targetIndex: number): Workbook; /** * duplicateSheet(sheet, title) * * 复制工作表 * @param {Sheet | string} sheet 源工作表的对象、ID或名字。 * @param {string} name 新工作表名称，默认为自增 * @returns {Sheet} sheet 新工作表对象 */ duplicateSheet(sheet: Sheet | string, name?: string): Sheet; /** * deleteSheet(sheet) * * 删除工作表 * @param {string} sheet 工作表对象、ID或名字。 * @return {Workbook} workbook 实例本身，便于链式调用 */ deleteSheet(sheet: Sheet | string): Workbook; /** * setActiveSheet(sheet) * * 激活工作表 * @param {Sheet} sheet 想激活的工作表对象、ID或名字。 * @return {Sheet} sheet 实例，便于链式调用 */ setActiveSheet(sheet: Sheet | string): Sheet; /** * getSheets() * * 获取所有的工作表 * @return {Sheet[]} 所有的工作表 */ getSheets(): Sheet[]; /** * getSheetCount() * * 获取工作表的数量 * @return {number} 工作表的数量 */ getSheetCount(): number; /** * getActiveSheet() * * 获取当前激活的工作表 * @return {Sheet} 当前激活的工作表 */ getActiveSheet(): Sheet; /** * getSheet(key) * * 根据 ID 或者 name 获取工作表 * @param {string} key 工作表的 ID 或者 name * @return {Sheet | null} 查询到的工作表，null 表示没有查到 */ getSheet(key: string): Sheet | null; /** * getRange(a1Notation) * * 获取当前工作表的选区范围 * @param {string} a1Notation 选区地址 * @return {Range} 选区 */ getRange(a1Notation: string): Range; /** * getRange(row, column, rowCount, columnCount) * * 获取当前工作表的选区范围 * @param {number} row 行，从 0 开始 * @param {number} column 列，从 0 开始 * @param {number} rowCount 行数，从 1 开始 * @param {number} columnCount 列数，从 1 开始 * @return {Range} 选区 */ getRange(row: number, column: number, rowCount: number, columnCount: number): Range; /** * getActiveCell() * * 获取 activeCell * @return {Range} activeCell */ getActiveCell(): Range | null; /** * getActiveRange() * * 获取 activeCell 所在的选区 * @return {Range | null} activeCell 所在的选区 */ getActiveRange(): Range | null; /** * getRangeList(a1Notations) * * 获取多选区 * @return {RangeList | null} 多选区 */ getRangeList(a1Notations: string[]): RangeList; /** * getActiveRangeList() * * 获取当前多选区 * @return {RangeList} 多选区 */ getActiveRangeList(): RangeList | null; newFilterCriteriaBuilder(): FilterCriteriaBuilder; /** * newImageValueBuilder() * * 创建图片单元格值构造器 * @return {ImageValueBuilder} 图片单元格值构造器 */ newImageValueBuilder(): ImageValueBuilder; /** * newColorBuilder() * * 创建颜色构造器 * @returns {ColorBuilder} 颜色构造器 */ newColorBuilder(): ColorBuilder; /** * newAppProtectionBuilder() * * 创建酷应用锁定构造器 * @returns {AppProtectionBuilder} 酷应用锁定构造器 */ newAppProtectionBuilder(): AppProtectionBuilder; /** * newMentionValueBuilder() * * 创建@人构造器 * @returns {MentionValueBuilder} @人构造器 */ newMentionValueBuilder(): MentionValueBuilder; /** * getUserAsync() * * 创建用户对象 * @returns {User} 用户对象 */ getUserAsync(userId: string): Promise<User>; /** * 获取表格ID * * @returns 表格ID */ getId(): string; /** * 获取当前表格是否已保存 */ isSaved(): boolean; } export interface Sheet { /** * activate() * * 激活本身 * @return {Sheet} sheet 实例，便于链式调用 */ activate(): Sheet; /** * getId() * * 获取 ID * @return {string} 工作表的 ID */ getId(): string; /** * getIndex() * * 获取工作表的索引 * @return {number} 工作表的索引 */ getIndex(): number; /** * getName() * * 获取工作表的名字 * @return {string} 工作表的名字 */ getName(): string; /** * setTabColor(color) * * 设置 sheet 颜色 * @param {string | null} color 颜色 * @return {Sheet} sheet 实例，便于链式调用 */ setTabColor(color: string | null): Sheet; /** * getTabColor() * * 获取 sheet 颜色 * @return {Color} color 颜色，null 表示没有颜色 */ getTabColor(): Color | null; /** * setName(name) * * 设置名字 * @param {string} name 新名字 * @return {Sheet} sheet 实例，便于链式调用 */ setName(name: string): Sheet; /** * getVisibility() * * 获取可不可见 * @return {'visible' | 'hidden'} 可不可见 */ getVisibility(): SheetVisibility; /** * setVisibility(visibility) * * 设置可见性 * @param {'visible' | 'hidden'} visibility 可见性; * @return {Sheet} sheet 实例，便于链式调用 */ setVisibility(visibility: SheetVisibility): Sheet; /** * getGridlinesVisibility() * * 获取网格线可不可见 * @return {'visible' | 'hidden'} 可不可见 */ getGridlinesVisibility(): GridlinesVisibility; /** * setGridlinesVisibility(visibility) * * 设置网格线可见性 * @param {'visible' | 'hidden'} visibility 可见性; * @return {Sheet} sheet 实例，便于链式调用 */ setGridlinesVisibility(visibility: GridlinesVisibility): Sheet; /** * getFrozenColumnCount() * * 获取冻结的列 * @return {number} 列数，从 1 开始，0表示不冻结 */ getFrozenColumnCount(): number; /** * getFrozenRowCount() * * 获取冻结的行 * @return {number} 行数，从 1 开始，0表示不冻结 */ getFrozenRowCount(): number; /** * setFrozenColumnCount(columnCount) * * 设置冻结列 * @param {number} columnCount 列数，从 1 开始，0表示不冻结; * @return {Sheet} sheet 实例，便于链式调用 */ setFrozenColumnCount(columnCount: number): Sheet; /** * setFrozenRowCount(rowCount) * * 设置冻结行 * @param {number} rowCount 行数，从 1 开始; * @return {Sheet} sheet 实例，便于链式调用 */ setFrozenRowCount(rowCount: number): Sheet; /** * getColumnCount() * * 获取当前 sheet 的列数 * @return {number} 工作表的列数 */ getColumnCount(): number; /** * getRowCount() * * 获取当前 sheet 的行数 * @return {number} 工作表的行数 */ getRowCount(): number; /** * setActiveRange(a1Notation) * * 激活选区 * @param {string} a1Notation 选区的 en-us 的 A1 notation。 * @return {Range} range 选区，便于链式调用 * */ setActiveRange(a1Notation: string): Range; /** * setActiveRange(range) * * 激活选区 * @param {Range} range 选区 * @return {Range} range 选区，便于链式调用 */ setActiveRange(range: Range): Range; /** * getActiveRange() * * 获取 activeCell 所在的选区 * @return {Range | null} activeCell 所在的选区 */ getActiveRange(): Range | null; /** * getEntireSheet() * * 获取整表区域 * @return {Range} 整表区域 */ getEntireSheet(): Range; /** * getEntireRows(row) * * 获取整行 * @param {number} row 起始行 * @return {Range | null} 整行区域 */ getEntireRows(row: number): Range; /** * getEntireRows(row, rowCount) * * 获取整行 * @param {number} row 起始行 * @param {Optional number} rowCount 行数 * @return {Range | null} 整行区域 */ getEntireRows(row: number, rowCount: number): Range; /** * getEntireColumns(column) * * 获取整列 * @param {number} column 起始列 * @return {Range | null} 整列区域 */ getEntireColumns(column: number): Range; /** * getEntireColumns(column, columnCount) * * 获取整列 * @param {number} column 起始列 * @param {Optional number} columnCount 列数 * @return {Range | null} 整列区域 */ getEntireColumns(column: number, columnCount: number): Range; /** * getRange(a1Notation) * * 获取选区范围 * @param {string} a1Notation 选区地址 * @return {Range} 选区 */ getRange(a1Notation: string): Range; /** * getRange(row, column, rowCount, columnCount) * * 获取选区范围 * @param {number} row 行，从 0 开始 * @param {number} column 列，从 0 开始 * @param {number} rowCount 行数，从 1 开始 * @param {number} columnCount 列数，从 1 开始 * @return {Range} 选区 */ getRange(row: number, column: number, rowCount: number, columnCount: number): Range; /** * setActiveRangeList(a1Notations) * * 激活多选区 * @param {string[]} a1Notations 选区地址数组 * @return {RangeList} 多选区 * * @param {RangeList} rangeList 多选区 * @return {RangeList} 多选区 */ setActiveRangeList(a1Notations: string[]): RangeList; /** * setActiveRangeList(rangeList) * * 激活多选区 * @param {RangeList} rangeList 多选区 * @return {RangeList} 多选区 */ setActiveRangeList(rangeList: RangeList): RangeList; /** * getActiveRangeList() * * 获取激活的多选区 * @return {RangeList} 多选区 */ getActiveRangeList(): RangeList | null; /** * getRangeList(a1Notations) * * 获取多选区 * @param {string[]} a1Notations 选区地址数组 * @return {RangeList} 多选区 */ getRangeList(a1Notations: string[]): RangeList; /** * getActiveCell() * * 获取当前单元格 * @return {Range} 当前单元格 */ getActiveCell(): Range | null; /** * getCell(row, column) * * 获取单元格 * @param {number} row 行 * @param {number} column 列 * @return {Range} 单元格 */ getCell(row: number, column: number): Range; /** * setRowsVisibility(row, rowCount, visibility) * * 显示/隐藏多行 * @param {number} row 行 * @param {number} rowCount 行数 * @param {'visible' | 'hidden'} visibility 可见性 * @return {Sheet} sheet 实例，便于链式调用 */ setRowsVisibility(row: number, rowCount: number, visibility: RowVisibility): Sheet; /** * setRowVisibility(row, visibility) * * 显示/隐藏单行 * @param {number} row 行 * @param {'visible' | 'hidden'} visibility 可见性 * @return {Sheet} sheet 实例，便于链式调用 */ setRowVisibility(row: number, visibility: RowVisibility): Sheet; /** * setColumnsVisibility(column, columnCount) * * 显示/隐藏多列 * @param {number} column 列 * @param {number} columnCount 列数 * @param {'visible' | 'hidden'} visibility 可见性 * @return {Sheet} sheet 实例，便于链式调用 */ setColumnsVisibility(column: number, columnCount: number, visibility: ColumnVisibility): Sheet; /** * setColumnVisibility(column, visibility) * * 显示/隐藏单列 * @param {number} column 列 * @param {'visible' | 'hidden'} visibility 可见性 * @return {Sheet} sheet 实例，便于链式调用 */ setColumnVisibility(column: number, visibility: ColumnVisibility): Sheet; /** * getRowVisibility(row) * * 获取行的可见性 * @param {number} row 行 * @return {'visible' | 'hidden'} 可见性 */ getRowVisibility(row: number): RowVisibility; /** * getColumnVisibility(column) * * 获取列的可见性 * @param {number} column 列 * @return {'visible' | 'hidden'} 可见性 */ getColumnVisibility(column: number): ColumnVisibility; /** * setRowsHeight(row, rowCount, height) * * 设置多行的高度 * @param {number} row 行 * @param {number} rowCount 行数 * @param {number} height 高度 * @return {Sheet} sheet 实例，便于链式调用 */ setRowsHeight(row: number, rowCount: number, height: number): Sheet; /** * setRowHeight(row, height) * * 设置单行的高度 * @param {number} row 行 * @param {number} height 高度 * @return {Sheet} sheet 实例，便于链式调用 */ setRowHeight(row: number, height: number): Sheet; /** * getRowHeight(row) * * 获取行高 * @param {number} row 行 * @return {number} 行高 */ getRowHeight(row: number): number; /** * setColumnsWidth(column, columnCount, width) * * 设置列宽 * @param {number} column 列 * @param {number} columnCount 列数 * @param {number} width 高度 * @return {Sheet} sheet 实例，便于链式调用 */ setColumnsWidth(column: number, columnCount: number, width: number): Sheet; /** * setColumnWidth(column, width) * * 设置列宽 * @param {number} column 列 * @param {number} width 高度 * @return {Sheet} sheet 实例，便于链式调用 */ setColumnWidth(column: number, width: number): Sheet; /** * getColumnWidth(column) * * 获取列高 * @param {number} column 列 * @return {number} 列宽 */ getColumnWidth(column: number): number; /** * insertRowBefore(row) * * 在 row 行之前插入 1 行 * @param {number} row 行 * @return {Sheet} sheet 实例，便于链式调用 */ insertRowBefore(row: number): Sheet; /** * insertRowsBefore(row, rowCount) * * 在 row 行之前插入 n 行 * @param {number} row 行 * @param {number} rowCount 行数 * @return {Sheet} sheet 实例，便于链式调用 */ insertRowsBefore(row: number, rowCount: number): Sheet; /** * insertRowAfter(row) * * 在 row 行之后插入 1 行 * @param {number} row 行 * @return {Sheet} sheet 实例，便于链式调用 */ insertRowAfter(row: number): Sheet; /** * insertRowsAfter(row, rowCount) * * 在 row 行之后插入 n 行 * @param {number} row 行 * @param {number} rowCount 行数 * @return {Sheet} sheet 实例，便于链式调用 */ insertRowsAfter(row: number, rowCount: number): Sheet; /** * insertColumnBefore(column) * * 在 column 行之前插入 1 列 * @param {number} column 列 * @return {Sheet} sheet 实例，便于链式调用 */ insertColumnBefore(column: number): Sheet; /** * insertColumnsBefore(column, columnCount) * * 在 column 行之前插入 n 列 * @param {number} column 列 * @param {number} columnCount 列数 * @return {Sheet} sheet 实例，便于链式调用 */ insertColumnsBefore(column: number, columnCount: number): Sheet; /** * insertColumnAfter(column) * * 在 column 行之后插入 1 列 * @param {number} column 列 * @return {Sheet} sheet 实例，便于链式调用 */ insertColumnAfter(column: number): Sheet; /** * insertColumnAfter(column, columnCount) * * 在 column 行之后插入 n 列 * @param {number} column 列 * @param {number} columnCount 列数 * @return {Sheet} sheet 实例，便于链式调用 */ insertColumnsAfter(column: number, columnCount: number): Sheet; /** * deleteRows(row, rowCount) * * 删除行 * @param {number} row 行 * @param {number} rowCount 行数 * @return {Sheet} sheet 实例，便于链式调用 */ deleteRows(row: number, rowCount: number): Sheet; /** * deleteRow(row) * * 删除行 * @param {number} row 行 * @return {Sheet} sheet 实例，便于链式调用 */ deleteRow(row: number): Sheet; /** * deleteColumns(column, columnCount) * * 删除列 * @param {number} column 列 * @param {number} columnCount 列数 * @return {Sheet} sheet 实例，便于链式调用 */ deleteColumns(column: number, columnCount: number): Sheet; /** * deleteColumn(column) * * 删除列 * @param {number} column 列 * @return {Sheet} sheet 实例，便于链式调用 */ deleteColumn(column: number): Sheet; /** * getImageValues()[skip-to-doc] * * 获取所有的图片的 url * @return {string[]} url 数组 */ getImageValues(): string[]; /** * findAll(text) * * 在当前工作表中，根据指定的条件查找匹配给定字符串的所有Range，以Range[]形式返回 * @param {string} text 要查找的字符串。 * @return {Range[]} Range[] 所有匹配到的数组 */ findAll(text: string): Range[]; /** * findAll(text, findOptions) * * 在当前工作表中，根据指定的条件查找匹配给定字符串的所有Range，以Range[]形式返回 * @param {string} text 要查找的字符串。 * @param {SearchOptions | undefined} findOptions 其他搜索条件，包括搜索范围，搜索是否需要匹配整个单元格、区分大小写、是否使用正则、是否匹配公式等 * @return {Range[]} Range[] 所有匹配到的数组 */ findAll(text: string, findOptions: SearchOptions): Range[]; /** * replaceAll(text, replaceText) * * 在当前工作表中，根据指定的条件查找并替换给定的字符串。 * @param {string} text 要查找的字符串。 * @param {string} replaceText 替换原始字符串的字符串。 * @return {number} 执行的替换数，可能与匹配单元格的数目不同。 */ replaceAll(text: string, replaceText: string): number; /** * replaceAll(text, replaceText, replaceOptions) * * 在当前工作表中，根据指定的条件查找并替换给定的字符串。 * @param {string} text 要查找的字符串。 * @param {string} replaceText 替换原始字符串的字符串。 * @param {SearchOptions | undefined} replaceOptions 其他替换条件，包括搜索范围，是否需要匹配整个单元格、区分大小写、是否使用正则、是否匹配公式等 * @return {number} 执行的替换数，可能与匹配单元格的数目不同。 */ replaceAll(text: string, replaceText: string, replaceOptions: SearchOptions): number; /** * filter(range) * * 筛选 * @param {Range | string} range 筛选范围 * @return {Filter} Filter 实例 */ filter(range: Range | string): Filter; /** * getFilter() * * 获取当前sheet上的filter实例 * @return {Filter ｜ null} Filter 实例 */ getFilter(): Filter | null; /** * deleteFilter() * * 删除当前sheet上的filter * @return {Sheet} sheet 实例，便于链式调用 */ deleteFilter(): Sheet; /** * insertFilterView(range, name) * * 创建筛选视图 * @param {Range | string} range 筛选视图的筛选范围 * @param {string} name 筛选视图名字 * @return {FilterView} FilterView 实例 */ insertFilterView(range: Range | string, name: string): FilterView; /** * getFilterView(filterViewId) * * 获取当前sheet上对应的筛选视图实例 * @param {string} filterViewId 筛选视图id * @return {FilterView ｜ null} FilterView 实例 */ getFilterView(filterViewId: string): FilterView | null; /** * deleteFilterView(filterViewId) * * 删除当前sheet上对应的筛选视图 * @param {FilterView | string} filterView 筛选视图实例 | 筛选视图id * @return {Sheet} sheet 实例，便于链式调用 */ deleteFilterView(filterView: string | FilterView): Sheet; /** * getFilterViews() * * 获取当前sheet上所有的筛选视图 * @return {FilterView[]} FilterView 实例数组 */ getFilterViews(): FilterView[]; /** * setActiveFilterView(null) * * 退出筛选视图 * @return {null} null */ setActiveFilterView(filterView: null): null; /** * setActiveFilterView(filterView) * * 激活指定的筛选视图 * @return {FilterView} FilterView 实例 */ setActiveFilterView(filterView: string | FilterView): FilterView; /** * insertAppProtection(protection) * * 对整个工作表添加酷应用锁定 * @param {AppProtection} protection 酷应用锁定 * @returns {AppProtection} 酷应用锁定信息 */ insertAppProtection(protection: AppProtection): AppProtection; /** * getAppProtections() * * 获取工作表内所有酷应用锁定区域 * @returns {AppProtection[]} 酷应用锁定信息列表 */ getAppProtections(): AppProtection[]; /** * getAppProtection(id) * * 获取区域内指定酷应用锁定信息 * @param {string} id 酷应用锁定id * @returns {AppProtection | null} 酷应用锁定信息 */ getAppProtection(id: string): AppProtection | null; /** * deleteAppProtection(id) * * 删除指定酷应用锁定 * @param {string} id 酷应用锁定id * @returns {Range} Range */ deleteAppProtection(id: string): Range; /** * updateAppProtection(id, protectionConfig) * * 更新工作表内指定酷应用锁定的配置 * @param {string} id 酷应用锁定id * @param {AppProtection} protectionConfig 酷应用锁定配置 */ updateAppProtection(id: string, protectionConfig: AppProtection): Sheet; } export interface Range { /** * isEntireSheet() * * 是否是整个工作表区域 * @return {boolean} 是否是整个工作表区域 */ isEntireSheet(): boolean; /** * isEntireRow() * * 是否是整行 * @return {boolean} 是否是整行 */ isEntireRow(): boolean; /** * isEntireColumn() * * 是否是整列 * @return {boolean} 是否是整列 */ isEntireColumn(): boolean; /** * isCell() * * 是否是单元格 * @return {boolean} 是否是单元格 */ isCell(): boolean; /** * activate() * * 激活选区 * @return {Range} 区域 */ activate(): Range; /** * clear() * * 清除样式和数据 * @return {Range} 选区 */ clear(): Range; /** * clearFormat() * * 清除格式 * @return {Range} 选区 */ clearFormat(): Range; /** * clearData() * * 清除数据 * @return {Range} 选区 */ clearData(): Range; /** * setBackgroundColor(backgroundColor) * * 设置选区单元格背景颜色 * @param {string | null} backgroundColor 背景颜色, null 表示清除 * @return {Range} 选区 */ setBackgroundColor(backgroundColor: string | null): Range; /** * getBackgroundColor() * * 获取左上角单元格背景色 * @return {Color | null} 背景颜色，null 表示没有设置 */ getBackgroundColor(): Color | null; /** * getBackgroundColors() * * 获取区域单元格的背景色 * @return {Array<Array<Color | null>>} 背景颜色，二维数组，null 表示没有设置 */ getBackgroundColors(): Array<Array<Color | null>>; /** * setFontColor(fontColor) * * 设置字体颜色 * @param {string | null} fontColor 字体颜色, null 表示清除 * @return {Range} 选区 */ setFontColor(fontColor: string | null): Range; /** * getFontColor() * * 获取字体颜色 * @return {Color | null} 字体颜色 */ getFontColor(): Color | null; /** * getFontColors() * * 获取字体颜色 * @return {Array<Array<Color | null>>} 字体颜色 */ getFontColors(): Array<Array<Color | null>>; /** * setFontFamily(fontFamily) * * 设置字体 * @param {string | null} fontFamily 字体, null 表示清除 * @return {Range} 选区 */ setFontFamily(fontFamily: string | null): Range; /** * getFontFamily() * * 获取字体 * @return {string | null} 字体 */ getFontFamily(): string | null; /** * getFontFamilies() * * 获取字体 * @return {Array<Array<string | null>>} 字体 */ getFontFamilies(): Array<Array<string | null>>; /** * setFontSize(fontSize) * * 设置字体大小 * @param {number | null} fontSize 字体大小, null 表示清除 * @return {Range} 选区 */ setFontSize(fontSize: number | null): Range; /** * getFontSize() * * 获取字体大小 * @return {number | null} 字体大小 */ getFontSize(): number | null; /** * getFontSizes() * * 获取字体大小 * @return {Array<Array<number | null>} 字体大小 */ getFontSizes(): Array<Array<number | null>>; /** * setFontWeight(fontWeight) * * 设置字体粗体 * @param {'bold' | 'normal' | null} fontWeight 字体粗细, null 表示清除 * @return {Range} 选区 */ setFontWeight(fontWeight: FontWeight | null): Range; /** * getFontWeight() * * 获取字体粗体 * @return {'bold' | 'normal' | null} 字体粗体, null 表示清除 */ getFontWeight(): FontWeight | null; /** * getFontWeights() * * 获取字体粗体 * @return {Array<Array<'bold' | 'normal' | null>>} 字体粗体, null 表示没有设置 */ getFontWeights(): Array<Array<FontWeight | null>>; /** * setFontStyle(fontStyle) * * 设置字体样式 * @param {'italic' | 'normal' | null} fontStyle 字体样式, null 表示清除 * @return {Range} 选区 */ setFontStyle(fontStyle: FontStyle | null): Range; /** * getFontStyle() * * 获取字体样式 * @return {'italic' | 'normal' | null} 字体样式, null 表示没有设置 */ getFontStyle(): FontStyle | null; /** * getFontStyle() * * 获取字体样式 * @return {Array<Array<'italic' | 'normal' | null>>} 字体样式, null 表示清除 */ getFontStyles(): Array<Array<FontStyle | null>>; /** * setIndent(indent) * * @param {number | null} indent 缩进，必须为正整数，null 表示清除 * @returns {Range} 选区 */ setIndent(indent: number | null): Range; /** * getIndent() * * 获取缩进 * @returns {number | null} 缩进，null 表示没有设置 */ getIndent(): number | null; /** * getIndents() * * 获取缩进 * @returns {Array<Array<number | null>>} 缩进，null 表示没有设置 */ getIndents(): Array<Array<number | null>>; /** * setHorizontalAlignment(alignment) * * 设置水平对齐方式 * @param {'left' | 'center' | 'right' | 'general' | null} horizontalAlignment 水平对齐方式, null 表示清除 * @return {Range} 选区 */ setHorizontalAlignment(horizontalAlignment: HorizontalAlignment | null): Range; /** * getHorizontalAlignment() * * 获取水平对齐方式 * @return {'left' | 'center' | 'right' | 'general' | null} 水平对齐方式, null 表示清除 */ getHorizontalAlignment(): HorizontalAlignment | null; /** * getHorizontalAlignments() * * 获取水平对齐方式 * @return {Array<Array<'left' | 'center' | 'right' | 'general' | null>>} 水平对齐方式, null 表示清除 */ getHorizontalAlignments(): Array<Array<HorizontalAlignment | null>>; /** * setVerticalAlignment(alignment) * * 设置垂直对齐方式 * @param {'top' | 'middle' | 'bottom' | null} verticalAlignment 字体删除线, null 表示清除 * @return {Range} 选区 */ setVerticalAlignment(verticalAlignment: VerticalAlignment | null): Range; /** * getVerticalAlignment() * * 获取垂直对齐方式 * @return {'top' | 'middle' | 'bottom' | null} 字体删除线, null 表示没有设置 */ getVerticalAlignment(): VerticalAlignment | null; /** * getVerticalAlignments() * * 获取垂直对齐方式 * @return {Array<Array<'top' | 'middle' | 'bottom' | null>>} 字体删除线, null 表示没有设置 */ getVerticalAlignments(): Array<Array<VerticalAlignment | null>>; /** * setWordWrap(wordWrap) * * 设置换行方式 * @param {'overflow' | 'clip' | 'autoWrap' | null} wordWrap 换行方式, null 表示清除 * @return {Range} 选区 */ setWordWrap(wordWrap: WordWrap | null): Range; /** * getWordWrap() * * 获取换行方式 * @return {'overflow' | 'clip' | 'autoWrap' | null} 换行方式, null 表示没有设置 */ getWordWrap(): WordWrap | null; /** * getWordWrap() * * 获取换行方式 * @return {Array<Array<'overflow' | 'clip' | 'autoWrap' | null>>} 换行方式, null 表示没有设置 */ getWordWraps(): Array<Array<WordWrap | null>>; /** * setBorder(null) * * 清除边框 * @return {Range} 区域 */ /** * setBorder(type, color, style) * * 设置边框 * @param {BorderType} type 边框类型 * @param {string} color 边框颜色 * @param {BorderStyle} style 边框样式 * @return {Range} 区域 */ setBorder(type: null): Range; setBorder(type: BorderType, color: string, style: BorderStyle): Range; /** * decreaseDecimal() * * 减少小数位 * @return {Range} 选区 */ decreaseDecimal(): Range; /** * increaseDecimal() * * 增加小数位 * @return {Range} 选区 */ increaseDecimal(): Range; /** * setNumberFormat(numberFormat) * * 设置数据格式 * @param {string} numberFormat 数据格式，<a href="/docs/number-format">详细列表</a> * @return {Range} 选区 */ setNumberFormat(numberFormat: string | null): Range; /** * getNumberFormat() * * 获取数据格式 * @return {string} 数据格式 */ getNumberFormat(): string | null; /** * getNumberFormats() * * 获取数据格式 * @return {Array<Array<string | null>>} 数据格式 */ getNumberFormats(): Array<Array<string | null>>; /** * getCell(row, column) * * 获取单元格，传入的行列坐标是基于 range 左上角的位置开始，坐标从 0 开始 * @param {number} row 行 * @param {number} column 列 * @return {Range} 单元格 */ getCell(row: number, column: number): Range; /** * getFormula() * * 获取左上角单元格公式表达式 * @return {string} 公式表达式，无公式为空字符串 */ getFormula(): string; /** * getFormulas() * * 获取公式表达式 * @return {string[][]} 公式表达式，无公式为空字符串 */ getFormulas(): string[][]; /** * getDisplayValue() * * 获取左上角单元格显示值 * @return {string} 左上角单元格显示值 */ getDisplayValue(): string; /** * getDisplayValues() * * 获取显示值 * @return {string[][]} 单元格显示值 */ getDisplayValues(): string[][]; /** * getValue() * * 获取左上角单元格值 * @return {string | number | boolean | null} 单元格值 */ getValue(): CellValue | null; /** * getValues() * * 获取单元格值 * @return {Array<Array<string | number | boolean | ImageValue | null>>} 单元格值 */ getValues(): Array<Array<CellValue | null>>; /** * setValue(value) * * 设置值 * @param {string | boolean | number | ImageValue | null} value 值，null 表示清除 * @return {Range} 单元格 */ /** * setValue(value, options) * * 设置值 * @param {string | boolean | number | ImageValue | null} value 值，null 表示清除 * @param {SetValueOptions} options 设置值的配置选项 * @return {Range} 单元格 */ setValue(value: CellValue | null, options?: SetValueOptions): Range; /** * setValues(values) * * 设置值 * @param {Array<Array<string | boolean | number | null>>} values 值 * @return {Range} 区域 */ /** * setValues(values, options) * * 设置值 * @param {Array<Array<string | boolean | number | null>>} values 值 * @param {SetValueOptions} options 设置值的配置选项 * @return {Range} 单元格 */ setValues(values: Array<Array<CellValue | null>>, options?: SetValueOptions): Range; /** * merge() * * 合并单元格 * @return {Range} 区域 */ merge(): Range; /** * unmerge() * * 取消合并单元格 * @return {Range} 区域 */ unmerge(): Range; /** * getMergedRanges * * 获取合并单元格区域 * @return {Range[]} 合并单元格区域 */ getMergedRanges(): Range[]; /** * getA1Notation(options) * * 获取区域地址 * @params {A1NotationOptions} 配置 * @return {string} 区域字符串地址 */ getA1Notation(options?: A1NotationOptions): string; /** * getRow() * * 获取行 * @return {number} 行 */ getRow(): number; /** * getColumn() * * 获取列 * @return {number} 列 */ getColumn(): number; /** * getRowCount() * * 获取行数 * @return {number} 行数 */ getRowCount(): number; /** * getColumnCount() * * 获取列数 * @return {number} 列数 */ getColumnCount(): number; /** * setHyperlink(hyperlink) * * 设置单元格链接 * @param {Hyperlink} hyperlink 单元格链接, null 表示清除 * @return {Range} Range */ setHyperlink(hyperlink: Hyperlink | null): Range; /** * getHyperlink() * * 获取单元格链接 * @return {Hyperlink | null} 单元格链接, null 表示无链接 */ getHyperlink(): Hyperlink | null; /** * sort(field) * * 排序 * @param {SortField | number} field 排序规则｜相对于当前 Range 首列的偏移量 * @return {Range} Range */ sort(field: SortField | number): Range; /** * find(text) * * 根据指定的条件查找匹配给定字符串的第一个Range * @param {string} text 要查找的字符串。 * @return {Range} Range */ find(text: string): Range | null; /** * find(text, findOptions) * * 根据指定的条件查找匹配给定字符串的第一个Range * @param {string} text 要查找的字符串。 * @param {SearchOptions | undefined} findOptions 其他搜索条件，包括搜索范围，搜索是否需要匹配整个单元格、区分大小写、是否使用正则、是否匹配公式等 * @return {Range} Range */ find(text: string, findOptions: SearchOptions): Range | null; /** * findNext(text) * * 根据指定的条件查找匹配给定字符串下一个Range，搜索范围为以当前Range左上角的Cell之后开始的整个工作表 * @param {string} text 要查找的字符串。 * @return {Range} Range */ findNext(text: string): Range | null; /** * findNext(text, findOptions) * * 根据指定的条件查找匹配给定字符串下一个Range，搜索范围为以当前Range左上角的Cell之后开始的整个工作表。如果findOptions中指定了scope，则搜索范围再与scope取交集。 * @param {string} text 要查找的字符串。 * @param {SearchOptions | undefined} findOptions 其他搜索条件，包括搜索范围，搜索是否需要匹配整个单元格、区分大小写、是否使用正则、是否匹配公式等 * @return {Range} Range */ findNext(text: string, findOptions: SearchOptions): Range | null; /** * findPrevious(text) * * 根据指定的条件查找匹配给定字符串上一个Range，搜索范围为以当前Range左上角的Cell之前的整个工作表 * @param {string} text 要查找的字符串。 * @return {Range} Range */ findPrevious(text: string): Range | null; /** * findPrevious(text, findOptions) * * 根据指定的条件查找匹配给定字符串上一个Range，搜索范围为以当前Range左上角的Cell之前的整个工作表。如果findOptions中指定了scope，则搜索范围再与scope取交集。 * @param {string} text 要查找的字符串。 * @param {SearchOptions | undefined} findOptions 其他搜索条件，包括搜索范围，搜索是否需要匹配整个单元格、区分大小写、是否使用正则、是否匹配公式等 * @return {Range} Range */ findPrevious(text: string, findOptions: SearchOptions): Range | null; /** * replaceAll(text, replaceText) * * 根据指定的条件查找并替换给定的字符串。 * @param {string} text 要查找的字符串。 * @param {string} replaceText 替换原始字符串的字符串。 * @return {number} 执行的替换数，可能与匹配单元格的数目不同。 */ replaceAll(text: string, replaceText: string): number; /** * replaceAll(text, replaceText, replaceOptions) * * 根据指定的条件查找并替换给定的字符串。 * @param {string} text 要查找的字符串。 * @param {string} replaceText 替换原始字符串的字符串。 * @param {SearchOptions | undefined} replaceOptions 其他替换条件，包括搜索范围，搜索是否需要匹配整个单元格、区分大小写、是否使用正则、是否匹配公式等 * @return {number} 执行的替换数，可能与匹配单元格的数目不同。 */ replaceAll(text: string, replaceText: string, replaceOptions: SearchOptions): number; /** * insertCheckboxes() * * 插入复选框 * @return {Range} Range */ insertCheckboxes(): Range; /** * deleteCheckboxes() * * 清除复选框，value 不会清除 * @return {Range} Range */ deleteCheckboxes(): Range; /** * getCheckedState * * 返回左上角单元格是否勾选，null表示单元格不是复选框 * @return {boolean | null} 是否勾选 */ getCheckedState(): boolean | null; /** * getCheckedStates() * * 获取区域单元格勾选的状态 * @return {Array<Array<boolean | null>>} 区域单元格勾选的状态 */ getCheckedStates(): Array<Array<boolean | null>>; /** * setCheckedState(checked) * * 勾选/取消勾选复选框 * @param {boolean} checked 是否勾选 * @return {Range} Range */ setCheckedState(checked: boolean): Range; /** * setCheckedStates(checkeds) * * 勾选/取消勾选复选框 * @param {Array<Array<boolean | null>>} checkeds 是否勾选，null 表示跳过 * @return {Range} Range */ setCheckedStates(checkeds: Array<Array<boolean | null>>): Range; /** * insertDropdownLists(options) * * 设置下拉框 * @param {DropdownListOption[]} options 下拉选项 * @return {Range} Range */ insertDropdownLists(options: DropdownListOption[]): Range; /** * deleteDropdownLists() * * 清除下拉框，value 不会清除 * @return {Range} Range */ deleteDropdownLists(): Range; /** * getImageValue() * * 返回左上角单元格的 ImageValue，如果是不是图片单元格返回 null * @return {ImageValue | null} 图片单元格值 */ getImageValue(): ImageValue | null; /** * getImageValues() * * 返回单元格的 ImageValue，如果是不是图片单元格返回 null * @return {Array<Array<ImageValue | null>>} 图片单元格值 */ getImageValues(): Array<Array<ImageValue | null>>; /** * setImageValue(value) * * 设置单元格图片 * @param {ImageValue} value 图片 * @return {Range} Range */ setImageValue(value: ImageValue): Range; /** * setImageValues(values) * * 设置单元格图片 * @param {ImageValue[][]} values 图片 * @return {Range} Range */ setImageValues(values: ImageValue[][]): Range; /** * insertAppProtection(protection) * * 对当前区域添加酷应用锁定 * @param {AppProtection} protection 酷应用锁定 * @returns {AppProtection} 酷应用锁定信息 */ insertAppProtection(protection: AppProtection): AppProtection; /** * getAppProtections() * * 获取当前所有区域所有酷应用锁定信息 * @returns {AppProtection[]} 酷应用锁定信息列表 */ getAppProtections(): AppProtection[]; /** * getAppProtection(id) * * 获取当前区域内指定酷应用锁定信息 * @param {string} id 酷应用锁定id * @returns {AppProtection | null} 酷应用锁定信息 */ getAppProtection(id: string): AppProtection | null; /** * deleteAppProtection(id) * * 删除区域内指定酷应用锁定 * @param {string} id 酷应用锁定id * @returns {Range} Range */ deleteAppProtection(id: string): Range; /** * insertCellTip(content, type) * * 为左上角单元格添加单元格提示 * @param {string} content 单元格提示 * @param {'error' | 'warn' | 'info'} type 单元格提示类型 * @returns {string | null} 添加成功，则返回单元格提示id */ insertCellTip(content: string, type: 'error' | 'warn' | 'info'): void; /** * deleteCellTip() * * 删除左上角单元格的单元格提示 * @returns {Range} Range */ deleteCellTip(): Range; /** * setMultiMentionsValue(mentionsValue) * * 为左上角单元格设置@人信息 * @param {MentionValue[]} mentionsValue @人信息列表 * @returns {Range} Range */ setMultiMentionsValue(mentionsValue: MentionValue[]): Range; /** * getMultiMentionsValue() * * 获取左上角单元格中的@人信息 * @returns {MentionValue[] | null} @人信息 */ getMultiMentionsValue(): MentionValue[] | null; } export interface RangeList { /** * activate() * * 激活多选区 * @return {RangeList} 多选区，便于链式调用 */ activate(): RangeList; /** * clear() * * 清除样式和数据 * @return {RangeList} 多选区 */ clear(): RangeList; /** * clearFormat() * * 清除格式 * @return {RangeList} 多选区 */ clearFormat(): RangeList; /** * clearData() * * 清除数据 * @return {RangeList} 多选区 */ clearData(): RangeList; /** * setBackgroundColor(backgroundColor) * * 设置背景颜色 * @param {string | null} backgroundColor 背景颜色, null 表示清除 * @return {RangeList} 多选区 */ setBackgroundColor(backgroundColor: string | null): RangeList; /** * setFontColor(fontColor) * * 设置字体颜色 * @param {string | null} fontColor 字体颜色, null 表示清除 * @return {RangeList} 多选区 */ setFontColor(fontColor: string | null): RangeList; /** * setFontSize(fontSize) * * 设置字体大小 * @param {number | null} fontSize 字体大小, null 表示清除 * @return {RangeList} 多选区 */ setFontSize(fontSize: number | null): RangeList; /** * setFontFamily(fontFamily) * * 设置字体 * @param {string | null} fontFamily 字体, null 表示清除 * @return {RangeList} 多选区 */ setFontFamily(fontFamily: string | null): RangeList; /** * setFontWeight(fontWeight) * * 设置字体粗体 * @param {'bold' | 'normal' | null} fontWeight 字体, null 表示清除 * @return {RangeList} 多选区 */ setFontWeight(fontWeight: FontWeight | null): RangeList; /** * setFontStyle(fontStyle) * * 设置字体斜体 * @param {'italic' | 'normal' | null} fontStyle 字体斜体, null 表示清除 * @return {RangeList} 多选区 */ setFontStyle(fontStyle: FontStyle | null): RangeList; /** * setIndent(indent) * * @param {number | null} indent 缩进，必须为正整数，null 表示清除 * @returns {RangeList} 多选区 */ setIndent(indent: number | null): RangeList; /** * setHorizontalAlignment(alignment) * * 设置水平对齐方式 * @param {'left' | 'center' | 'right' | 'general' | null} horizontalAlignment 水平对齐方式, null 表示清除 * @return {RangeList} 多选区 */ setHorizontalAlignment(horizontalAlignment: HorizontalAlignment | null): RangeList; /** * setVerticalAlignment(alignment) * * 设置垂直对齐方式 * @param {'top' | 'middle' | 'bottom' | null} verticalAlignment 字体删除线, null 表示清除 * @return {RangeList} 多选区 */ setVerticalAlignment(verticalAlignment: VerticalAlignment | null): RangeList; /** * setWordWrap(wordWrap) * * 设置换行方式 * @param {'overflow' | 'clip' | 'autoWrap' | null} wordWrap 换行方式, null 表示清除 * @return {RangeList} 多选区 */ setWordWrap(wordWrap: WordWrap | null): RangeList; /** * setNumberFormat(numberFormat) * * 设置数据格式 * @param {string} numberFormat 数据格式 * @return {RangeList} 多选区 */ setNumberFormat(numberFormat: string | null): RangeList; /** * setBorder(null) * * 清除边框 * @return {Range} 区域 */ /** * setBorder(type, color, style) * * 设置边框 * @param {BorderType} type 边框类型 * @param {string} color 边框颜色 * @param {BorderStyle} style 边框样式 * @return {RangeList} 区域 * @classification {format} */ setBorder(type: null): RangeList; setBorder(type: BorderType, color: string, style: BorderStyle): RangeList; merge(): RangeList; unmerge(): RangeList; getMergedRanges(): Range[]; /** * getRanges() * * 获取所有选区 * @return {Range[]} 所有选区 */ getRanges(): Range[]; } export interface FilterCriteriaBuilder { /** * copy() * * 根据当前 FilterCriteriaBuilder 生成新的 FilterCriteriaBuilder * @return {FilterCriteriaBuilder} FilterCriteriaBuilder */ copy(): FilterCriteriaBuilder; /** * setVisibleValues(values) * * 按值筛选-设置可见值 * @param {string[]} values 可见值 * @return {FilterCriteriaBuilder} FilterCriteriaBuilder */ setVisibleValues(values: string[]): FilterCriteriaBuilder; /** * setVisibleBackgroundColor(visibleBackgroundColor) * * 按单元格颜色筛选 * @param {Color} visibleBackgroundColor 单元格颜色 * @return {FilterCriteriaBuilder} FilterCriteriaBuilder */ setVisibleBackgroundColor(visibleBackgroundColor: Color): FilterCriteriaBuilder; /** * setVisibleFontColor(visibleForegroundColor) * * 按字体颜色筛选 * @param {Color} visibleForegroundColor 字体颜色 * @return {FilterCriteriaBuilder} FilterCriteriaBuilder */ setVisibleFontColor(visibleForegroundColor: Color): FilterCriteriaBuilder; /** * setVisibleConditions(condition1, condition2) * * 按条件筛选 * @param {FilterCondition} condition1 筛选条件 * @param {FilterCondition | undefined} condition2 筛选条件 * @return {FilterCriteriaBuilder} FilterCriteriaBuilder */ setVisibleConditions(condition1: FilterCondition, condition2?: FilterCondition): FilterCriteriaBuilder; /** * setVisibleConditions(condition1, condition2, operator) * * 按条件筛选 * @param {FilterCondition} condition1 筛选条件 * @param {FilterCondition | undefined} condition2 筛选条件 * @param {FilterConditionOperator | undefined} operator 两个筛选条件的关系 'and' | 'or' * @return {FilterCriteriaBuilder} FilterCriteriaBuilder */ setVisibleConditions(condition1: FilterCondition, condition2: FilterCondition, operator: FilterConditionOperator): FilterCriteriaBuilder; /** * getVisibleValues() * * 获取设置的可见值 * @return {string[] | null} 可见值 */ getVisibleValues(): string[] | null; /** * getVisibleFontColor() * * 获取设置的可见字体颜色 * @return {Color ｜ null} 可见字体颜色 */ getVisibleFontColor(): Color | null; /** * getVisibleBackgroundColor() * * 获取设置的可见单元格颜色 * @return {Color ｜ null} 可见单元格颜色 */ getVisibleBackgroundColor(): Color | null; /** * getVisibleConditions() * * 获取设置的筛选条件 * @return {FilterCondition[] | null} 筛选条件列表 */ getVisibleConditions(): FilterCondition[] | null; /** * getVisibleConditionsOperator() * * 获取设置的两个筛选条件关系 * @return {FilterConditionOperator | null} 筛选条件关系 */ getVisibleConditionsOperator(): FilterConditionOperator | null; /** * build() * * 生成筛选规则 * @return {FilterCriteria} 筛选规则 */ build(): FilterCriteria; } export interface FilterCriteria { /** * copy() * * 根据当前 FilterCriteria 生成新的 FilterCriteriaBuilder * @return {FilterCriteriaBuilder} FilterCriteriaBuilder */ copy(): FilterCriteriaBuilder; /** * getVisibleValues() * * 获取设置的可见值 * @return {string[] | null} 可见值 */ getVisibleValues(): string[] | null; /** * getVisibleFontColor() * * 获取设置的可见字体颜色 * @return {Color ｜ null} 可见字体颜色 */ getVisibleFontColor(): Color | null; /** * getVisibleBackgroundColor() * * 获取设置的可见单元格颜色 * @return {Color} 可见单元格颜色 */ getVisibleBackgroundColor(): Color | null; /** * getVisibleConditions() * * 获取设置的筛选条件 * @return {FilterCondition[] | null} 筛选条件列表 */ getVisibleConditions(): FilterCondition[] | null; /** * getVisibleConditionsOperator() * * 获取设置的两个筛选条件关系 * @return {FilterConditionOperator | null} 筛选条件关系 */ getVisibleConditionsOperator(): FilterConditionOperator | null; } export interface Filter { /** * getId() * * 获取筛选id * @return {string} 筛选id */ getId(): string; /** * getRange() * * 获取当前筛选的筛选范围 * @return {Range} 当前筛选的筛选范围 */ getRange(): Range; /** * delete() * * 移除当前筛选 * @return {Sheet} sheet 实例 */ delete(): Sheet; /** * getColumnFilterCriteria(column) * * 获取指定列的筛选规则实例-该实例与UI操作联动 * @param {number} column 相对于 filterRange 首列的偏移量 * @return {FilterCriteria | null} 筛选规则实例 */ getColumnFilterCriteria(column: number): FilterCriteria | null; /** * setColumnFilterCriteria(column, filterCriteria) * * 设置指定列的筛选规则 * @param {number} column 相对于 filterRange 首列的偏移量 * @param {FilterCriteria} filterCriteria 筛选规则 * @return {Filter} Filter */ setColumnFilterCriteria(column: number, filterCriteria: FilterCriteria): Filter; /** * clearColumnFilterCriteria(column) * * 移除指定列的筛选规则 * @param {number} column 相对于 filterRange 首列的偏移量 * @return {Filter} Filter */ clearColumnFilterCriteria(column: number): Filter; /** * sort(field) * * 筛选排序 * @param {SortField | number} field 排序规则 * @return {Filter} Filter */ sort(field: SortField | number): Filter; /** * getColumnSortState(column) * * 获取排序状态 * @param {number} column 相对于 filterRange 首列的偏移量 * @return {FilterSortState} 筛选排序状态 */ getColumnSortState(column: number): FilterSortState; } export interface FilterView { /** * getId() * * 获取筛选视图id * @return {string} 筛选视图id */ getId(): string; /** * getName() * * 获取筛选视图名字 * @return {string} 筛选视图名字 */ getName(): string; /** * setName(name) * * 设置筛选视图名字 * @param {string} name 筛选视图名字 * @return {FilterView} 筛选视图实例，便于链式调用 */ setName(name: string): FilterView; /** * getRange() * * 获取当前筛选视图的筛选范围 * @return {Range} 筛选视图的筛选范围 */ getRange(): Range; /** * setRange(range) * * 更新当前筛选视图的筛选范围 * @param {Range | string} range 筛选视图的筛选范围 * @return {FilterView} 筛选视图实例，便于链式调用 */ setRange(range: Range | string): FilterView; /** * delete() * * 移除当前筛选视图 * @return {Sheet} sheet实例 */ delete(): Sheet; /** * getColumnFilterCriteria(column) * * 获取指定列的筛选规则实例-该实例与UI操作联动 * @param {number} column 相对于 filterRange 首列的偏移量 * @return {FilterCriteria | null} 筛选规则实例 */ getColumnFilterCriteria(column: number): FilterCriteria | null; /** * setColumnFilterCriteria(column, filterCriteria) * * 设置指定列的筛选规则 * @param {number} column 相对于 filterRange 首列的偏移量 * @param {FilterCriteria} filterCriteria 筛选规则 * @return {FilterView} 筛选视图实例，便于链式调用 */ setColumnFilterCriteria(column: number, filterCriteria: FilterCriteria): FilterView; /** * clearColumnFilterCriteria(column) * * 移除指定列的筛选规则 * @param {number} column 相对于 filterRange 首列的偏移量 * @return {FilterView} 筛选视图实例，便于链式调用 */ clearColumnFilterCriteria(column: number): FilterView; } export interface ColorBuilder { /** * 使用HexString设置颜色 * * @param hexString 16进制格式的颜色，例如#000000 * @returns Builder自身 */ setHexString(hexString: string): ColorBuilder; /** * build() * * 生成颜色 * @return {Color} 颜色 */ build(): Color; } export declare type SheetVisibility = 'visible' | 'hidden'; export declare type GridlinesVisibility = 'visible' | 'hidden'; export declare type RowVisibility = 'visible' | 'hidden'; export declare type ColumnVisibility = 'visible' | 'hidden'; export declare type WordWrap = 'overflow' | 'clip' | 'autoWrap'; export declare type FontStyle = 'italic' | 'normal'; export declare type FontWeight = 'bold' | 'normal'; export declare type HorizontalAlignment = 'left' | 'center' | 'right' | 'general'; export declare type VerticalAlignment = 'top' | 'middle' | 'bottom'; export declare type BorderStyle = 'none' | 'dotted' | 'dashed' | 'solid' | 'medium' | 'thick' | 'double' | 'hair' | 'dashDotDot' | 'dashDot' | 'mediumDashDotDot' | 'slantDashDot' | 'mediumDashDot' | 'mediumDashed'; export interface BorderType { /** * 顶部位置 */ top?: boolean; /** * 底部位置 */ bottom?: boolean; /** * 左边位置 */ left?: boolean; /** * 右边位置 */ right?: boolean; /** * 垂直位置（除去两边） */ vertical?: boolean; /** * 水平位置（除去两边） */ horizontal?: boolean; } export interface SortField { column: number; ascending?: boolean; } export interface SearchOptions { scope?: string; matchEntireCell?: boolean; matchCase?: boolean; useRegExp?: boolean; matchFormulaText?: boolean; } export interface DropdownListOption { /** *