[]
产品首页 在线 Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

GC.Data

命名空间: Data

GC.Data

Table of contents

枚举

类

接口

类型别名

Type aliases

AverageRuleOptions

Ƭ AverageRuleOptions: Object

property {"averageRule"} ruleType - 如果要使用平均规则，规则类型是“平均值”

属性 type - 平均值条件格式的类型

属性 style - 满足条件时应用于单元格的样式

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
priority number 规则的优先级
ruleType "averageRule" 平均规则类型
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则
style StyleOptions 满足条件时应用于单元格的样式
type AverageType 平均值条件格式的类型

AverageType

Ƭ AverageType: "above" | "below" | "equalOrAbove" | "equalOrBelow" | "above1StdDev" | "below1StdDev" | "above2StdDev" | "below2StdDev" | "above3StdDev" | "below3StdDev"

description 平均值条件格式的类型

CellButtonOptions

Ƭ CellButtonOptions: Object

属性 position - 按钮在单元格中的位置，支持 "left", "right", "leftOfText", "rightOfText"方向

属性 useButtonStyle - cellButton是否为按钮样式，默认值均为false

属性 enabled - 单元格按钮是否响应用户操作，默认值为true

属性 width - 按钮的宽度如果设置为null或undefined,则按钮宽度将根据标题和图像大小自动调整

属性 caption - 显示的按钮文本

属性 imageSrc - 当imageType为custom时，可以通过imageSrc指定图片(base64)

属性 imageSize - 通过对象设置图片大小如 {width: 16, height: 16}, 默认值为 16px * 16px

属性 imageSize.width - 图片的宽度

属性 imageSize.height - 图片的高度

属性 captionAlign - 图片和标题的对齐方式，支持 "left", "right"

property {string | Function} command - 单击按钮时，允许用户执行命令或用户可以执行回调函数

属性 imageType - 按钮类型(要在按钮中显示的图像类型)。可以为cellButton提供一些预定义的类型，自定义类型允许指定图标 支持有 "none", "custom", "clear", "cancel", "ok", "dropdown", "ellipsis", "left", "right", "plus", "minus", "undo", "redo", "search", "separator", "spinLeft", "spinRight", "collapse", "expand"等类型

属性 visibility - 按钮的可见类型有 "always", "onSelected", "onEditing", 默认值为 "always"

属性 hoverBackColor - 当按钮可见并可用时，单元格按钮的悬停背景色

属性 buttonBackColor - 当按钮可用时，单元格按钮的背景色

Type declaration

属性名 类型 说明
buttonBackColor? string 当按钮可用时，单元格按钮的背景色
caption? string 显示的按钮文本
captionAlign? "left" | "right" 图片和标题的对齐方式，支持 "left", "right"
command? string | (sheet: any, row: number, col: number, option: any) => void 单击按钮时，允许用户执行命令或用户可以执行回调函数
enabled? boolean 单元格按钮是否响应用户操作，默认值为true
hoverBackColor? string 当按钮可见并可用时，单元格按钮的悬停背景色
imageSize? { height: number ; width: number } 通过对象设置图片大小如 {width: 16, height: 16}, 默认值为 16px * 16px
imageSize.height number -
imageSize.width number -
imageSrc? string 当imageType为custom时，可以通过imageSrc指定图片(base64)
imageType? "none" | "custom" | "clear" | "cancel" | "ok" | "dropdown" | "ellipsis" | "left" | "right" | "plus" | "minus" | "undo" | "redo" | "search" | "separator" | "spinLeft" | "spinRight" | "collapse" | "expand" 按钮类型(要在按钮中显示的图像类型)。可以为cellButton提供一些预定义的类型，自定义类型允许指定图标
position? "left" | "right" | "leftOfText" | "rightOfText" 按钮在单元格中的位置，支持 "left", "right", "leftOfText", "rightOfText"方向
useButtonStyle? boolean cellButton是否为按钮样式，默认值均为false
visibility? "always" | "onSelected" | "onEditing" 按钮的可见类型有 "always", "onSelected", "onEditing", 默认值为 "always"
width? number 按钮的宽度如果设置为null或undefined,则按钮宽度将根据标题和图像大小自动调整

CellValueComparisonOperator

Ƭ CellValueComparisonOperator: "equalsTo" | "notEqualsTo" | "greaterThan" | "greaterThanOrEqualsTo" | "lessThan" | "lessThanOrEqualsTo" | "between" | "notBetween"

description 单元格值比较运算符

CellValueRuleOptions

Ƭ CellValueRuleOptions: Object

property {"cellValueRule"} ruleType - 如果您想使用单元值规则，规则类型是"Cell Value"

属性 comparisonOperator - 单元格值的比较运算符

属性 value1 - 第一个值

属性 value2 - 第二个值

属性 style - 满足条件时应用于单元格的样式

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
comparisonOperator CellValueComparisonOperator 单元格值的比较运算符
priority number 规则的优先级
ruleType "cellValueRule" 规则类型
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则
style StyleOptions 满足条件时应用于单元格的样式
value1 CellValueType 第一个值
value2 CellValueType 第二个值

CellValueType

Ƭ CellValueType: number | string | boolean | Date | FormulaString

description 单元格值类型

CheckboxOptions

Ƭ CheckboxOptions: Object

属性 type - 单元格类型, 支持 "checkbox"

属性 caption - 标题

属性 textTrue - 单元格值为true时的文本

属性 textIndeterminate - 单元格值不确定时的文本

属性 textFalse - 单元格值为false时的文本

属性 textAlign - 相对于复选框的文本对齐方式，该复选框支持 "top", "bottom", "left", "right"

属性 isThreeState - 相对于复选框的文本对齐方式

属性 boxSize - 复选框大小

Type declaration

属性名 类型 说明
boxSize number 复选框大小
caption string 标题
isThreeState boolean 相对于复选框的文本对齐方式
textAlign "top" | "bottom" | "left" | "right" 相对于复选框的文本对齐方式，该复选框支持 "top", "bottom", "left", "right"
textFalse string 单元格值为false时的文本
textIndeterminate string 单元格值不确定时的文本
textTrue string 单元格值为true时的文本
type "checkbox" 单元格类型, 支持 "checkbox"

ColorPickerGroup

Ƭ ColorPickerGroup: Object

属性 name - 名称

property {string[][]} colors - 颜色

属性 needScaleColor - 是否生成颜色组

Type declaration

属性名 类型 说明
colors string[][] 颜色
name string 名称
needScaleColor boolean 是否生成颜色组

ColorPickerOptions

Ƭ ColorPickerOptions: Object

属性 colorBlockSize - 每个颜色单元格的大小

property {GC.Data.ColorPickerGroup[]} groups - 颜色选择器的组，每个组接收一个名称作为组名，一个颜色数组作为组的颜色

Type declaration

属性名 类型 说明
colorBlockSize number 每个颜色单元格的大小
groups ColorPickerGroup[] 颜色选择器的组，每个组接收一个名称作为组名，一个颜色数组作为组的颜色

ColorString

Ƭ ColorString: string

description 字符串类型颜色

ColumnBindingInfo

Ƭ ColumnBindingInfo: Object

属性 name - 通过名称绑定的数据列

属性 displayName - 此列的显示名称

属性 formatter - 列的格式

property {number | string} size - 列的大小

属性 visible - 列的可见性

Type declaration

属性名 类型 说明
displayName? string 该列的显示名称。
formatter? string 该列的格式化程序。
name string 通过名称绑定的数据列。
size? number | string 列的大小。
visible? boolean 列的可见性。

ColumnType

Ƭ ColumnType: "Number" | "Text" | "Formula" | "Checkbox" | "Date" | "Currency" | "Percent" | "Phone" | "Email" | "URL" | "Lookup" | "CreatedTime" | "ModifiedTime" | "Attachment" | "Select" | "Barcode"

ComboBoxOptions

Ƭ ComboBoxOptions: Object

属性 type - 单元格类型的类型，支持 "combobox"

属性 editorValueType - 编辑器值类型，支持"text", "index", "value"

property {string[] | GC.Data.ItemOptions[]} items - 项，支持字符串数组或对象数组，每个项包含文本和值

属性 itemHeight - 每个项的高度

属性 maxDropDownItems - 每页下拉列表的最大项数

属性 editable - 组合框是否可编辑

Type declaration

属性名 类型 说明
editable? boolean 组合框是否可编辑
editorValueType? "text" | "index" | "value" 编辑器值类型，支持"text", "index", "value"
itemHeight? number 每个项的高度
items string[] | ItemOptions[] 项，支持字符串数组或对象数组，每个项包含文本和值
maxDropDownItems? number 每页下拉列表的最大项数
type "combobox" 单元格类型的类型，支持 "combobox"

DataBarAxisPosition

Ƭ DataBarAxisPosition: "automatic" | "cellMidPoint" | "none"

description 数据条规则轴的位置

DataBarRuleDirection

Ƭ DataBarRuleDirection: "leftToRight" | "rightToLeft"

description 数据条规则方向

DataBarRuleNegativeOptions

Ƭ DataBarRuleNegativeOptions: Object

属性 negativeFillColor - 负填充颜色

属性 useNegativeFillColor - 是否使用负填充颜色绘制负值.

属性 negativeBorderColor - 负边框颜色

属性 useNegativeBorderColor - 是否使用负边框颜色为负值绘制边框

属性 axisColor - 数据条的坐标轴颜色

属性 axisPosition - 数据条的轴线位置

Type declaration

属性名 类型 说明
axisColor ColorString 数据条的坐标轴颜色
axisPosition DataBarAxisPosition 数据条的轴线位置
negativeBorderColor ColorString 负边框颜色
negativeFillColor ColorString 负填充颜色
useNegativeBorderColor boolean 是否使用负边框颜色为负值绘制边框
useNegativeFillColor boolean 是否使用负填充颜色绘制负值.

DataBarRuleOptions

Ƭ DataBarRuleOptions: Object

property {"dataBarRule"} ruleType - 如果您想使用数据条规则，规则类型是"Data Bar"

属性 minType - 最小的比例类型

属性 minValue - 最小刻度值

属性 maxType - 最大的比例类型

属性 maxValue - 最大刻度值

属性 maxColor - 最大刻度的颜色字符串

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

属性 gradient - 数据条是否为渐变

属性 showBarOnly - 是否显示不带文本的数据条

属性 showBorder - 是否绘制边框

属性 borderColor - 边框的颜色

属性 barDirection - 数据条方向

属性 negativeData - 数据条规则的选项是负数据选项

Type declaration

属性名 类型 说明
barDirection DataBarRuleDirection 数据条方向
borderColor ColorString 边框的颜色
color ColorString -
gradient boolean 数据条是否为渐变
maxType ScaleValueType 最大的比例类型
maxValue number 最大刻度值
minType ScaleValueType 最小的比例类型
minValue number 最小刻度值
negativeData DataBarRuleNegativeOptions 数据条规则的选项是负数据选项
priority number 规则的优先级
ruleType dataBarRule 数据条规则的规则类型
showBarOnly boolean 是否显示不带文本的数据条
showBorder boolean 是否绘制边框
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则

DateOccurringRuleOptions

Ƭ DateOccurringRuleOptions: Object

property {"dateOccurringRule"} ruleType - 如果您想使用数据出现规则，规则类型是"Data Occurring"

属性 type - 日期发生类型

属性 style - 满足条件时应用于单元格的样式

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
priority number 规则的优先级
ruleType "dateOccurringRule" 要使用数据发生规则的规则类型
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则
style StyleOptions 满足条件时应用于单元格的样式
type DateOccurringType 日期发生类型

DateOccurringType

Ƭ DateOccurringType: "today" | "yesterday" | "tomorrow" | "last7Days" | "thisMonth" | "lastMonth" | "nextMonth" | "thisWeek" | "lastWeek" | "nextWeek" | "nextQuarter" | "thisQuarter" | "lastQuarter" | "nextYear" | "thisYear" | "lastYear"

description 日期发生类型

DateTimePickerOptions

Ƭ DateTimePickerOptions: Object

属性 showTime - 日历是否需要显示时间部分

属性 calendarPage - 默认页面，接收"year", "month", "day"

属性 startDay - 一周的开始日，通常开始日是星期一或星期天，用户可以将任何一天设置为开始日它接收"monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"

Type declaration

属性名 类型 说明
calendarPage "year" | "month" | "day" 默认页面，接收"year", "month", "day"
showTime boolean 日历是否需要显示时间部分
startDay "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday" 一周的开始日，通常开始日是星期一或星期天，用户可以将任何一天设置为开始日它接收"monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"

DateValidatorOptions

Ƭ DateValidatorOptions: Object

property {"date"} type - 数据验证器的类型是"Data Validator"

属性 comparisonOperator - 数据验证器比较运算符

property {Date | GC.Data.FormulaString} value1 - 数据验证器第一个值

property {Date | GC.Data.FormulaString} value2 - 如果数据验证器的比较运算符为"between"或"notBetween"，则该模板是用于设置数据验证器的第二个值

属性 ignoreBlank - 是否忽略空值

属性 inCellDropdown - 是否显示下拉按钮

属性 errorStyle - 数据验证器错误样式

属性 errorTitle - 数据验证器错误标题

属性 errorMessage - 数据验证器错误消息

属性 showErrorMessage - 是否显示错误消息

属性 inputMessage - 数据验证器输入消息

属性 inputTitle - 数据验证器输入标题

属性 showInputMessage - 是否显示输入消息

属性 highlightStyle - 高亮错误样式

Type declaration

属性名 类型 说明
comparisonOperator CellValueComparisonOperator 数据验证器比较运算符
errorMessage string 数据验证器错误消息
errorStyle ErrorStyle 数据验证器错误样式
errorTitle string 数据验证器错误标题
highlightStyle HighlightStyle 高亮错误样式
ignoreBlank boolean 是否忽略空值
inCellDropdown boolean 是否显示下拉按钮
inputMessage string 数据验证器输入消息
inputTitle string 数据验证器输入标题
showErrorMessage boolean 是否显示错误消息
showInputMessage boolean 是否显示输入消息
type "date" 数据验证类型
value1 Date | FormulaString 数据验证器第一个值
value2? Date | FormulaString 如果数据验证器的比较运算符为"between"或"notBetween"，则该模板是用于设置数据验证器的第二个值

Decoration

Ƭ Decoration: Object

property {GC.Data.Icon[]} icons - 该模板用于设置样式中装饰的图标

Type declaration

属性名 类型 说明
icons? Icon[] 该模板用于设置样式中装饰的图标

Ƭ DropDownOptions: Object

属性 type - 下拉列表的类型，支持 "colorPicker", "dateTimePicker", "timePicker", "monthPicker", "list", "slider", "calculator", "workflowList", "multiColumn"

property {GC.Data.ColorPickerOptions | GC.Data.DateTimePickerOptions | GC.Data.TimePickerOptions | GC.Data.MonthPickerOptions | GC.Data.ListOptions | GC.Data.SliderOptions | GC.Data.WorkFlowOptions | GC.Data.MultiColumnOptions} option - 下拉选项

属性 submitCommand - 在提交下拉列表值时将执行的命令名或回调函数

Type declaration

属性名 类型 说明
option? ColorPickerOptions | DateTimePickerOptions | TimePickerOptions | MonthPickerOptions | ListOptions | SliderOptions | WorkFlowOptions | MultiColumnOptions The option of drop down.
submitCommand? string | (sheet: any, value: any, option: any) => void 在提交下拉列表值时将执行的命令名或回调函数
type "colorPicker" | "dateTimePicker" | "timePicker" | "monthPicker" | "list" | "slider" | "calculator" | "workflowList" | "multiColumn" 下拉列表的类型，支持 "colorPicker", "dateTimePicker", "timePicker", "monthPicker", "list", "slider", "calculator", "workflowList", "multiColumn"

DuplicateRuleOptions

Ƭ DuplicateRuleOptions: Object

property {"duplicateRule"} ruleType - 如果您想使用重复规则，则规则类型是"Duplicate Rule"

属性 style - 满足条件时应用于单元格的样式

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
priority number 规则的优先级
ruleType "duplicateRule" 如果要使用重复规则，请选择规则类型
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则
style StyleOptions 满足条件时应用于单元格的样式

ErrorStyle

Ƭ ErrorStyle: "stop" | "warning" | "information"

description 验证错误样式

FileUploadOptions

Ƭ FileUploadOptions: Object

属性 type - cell类型的类型，支持“fileUpload”。

属性 maxSize -可以上传的最大文件大小。

属性 accept - 可以上传的文件类型。

属性 isPreviewEnabled -是否显示文件预览按钮。

属性 isDownloadEnabled - 是否显示文件下载按钮。

属性 isClearEnabled -是否显示文件清除按钮。

属性 marginTop - 保证金最高值。

属性 marginRight - 边距右值。

属性 marginBottom - 保证金底部值。

属性 marginLeft - 左边距值。

属性 valuePath - valuePath 用于从文件中获取单元格值。

Type declaration

属性名 类型 说明
accept? string 可以上传的文件类型。
isClearEnabled? boolean 是否显示文件清除按钮。
isDownloadEnabled? boolean 是否显示文件下载按钮。
isPreviewEnabled? boolean 是否显示文件预览按钮。
marginBottom? number 保证金底部值。
marginLeft? number 左边距值。
marginRight? number 边距右值。
marginTop? number 保证金最高值。
maxSize? number -
type "fileUpload" cell类型的类型，支持“fileUpload”。
valuePath? string valuePath 用于从文件中获取单元格值。

FormulaListValidatorOptions

Ƭ FormulaListValidatorOptions: Object

property {"formulaList"} type - 数据验证类型

属性 formula - 如果数据验证器的类型为"formula"或"formulaList"，则该模板用于设置数据验证器的公式

属性 ignoreBlank - 是否忽略空值

属性 inCellDropdown - 是否显示下拉按钮

属性 errorStyle - 数据验证器错误样式

属性 errorTitle - 数据验证器错误标题

属性 errorMessage - 数据验证器错误消息

属性 showErrorMessage - 是否显示错误消息

属性 inputMessage - 数据验证器输入消息

属性 inputTitle - 数据验证器输入标题

属性 showInputMessage - 是否显示输入消息

属性 highlightStyle - 高亮错误样式

Type declaration

属性名 类型 说明
errorMessage string 数据验证器错误消息
errorStyle ErrorStyle 数据验证器错误样式
errorTitle string 数据验证器错误标题
formula FormulaString 如果数据验证器的类型为"formula"或"formulaList"，则该模板用于设置数据验证器的公式
highlightStyle HighlightStyle 高亮错误样式
ignoreBlank boolean 是否忽略空值
inCellDropdown boolean 是否显示下拉按钮
inputMessage string 数据验证器输入消息
inputTitle string 数据验证器输入标题
showErrorMessage boolean 是否显示错误消息
showInputMessage boolean 是否显示输入消息
type "formulaList" 数据验证类型

FormulaRule

Ƭ FormulaRule: Object

属性 formula - 公式

description 公式规则

Type declaration

属性名 类型 说明
formula FormulaString 公式

FormulaRuleOptions

Ƭ FormulaRuleOptions: Object

property {"formulaRule"} ruleType - 如果您想使用公式规则，则规则类型是"Formula Rule"

属性 formula - 公式

属性 style - 满足条件时应用于单元格的样式

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
formula FormulaString 公式
priority number 规则的优先级
ruleType "formulaRule" 要使用公式规则的规则类型
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则
style StyleOptions 满足条件时应用于单元格的样式

FormulaString

Ƭ FormulaString: string

FormulaValidatorOptions

Ƭ FormulaValidatorOptions: Object

property {"formula"} type - 验证器类型

属性 formula - 如果数据验证器的类型为"formula"或"formulaList"，则该模板用于设置数据验证器的公式

属性 ignoreBlank - 是否忽略空值

属性 inCellDropdown - 是否显示下拉按钮

属性 errorStyle - 数据验证器错误样式

属性 errorTitle - 数据验证器错误标题

属性 errorMessage - 数据验证器错误消息

属性 showErrorMessage - 是否显示错误消息

属性 inputMessage - 数据验证器输入消息

属性 inputTitle - 数据验证器输入标题

属性 showInputMessage - 是否显示输入消息

属性 highlightStyle - 高亮错误样式

Type declaration

属性名 类型 说明
errorMessage string 数据验证器错误消息
errorStyle ErrorStyle 数据验证器错误样式
errorTitle string 数据验证器错误标题
formula FormulaString 如果数据验证器的类型为"formula"或"formulaList"，则该模板用于设置数据验证器的公式
highlightStyle HighlightStyle 高亮错误样式
ignoreBlank boolean 是否忽略空值
inCellDropdown boolean 是否显示下拉按钮
inputMessage string 数据验证器输入消息
inputTitle string 数据验证器输入标题
showErrorMessage boolean 是否显示错误消息
showInputMessage boolean 是否显示输入消息
type "formula" 数据验证类型

GradientFillOptions

Ƭ GradientFillOptions: Object

属性 degree - 渐变填充度

property {GC.Data.GradientStop[]} stops - 渐变填充停止

Type declaration

属性名 类型 说明
degree? number 渐变填充度
stops GradientStop[] 渐变填充停止

GradientPathFillOptions

Ƭ GradientPathFillOptions: Object

属性 type - 渐变路径填充类型，支持"path"

属性 left - 渐变路径向左填充

属性 right - 渐变路径向右填充

属性 top - 渐变路径填充顶部

属性 bottom - 渐变路径填充底部

property {GC.Data.GradientStop[]} stops - 渐变路径填充停止

Type declaration

属性名 类型 说明
bottom? number 渐变路径填充底部
left? number 渐变路径向左填充
right? number 渐变路径向右填充
stops GradientStop[] 渐变路径填充停止
top? number 渐变路径填充顶部
type "path" 渐变路径填充类型，支持"path"

GradientStop

Ƭ GradientStop: Object

属性 color - 渐变停止颜色

属性 position - 渐变停止位置

Type declaration

属性名 类型 说明
color string 渐变停止颜色
position number 渐变停止位置

HeaderStyleOptions

Ƭ HeaderStyleOptions: Object

property {string | GC.Data.PatternFillOptions | GC.Data.GradientFillOptions | GC.Data.GradientPathFillOptions} backColor - 背景颜色字符串或图案填充选项、渐变填充选项、渐变路径填充选项

属性 foreColor - 前景颜色

属性 hAlign - 水平对齐方式，支持"left"（左对齐）、"center"（居中对齐）、"right"（右对齐）、"general"（常规）

属性 vAlign - 垂直对齐方式，支持"top"（顶部对齐）、"center"（居中对齐）、"bottom"（底部对齐）

属性 font - 字体

属性 themeFont - 主题字体

属性 formatter - 格式化字符串

属性 borderLeft - 左边框

属性 borderTop - 上边框

属性 borderRight - 右边框

属性 borderBottom - 下边框

属性 diagonalDown - 自左上到右下的对角线

属性 diagonalUp - 自右上到左下的对角线

属性 locked - 单元格、行或列是否已锁定

属性 textIndent - 文本缩进量

属性 wordWrap - 文字是否在单元格或单元格内换行

属性 shrinkToFit - 内容是否收缩以适应单元格或单元格

属性 backgroundImage - 要显示的背景图像

属性 backgroundImageLayout - 背景图像的布局，支持"stretch"（拉伸）、"center"（居中）、"zoom"（缩放）、"none"（无）

属性 textDecoration - 添加到文本的装饰

属性 name - 名称

属性 parentName - 父样式的名称

属性 watermark - 水印内容

属性 cellPadding - 单元格填充

属性 labelOptions - 单元格标签选项

属性 isVerticalText - 是否将单元格文本设置为垂直显示

属性 showEllipsis - 是否在文本超出边界时显示省略号

Type declaration

属性名 类型 说明
backColor? string | PatternFillOptions | GradientFillOptions | GradientPathFillOptions 背景颜色字符串或图案填充选项、渐变填充选项、渐变路径填充选项
backgroundImage? string 要显示的背景图像
backgroundImageLayout? "stretch" | "center" | "zoom" | "none" 背景图像的布局，支持"stretch"（拉伸）、"center"（居中）、"zoom"（缩放）、"none"（无）
borderBottom? LineBorder 下边框
borderLeft? LineBorder 左边框
borderRight? LineBorder 右边框
borderTop? LineBorder 上边框
cellPadding? string 单元格填充
diagonalDown? LineBorder 自左上到右下的对角线
diagonalUp? LineBorder 自右上到左下的对角线
font? string 字体
foreColor? string 前景颜色
formatter? string 格式化字符串
hAlign? "left" | "center" | "right" | "general" 水平对齐方式，支持"left"（左对齐）、"center"（居中对齐）、"right"（右对齐）、"general"（常规）
isVerticalText? boolean 是否将单元格文本设置为垂直显示
labelOptions? LabelOptions 单元格标签选项
locked? boolean 单元格、行或列是否已锁定
name? string 名称
parentName? string 父样式的名称
showEllipsis? boolean 文本超出边界时是否显示省略号
shrinkToFit? boolean 是否收缩以适应单元格或单元格内容
textDecoration? TextDecoration 添加到文本的装饰
textIndent? number 文本缩进量
themeFont? string 主题字体
vAlign? "top" | "center" | "bottom" 垂直对齐方式，支持"top"（顶部对齐）、"center"（居中对齐）、"bottom"（底部对齐）
watermark? string 水印内容
wordWrap? boolean 单元格内是否自动换行

HierarchyCustomParseHandler

Ƭ HierarchyCustomParseHandler: (options: IHierarchyCustomParseOptions) => any

Type declaration

▸ (options): any

description 获取当前记录的 parentId

Parameters
属性名 类型 说明
options IHierarchyCustomParseOptions 处理程序的选项
Returns

any

返回当前记录的父记录ID

HierarchyCustomUnparseHandler

Ƭ HierarchyCustomUnparseHandler: (options: IHierarchyCustomUnparseOptions) => any

Type declaration

▸ (options): any

description 获取当前记录的id

Parameters
属性名 类型 说明
options IHierarchyCustomUnparseOptions 处理程序的选项
Returns

any

返回当前记录的ID

HighlightStyle

Ƭ HighlightStyle: Object

property {"circle" | "dogEar" | "icon"} type - 高亮类型

属性 color - 高亮颜色

property {"topLeft" | "topRight" | "bottomRight" | "bottomLeft" | "outsideLeft" | "outsideRight"} position - 高亮位置

属性 image - 高亮的图像可以是url或base64数据

Type declaration

属性名 类型 说明
color? string 高亮颜色
image? string 高亮的图像可以是url或base64数据
position "topLeft" | "topRight" | "bottomRight" | "bottomLeft" | "outsideLeft" | "outsideRight" 高亮位置
type? "circle" | "dogEar" | "icon" 高亮类型

HyperlinkOptions

Ƭ HyperlinkOptions: Object

属性 type - 单元格类型的类型，支持 "hyperlink"

属性 linkColor - 链接的颜色

属性 visitedLinkColor - 访问的链接的颜色

属性 text - 链接的文本

属性 linkToolTip - 链接的工具提示

属性 target - 链接目标的类型，支持"blank", "self", "parent", "top"

属性 activeOnClick - 单击时是否移动到活动单元格

Type declaration

属性名 类型 说明
activeOnClick boolean 单击时是否移动到活动单元格
linkColor string 链接的颜色
linkToolTip string 链接的工具提示
target "blank" | "self" | "parent" | "top" 链接目标的类型，支持"blank", "self", "parent", "top"
text string 链接的文本
type "hyperlink" 单元格类型的类型，支持 "hyperlink"
visitedLinkColor string 访问的链接的颜色

IColumn

Ƭ IColumn: Object

属性 name - 列的唯一名称

属性 value - 列的值，可以是数据库表中的字段名称，也可以是使用字段名称的公式

property {string | string[]} caption - 列的标题

property {number | string} width - 列的宽度，支持像素值或星号大小

属性 style - 列的样式

property {(GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions)[]} conditionalFormats - 列的条件格式数组

property {GC.Data.NumberValidatorOptions | GC.Data.DateValidatorOptions | GC.Data.TimeValidatorOptions | GC.Data.TextLengthValidatorOptions | GC.Data.FormulaValidatorOptions | GC.Data.FormulaListValidatorOptions | GC.Data.ListValidatorOptions} validator - 列的数据验证器

属性 isPrimaryKey - 将列标记为主键列

属性 readonly - 将列标记为只读

属性 required - 在插入新行时，将列标记为必填项

属性 defaultValue - 在插入新行时，提供默认值，可以是常量或公式

属性 headerStyle - 列的表头样式

属性 visible - 将列标记为可见

属性 headerFit - 表头适应模式，支持"normal"（正常），"vertical"（垂直）或"stack"（堆叠）。默认值为"normal"

属性 dataType - 原始值的实际数据类型，可以是"string"（字符串）、"number"（数字）、"boolean"（布尔值）、"object"（对象）、"array"（数组）、"date"（日期）或"rowOrder"（行顺序）。对于日期类型很有用，因为在 JSON 数据中，日期是字符串需要进行转换

属性 dataPattern - 将字符串解析为值的数据模式，例如日期字符串的格式化符号 "dd/MM/yyyy"，布尔字符串的真假值对 "是|否"，数值字符串的小数分隔符 ","

属性 dataMap - 用于以更有意义的方式显示原始值的简单映射，其键可以是数字或字符串，而值可以是数字、字符串或日期

属性 spread - 当列的值为对象时，是否展开列

属性 dataName - 表字段的原始名称，使用此属性将原始名称映射到指定名称

属性 indexed - 当创建表时是否需要创建过滤缓存

属性 allowSort - 是否在打开筛选对话框后显示排序功能

属性 allowFilterByValue - 是否在打开筛选对话框后显示按值筛选功能

属性 allowFilterByList - 是否在打开筛选对话框后显示按列表筛选功能。如果 allowSort、allowFilterByValue 和 allowFilterByList 均为 false，则不在该列中显示筛选按钮

property {string | GC.Data.ICrossOptions} cross - 列的交叉选项

property {string | (string | number | boolean | Date)[] | GC.Data.ILookupOptions} lookup - 定义列的查找表，仅在数据源的模式的列中使用

property {boolean | GC.Data.IOutlineColumnOptions} outlineColumn - 仅当数据为层次结构数据时定义大纲列

属性 trigger - 列的触发器公式

Type declaration

属性名 类型 说明
allowFilterByList? boolean 在打开筛选对话框后是否显示按列表筛选功能。如果 allowSort、allowFilterByValue 和 allowFilterByList 均为 false，则不在此列中显示筛选按钮
allowFilterByValue? boolean 在打开筛选对话框后是否显示按值筛选功能
allowSort? boolean 在打开筛选对话框后是否显示排序功能
caption? string | string[] 列的标题
conditionalFormats? (CellValueRuleOptions | SpecificTextRuleOptions | FormulaRuleOptions | DateOccurringRuleOptions | Top10RuleOptions | UniqueRuleOptions | DuplicateRuleOptions | AverageRuleOptions | TwoScaleRuleOptions | ThreeScaleRuleOptions | DataBarRuleOptions | IconSetRuleOptions)[] 列的条件格式数组
cross? string | ICrossOptions 列的交叉选项
dataMap? any 用于以更有意义的方式显示原始值的简单映射，其键可以是数字或字符串，而值可以是数字、字符串或日期
dataName? string 表字段的原始名称，使用此属性将原始名称映射到指定名称
dataPattern? string 将字符串解析为值的数据模式，例如日期字符串的格式化符号 "dd/MM/yyyy"，布尔字符串的真假值对 "是 否"，数值字符串的小数分隔符 ","
dataType? "string" | "number" | "boolean" | "object" | "array" | "date" | "rowOrder" | "TaskDate" | "TaskDuration" | "TaskSubject" | "TaskSchedulingMode" | "TaskComplete" | "TaskPredecessor" 原始值的实际数据类型，可以是"string"（字符串）、"number"（数字）、"boolean"（布尔值）、"object"（对象）、"array"（数组）、"date"（日期）或"rowOrder"（行顺序）。对于日期类型很有用，因为在 JSON 数据中，日期是字符串需要进行转换
defaultValue? any 在插入新行时提供的默认值，可以是常量或公式
headerFit? "normal" | "vertical" | "stack" 表头适应模式，支持"normal"（正常）、"vertical"（垂直）或"stack"（堆叠）。默认值为"normal"
headerStyle? HeaderStyleOptions 列的表头样式
indexed? boolean 在创建表时是否需要创建过滤缓存
isPrimaryKey? boolean 将列标记为主键列
lookup? string | (string | number | boolean | Date)[] | ILookupOptions 定义列的查找表，仅在数据源的模式的列中使用
name? string 列的唯一名称
outlineColumn? boolean | IOutlineColumnOptions 仅当数据为层次结构数据时定义大纲列
readonly? boolean 将列标记为只读
required? boolean 在插入新行时将列标记为必填项
spread? boolean 当列的值为对象时，是否展开列
style? StyleOptions 列的样式
trigger? ITriggerFormulaOption The trigger formula of the column.
type? string 列类型，“数字”、“文本”、“公式”、“复选框”、“日期”、“货币”、“百分比”、“电话”、“电子邮件”、“URL”、“查找”中的任何一个， “创建时间”、“修改时间”、“附件”、“选择”、“条形码”
validator? NumberValidatorOptions | DateValidatorOptions | TimeValidatorOptions | TextLengthValidatorOptions | FormulaValidatorOptions | FormulaListValidatorOptions | ListValidatorOptions 列的数据验证器
value? string 列的值，可以是数据库表中的字段名称，也可以是使用字段名称的公式
visible? boolean 将列标记为可见
width? number | string 列的宽度，支持像素值或星号大小

IColumnCollection

Ƭ IColumnCollection: Object

属性 key - 键值集合，其中key是一个字符串，value是一个GC.Data.IColumn对象

Index signature

▪ [key: string]: IColumn

ICrossAttributeOptions

Ƭ ICrossAttributeOptions: Object

属性 value - 定义层叠列头

属性 formatter - 格式化

description 定义折叠列头的选项

Type declaration

属性名 类型 说明
formatter? string 格式化
value string 定义层叠列头

ICrossOptions

Ƭ ICrossOptions: Object

属性 over - 查找折叠列头的键

property {(string | GC.Data.ICrossAttributeOptions)[]} attributes - 定义多个折叠列头的属性

属性 filter - 筛选折叠列头的公式

属性 caption - 自定义列头标题

description 折叠列头选项

Type declaration

属性名 类型 说明
attributes? (string | ICrossAttributeOptions)[] 定义多个折叠列头的属性
caption? string 自定义列头标题
filter? string 筛选折叠列头的公式
over string 查找折叠列头的键

ICrossViewOptions

Ƭ ICrossViewOptions: Object

属性 key - 键值集合，其中key是一个字符串，value是一个GC.Data.ICrossOptions对象

Index signature

▪ [key: string]: ICrossOptions

IDataSourceOption

Ƭ IDataSourceOption: Object

property {Array | string} data - 本地数据源，可以是 JSON 的对象数组，CSV 或 XML 的字符串

属性 remote - 远程数据源，支持 REST API、OData 和 GraphQL

属性 autoSync - 在自动同步模式下，数据更改将立即同步到服务器

属性 batch - 在批处理模式下，数据更改将保留在数据源中，用户需要调用 submitChanges 方法将其同步到服务器

属性 schema - 数据源的模式选项

Type declaration

属性名 类型 说明
autoSync? boolean 在自动同步模式下，数据更改将立即同步到服务器
batch? boolean 在批处理模式下，数据更改将保留在数据源中，用户需要调用 submitChanges 方法将其同步到服务器
data? any 本地数据源，可以是 JSON 的对象数组，CSV 或 XML 的字符串
remote? IRemoteTransportOption 远程数据源，支持 REST API、OData 和 GraphQL
schema? ISchemaOption 数据源的模式选项

IFormulaCollection

Ƭ IFormulaCollection: Object

属性 key - 一个键值对集合，其中键是一个字符串，值也是一个字符串

Index signature

▪ [key: string]: string

IHierarchyCustomParseOptions

Ƭ IHierarchyCustomParseOptions: Object

属性 data - 当前记录的数据

属性 index - 记录索引

Type declaration

属性名 类型 说明
data any 当前记录的数据
index number 记录索引

IHierarchyCustomUnparseOptions

Ƭ IHierarchyCustomUnparseOptions: Object

属性 data - 当前记录的数据

属性 index - 记录的索引

属性 parentData - 父记录的数据

Type declaration

属性名 类型 说明
data any 当前记录的数据
index number 记录的索引
parentData any 父记录的数据

IHierarchyOption

Ƭ IHierarchyOption: Object

属性 type - 支持 'Parent'、'ChildrenPath'、'Level'、'Custom'

属性 column - 包含用于构建层次结构的数据的列

property {string | GC.Data.IHierarchyOutlineColumnOptions} outlineColumn - 列的大纲列定义，显示为层次结构

属性 summaryFields - 层次结构摘要字段集合的定义

属性 parse - 用于自定义层次结构类型的解析 parentId 的选项

属性 unparse - 用于自定义层次结构类型的记录解析为 id 的选项

Type declaration

属性名 类型 说明
column string 包含用于构建层次结构的数据的列
outlineColumn? string | IHierarchyOutlineColumnOptions 列的大纲列定义，显示为层次结构
parse? HierarchyCustomParseHandler 用于自定义层次结构类型的解析 parentId 的选项
summaryFields? IHierarchySummaryFieldCollection 层次结构摘要字段集合的定义
type "Parent" | "ChildrenPath" | "Level" | "Custom" 支持 'Parent'、'ChildrenPath'、'Level'、'Custom'
unparse? HierarchyCustomUnparseHandler 用于自定义层次结构类型的记录解析为 id 的选项

IHierarchyOutlineColumnOptions

Ƭ IHierarchyOutlineColumnOptions: Object

属性 value - 表示需要显示层级数据的列

属性 showCheckBox - 是否显示复选框

属性 showImage - 是否显示图像

property {string[]} images - 按级别(url或base64Image)的图像

属性 showIndicator - 是否显示指标

属性 expandIndicator - 展开指示器(url或base64Image)

属性 collapseIndicator - 折叠指示器(URL或base64Image)

Type declaration

属性名 类型 说明
collapseIndicator? string 折叠指示器(URL或base64Image)
expandIndicator? string 展开指示器(url或base64Image)
images? string[] 按级别(url或base64Image)的图像
showCheckBox? boolean 是否显示复选框
showImage? boolean 是否显示图像
showIndicator? boolean 是否显示指标
value string 表示需要显示层级数据的列

IHierarchySummaryFieldCollection

Ƭ IHierarchySummaryFieldCollection: Object

属性 key -键值集合，其中键是字段字符串，值是公式字符串

Index signature

▪ [key: string]: string

ILookupOptions

Ƭ ILookupOptions: Object

属性 name - 关系名称

property {string[] | GC.Data.IColumn[]} columns - 相关表的列定义，用于多列下拉

Type declaration

属性名 类型 说明
columns string[] | IColumn[] 相关表的列定义，用于多列下拉
name string The relation ship name.

IOutlineColumnOptions

Ƭ IOutlineColumnOptions: Object

属性 showCheckBox - 是否显示复选框

属性 showImage - 是否显示图像

property {string[]} images - 按级别(url或base64Image)的图像

属性 showIndicator - 是否显示指标

属性 expandIndicator - 展开指示器(url或base64Image)

属性 collapseIndicator - 折叠指示器(URL或base64Image)

Type declaration

属性名 类型 说明
collapseIndicator? string 折叠指示器(URL或base64Image)
expandIndicator? string 展开指示器(url或base64Image)
images? string[] 按级别(url或base64Image)的图像
showCheckBox? boolean 是否显示复选框
showImage? boolean 是否显示图像
showIndicator? boolean 是否显示指标

IRemoteReadRequestOption

Ƭ IRemoteReadRequestOption: Object

属性 url - 请求的 URL

属性 method - 请求方法，如'GET'、'POST'、'PUT'、'DELETE'，默认值为'GET'

属性 adapter - 适配不同的数据协议，支持“rest”、“odata”、“odata4”、“graphql”

属性 body - 请求正文

Type declaration

属性名 类型 说明
adapter? string 适配不同的数据协议，支持“rest”、“odata”、“odata4”、“graphql”
body? Object 请求正文
method? "GET" | "POST" | "PUT" | "DELETE" 请求方法，如'GET'、'POST'、'PUT'、'DELETE'，默认值为'GET'
url string 请求的 URL

IRemoteRequestOption

Ƭ IRemoteRequestOption: Object

属性 url - 请求网址

属性 method - 请求方法，如'GET'、'POST'、'PUT'、'DELETE'，默认值为'GET'

Type declaration

属性名 类型 说明
method? "GET" | "POST" | "PUT" | "DELETE" 请求方法，如'GET'、'POST'、'PUT'、'DELETE'，默认值为'GET'
url string 请求网址

IRemoteTransportOption

Ƭ IRemoteTransportOption: Object

property {GC.Data.IRemoteReadRequestOption | GC.Data.RemoteReadHandler} read - 读操作的选项

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} create - 创建操作的选项

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} update - 更新操作的选项

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} delete - 删除操作的选项

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} batch - 批处理操作的选项

property {GC.Data.IRemoteReadRequestOption | GC.Data.RemoteReadHandler} getColumns - 用于获取列操作的选项。

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} addColumn - 添加列操作的选项。

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} updateColumn - 用于更新列操作的选项。

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} removeColumn - 删除列操作的选项。

Type declaration

属性名 类型 说明
batch? IRemoteRequestOption | RemoteChangeHandler 批处理操作的选项
create? IRemoteRequestOption | RemoteChangeHandler 创建操作的选项
delete? IRemoteRequestOption | RemoteChangeHandler 删除操作的选项
getColumns? IRemoteReadRequestOption | RemoteReadHandler The options for getting columns operation.
read IRemoteReadRequestOption | RemoteReadHandler 读操作的选项
removeColumn? IRemoteRequestOption | RemoteChangeHandler The options for deleting column operation.
update? IRemoteRequestOption | RemoteChangeHandler 更新操作的选项
updateColumn? IRemoteRequestOption | RemoteChangeHandler The options for updating column operation.

ISchemaOption

Ƭ ISchemaOption: Object

属性 type - 支持 'json'、'csv'、'xml'、'columnJson'

属性 countPath - 数据读取器使用此路径获取数据源集合的长度，如果未指定，则返回当前数据源集合的长度

属性 dataPath - 数据读取器使用此路径获取经解析后的数据源集合，如果未指定，则返回整个解析后的对象

属性 columns - 当前表的所有列的定义

属性 hierarchy - 层次结构选项的定义

属性 hierarchy - 层次选项的定义

Type declaration

属性名 类型 说明
columns? IColumnCollection 当前表的所有列的定义
countPath? string 数据读取器使用此路径获取数据源集合的长度，如果未指定，则返回当前数据源集合的长度
dataPath? string 数据读取器使用此路径获取经解析后的数据源集合，如果未指定，则返回整个解析后的对象
hierarchy? IHierarchyOption 层次结构选项的定义
type? string 支持 'json'、'csv'、'xml'、'columnJson'
window? IFormulaCollection 窗口链接的所有公式定义

ITriggerFormulaOption

Ƭ ITriggerFormulaOption: Object

属性 when - 指示何时触发公式

属性 formula - 要触发的公式

属性 fields - 当监视的字段被更新时，触发公式，"*" 表示任何字段，当在新记录时被省略

description 定义触发公式的选项

Type declaration

属性名 类型 说明
fields? string 被更新的监视字段可以触发公式，"*" 用于任何字段，当在新记录时被省略。.
formula string 要触发的公式
when "onNew" | "onNewAndUpdate" 指示何时触发公式

Icon

Ƭ Icon: Object

属性 position - 图标的位置，支持 "left"（左侧）、"right"（右侧）、"leftOfText"（文本左侧）、"rightOfText"（文本右侧）、"outsideLeft"（文本外左侧）、"outsideRight"（文本外右侧）

属性 width - 绘制的宽度

属性 height - 绘制的高度

属性 src - 图标的路径

Type declaration

属性名 类型 说明
height? number 绘制的高度
position? "left" | "right" | "leftOfText" | "rightOfText" | "outsideLeft" | "outsideRight" 图标的位置，支持 "left"（左侧）、"right"（右侧）、"leftOfText"（文本左侧）、"rightOfText"（文本右侧）、"outsideLeft"（文本外左侧）、"outsideRight"（文本外右侧）
src? string 图标的路径
width? number 绘制的宽度

IconCriteriaOptions

Ƭ IconCriteriaOptions: Object

属性 isGreaterThanOrEqualTo - 如果设置为true,则使用大于或等于运算符来计算值

属性 iconValueType - 图标值类型

property {number|string} iconValue - 图标值

Type declaration

属性名 类型 说明
iconValue number | string 图标值
iconValueType IconValueType 图标值类型
isGreaterThanOrEqualTo boolean 如果设置为true,则使用大于或等于运算符来计算值

IconOptions

Ƭ IconOptions: Object

属性 iconSetType - 图标值类型

属性 iconIndex - 自定义图标索引

Type declaration

属性名 类型 说明
iconIndex number 自定义图标索引
iconSetType IconSetType 图标值类型

IconSetRuleOptions

Ƭ IconSetRuleOptions: Object

属性 ruleType - 要使用图标集规则的规则类型

属性 iconSetType - 图标集类型

属性 reverseIconOrder - 是否反转图标顺序

属性 showIconOnly - 是否仅显示图标

property {GC.Data.IconOptions[]} icons - 图标选项数组

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
iconSetType IconSetType 图标集类型
icons IconOptions[] 图标选项数组
priority number 规则的优先级
reverseIconOrder boolean 是否反转图标顺序
ruleType "iconSetRule" 要使用图标集规则的规则类型
showIconOnly boolean 是否仅显示图标
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则

IconSetType

Ƭ IconSetType: "threeArrowsColored" | "threeArrowsGray" | "threeTriangles" | "threeStars" | "threeFlags" | "threeTrafficLightsUnrimmed" | "threeTrafficLightsRimmed" | "threeSigns" | "threeSymbolsCircled" | "threeSymbolsUncircled" | "fourArrowsColored" | "fourArrowsGray" | "fourRedToBlack" | "fourRatings" | "fourTrafficLights" | "fiveArrowsColored" | "fiveArrowsGray" | "fiveRatings" | "fiveQuarters" | "fiveBoxes" | "noIcons"

description 图标集类型

IconValueType

Ƭ IconValueType: "number" | "percent" | "formula" | "percentile"

description 图标值类型

ItemOptions

Ƭ ItemOptions: Object

属性 text - 项文本

属性 value - 文本值，可以数字、字符串、布尔值、日期

Type declaration

属性名 类型 说明
text string 项文本
value any 文本值，可以数字、字符串、布尔值、日期

LabelOptions

Ƭ LabelOptions: Object

属性 alignment - 单元格标签位置，支持 "topLeft", "topCenter", "topRight", "bottomLeft", "bottomCenter", "bottomRight"

属性 visibility - 单元格标签可见性，支持 "visible", "hidden", "auto"

属性 font - 单元格标签字体

属性 foreColor - 单元格标签前景色

属性 margin - 单元格标签边距

Type declaration

属性名 类型 说明
alignment "topLeft" | "topCenter" | "topRight" | "bottomLeft" | "bottomCenter" | "bottomRight" 单元格标签位置，支持 "topLeft", "topCenter", "topRight", "bottomLeft", "bottomCenter", "bottomRight"
font string 单元格标签字体
foreColor string 单元格标签前景色
margin string 单元格标签边距
visibility "visible" | "hidden" | "auto" 单元格标签可见性，支持 "visible", "hidden", "auto"

LineBorder

Ƭ LineBorder: Object

属性 color - 边框颜色

属性 style - 边框样式，支持 "empty", "thin", "medium", "dashed", "dotted", "thick", "double", "hair", "mediumDashed", "dashDot", "mediumDashDot", "dashDotDot", "mediumDashDotDot", "slantedDashDot"

Type declaration

属性名 类型 说明
color string 边框颜色
style "empty" | "thin" | "medium" | "dashed" | "dotted" | "thick" | "double" | "hair" | "mediumDashed" | "dashDot" | "mediumDashDot" | "dashDotDot" | "mediumDashDotDot" | "slantedDashDot" 边框样式，支持 "empty", "thin", "medium", "dashed", "dotted", "thick", "double", "hair", "mediumDashed", "dashDot", "mediumDashDot", "dashDotDot", "mediumDashDotDot", "slantedDashDot"

ListItem

Ƭ ListItem: Object

属性 text - 项文本

属性 value - 值

属性 icon - 图标

Type declaration

属性名 类型 说明
icon? string 图标
text? string 项文本
value? string 值

ListLayout

Ƭ ListLayout: Object

属性 direction - 布局方向，支持 "horizontal", "vertical"

属性 displayAs - 布局显示，支持 "inline", "popup", "tree"

属性 collapsible - 列表是否可以折叠

Type declaration

属性名 类型 说明
collapsible? boolean 列表是否可以折叠
direction? "horizontal" | "vertical" 布局方向，支持 "horizontal", "vertical"
displayAs? "inline" | "popup" | "tree" 布局显示，支持 "inline", "popup", "tree"

ListOptions

Ƭ ListOptions: Object

属性 text - 文本

属性 layout - 布局

属性 multiSelect - 是否将列表设置为"多选"

属性 valueType - 下拉列表结果的单元格值类型，支持 "string", "array"

property {GC.Data.ListItem[] | GC.Data.ListOptions[] | Function} items - 通常，它接收一个数组特别地，当它接收一个函数时，该函数应该返回一个DOM元素

属性 onItemSelected - 选择项或子项时使用

Type declaration

属性名 类型 说明
items ListItem[] | ListOptions[] | () => HTMLElement 函数返回 DOM 元素
layout? ListLayout 布局
multiSelect? boolean 是否将列表设置为"多选"
text? string 文本
valueType? "string" | "array" 下拉列表结果的单元格值类型，支持 "string", "array"
onItemSelected? (e: MouseEvent) => string 在项目或子项目是 (() => HTMLElement) 时使用

ListString

Ƭ ListString: string

description 列表类型为字符串, 例如 "1,2,3"

ListValidatorOptions

Ƭ ListValidatorOptions: Object

属性 type - 数据验证类型

属性 source - 数据验证器源

属性 ignoreBlank - 是否忽略空值

属性 inCellDropdown - 是否显示下拉按钮

属性 errorStyle - 数据验证器错误样式

属性 errorTitle - 数据验证器错误标题

属性 errorMessage - 数据验证器错误消息

属性 showErrorMessage - 是否显示错误消息

属性 inputMessage - 数据验证器输入消息

属性 inputTitle - 数据验证器输入标题

属性 showInputMessage - 是否显示输入消息

属性 highlightStyle - 高亮错误样式

Type declaration

属性名 类型 说明
errorMessage string 数据验证器错误消息。
errorStyle ErrorStyle 数据验证器错误样式。
errorTitle string 数据验证器错误标题。
highlightStyle HighlightStyle 数据验证器突出显示样式。
ignoreBlank boolean 是否忽略空值。
inCellDropdown boolean 是否显示下拉按钮。
inputMessage string 数据验证器输入消息。
inputTitle string 数据验证器输入标题。
showErrorMessage boolean 是否显示错误信息。
showInputMessage boolean 是否显示输入消息。
source ListString 数据验证器源。
type "list" 数据验证器类型。

MaskType

Ƭ MaskType: Object

属性 pattern - 面具图案。

属性 placeholder - 蒙版占位符。

属性 excludeLiteral - 掩码排除文字。

属性 excludePlaceholder - 掩码排除占位符。

Type declaration

属性名 类型 说明
excludeLiteral? boolean 掩码排除文字。
excludePlaceholder? boolean 掩码排除占位符。
pattern string 面具图案。
placeholder? string 蒙版占位符。

MonthPickerOptions

Ƭ MonthPickerOptions: Object

属性 startYear - 月份选取器的起始年份，默认值为10年前

属性 stopYear - 月份选取器的停止年份，默认值为今年

属性 height - 月份选择器dom元素高度，默认值为300

Type declaration

属性名 类型 说明
height number 月份选择器dom元素高度，默认值为300
startYear number 月份选取器的起始年份，默认值为10年前
stopYear number 月份选取器的停止年份，默认值为今年

MultiColumnOptions

Ƭ MultiColumnOptions: Object

属性 width - 用户可以自定义多列下拉列表的宽度默认情况下，它是800与自动计算所有列宽的结果之间的最小值

属性 height - 用户可以自定义多列下拉列表的高度默认情况下，它是400与自动计算所有行高的结果之间的最小值

property {string | Object[]} dataSource - 用户应指定绑定的数据源数据源是必需的，支持返回数组的数组或公式

property {GC.Data.ColumnBindingInfo[]} bindingInfos - 用户可以自定义绑定列信息

Type declaration

属性名 类型 说明
bindingInfos? ColumnBindingInfo[] 用户可以自定义绑定列信息
dataSource string | any[] 用户应指定绑定的数据源数据源是必需的，支持返回数组的数组或公式
height? number 用户可以自定义多列下拉列表的高度默认情况下，它是400与自动计算所有行高的结果之间的最小值
width? number 用户可以自定义多列下拉列表的宽度默认情况下，它是800与自动计算所有列宽的结果之间的最小值

NumberValidatorOptions

Ƭ NumberValidatorOptions: Object

property {"number"} type - 数据验证器类型。

属性 comparisonOperator - 数据验证器比较运算符

property {number | GC.Data.FormulaString} value1 - 数据验证器第一个值

property {number | GC.Data.FormulaString} value2 - 如果验证器比较运算符为“ Between”或“ notBetween”，则数据验证器的第二个值

属性 isIntegerValue - 如果验证器类型为"number",则是整数值

属性 ignoreBlank - 是否忽略空值

属性 inCellDropdown - 是否显示下拉按钮

属性 errorStyle - 数据验证器错误样式

属性 errorTitle - 数据验证器错误标题

属性 errorMessage - 数据验证器错误消息

属性 showErrorMessage - 是否显示错误消息

属性 inputMessage - 数据验证器输入消息

属性 inputTitle - 数据验证器输入标题

属性 showInputMessage - 是否显示输入消息

属性 highlightStyle - 高亮错误样式

Type declaration

属性名 类型 说明
comparisonOperator CellValueComparisonOperator 数据验证器比较运算符
errorMessage string 数据验证器错误消息
errorStyle ErrorStyle 数据验证器错误样式
errorTitle string 数据验证器错误标题
highlightStyle HighlightStyle 高亮错误样式
ignoreBlank boolean 是否忽略空值
inCellDropdown boolean 是否显示下拉按钮
inputMessage string 数据验证器输入消息
inputTitle string 数据验证器输入标题
isIntegerValue boolean 如果验证器类型为"number",则是整数值
showErrorMessage boolean 是否显示错误消息
showInputMessage boolean 是否显示输入消息
type "number" 数据验证类型
value1 number | FormulaString 数据验证器第一个值
value2? number | FormulaString 如果验证器比较运算符为“ Between”或“ notBetween”，则数据验证器的第二个值

PatternFillOptions

Ƭ PatternFillOptions: Object

属性 type - 图案填充类型，支持“solid”、“darkGray”、“mediumGray”、“lightGray”、“gray125”、“gray0625”、“darkHorizo​​ntal”、“darkVertical”、“darkDown”、“darkUp”、“darkGrid” 、“darkTrellis”、“lightHorizo​​ntal”、“lightVertical”、“lightDown”、“lightUp”、“lightGrid”和“lightTrellis”。

属性 patternColor - 图案填充颜色

属性 backgroundColor - 填充图案的背景色

Type declaration

属性名 类型 说明
backgroundColor? string 填充图案的背景色
patternColor string 图案填充颜色
type "solid" | "darkGray" | "mediumGray" | "lightGray" | "gray125" | "gray0625" | "darkHorizontal" | "darkVertical" | "darkDown" | "darkUp" | "darkGrid" | "darkTrellis" | "lightHorizontal" | "lightVertical" | "lightDown" | "lightUp" | "lightGrid" | "lightTrellis" 图案填充类型，支持“solid”、“darkGray”、“mediumGray”、“lightGray”、“gray125”、“gray0625”、“darkHorizo​​ntal”、“darkVertical”、“darkDown”、“darkUp”、“darkGrid” 、“darkTrellis”、“lightHorizo​​ntal”、“lightVertical”、“lightDown”、“lightUp”、“lightGrid”和“lightTrellis”。

RadioButtonCheckboxListOptions

Ƭ RadioButtonCheckboxListOptions: Object

属性 type - 单元格类型的类型，支持 "radioButtonList","checkboxList"

property {GC.Data.ItemOptions[]} items - items, 支持对象数组，每个项目包含文本和值

属性 direction - 单选框或复选框的命令，支持"horizontal", "vertical"

属性 maxColumnCount - 单选框或复选框的列计数

属性 maxRowCount - 单选框或复选框的行数

属性 isFlowLayout - 单选框或复选框的布局为"自动调整"

属性 itemSpacing - 两个项的空间

属性 itemSpacing.horizontal - 水平方向上两个项目的空间

属性 itemSpacing.vertical - 垂直方向上两个项目的空间

属性 textAlign - 相对于单选框或复选框的文本对齐方式，支持"left", "right"

属性 boxSize - 单选框或复选框的大小

Type declaration

属性名 类型 说明
boxSize number 单选框或复选框的大小
direction "horizontal" | "vertical" 单选框或复选框的命令，支持"horizontal", "vertical"
isFlowLayout boolean 单选框或复选框的布局为"自动调整"
itemSpacing { horizontal: number ; vertical: number } 两个项的空间
itemSpacing.horizontal number -
itemSpacing.vertical number -
items ItemOptions[] items, 支持对象数组，每个项目包含文本和值
maxColumnCount number 单选框或复选框的列计数
maxRowCount number 单选框或复选框的行数
textAlign "left" | "right" 相对于单选框或复选框的文本对齐方式，支持"left", "right"
type "radioButtonList" | "checkboxList" 单元格类型的类型，支持 "radioButtonList","checkboxList"

RemoteChangeHandler

Ƭ RemoteChangeHandler: (data: Object | Object[], options: RequestInit) => Promise<Object | Object[]>

Type declaration

▸ (data, options): Promise<Object | Object[]>

description 处理数据变化

Parameters
属性名 类型 说明
data Object | Object[] 数据的改变
options RequestInit 处理程序的选项
Returns

Promise<Object | Object[]>

返回处理程序

RemoteReadHandler

Ƭ RemoteReadHandler: (options: Object) => Promise<Object[]>

Type declaration

▸ (options): Promise<Object[]>

description 处理读取数据

Parameters
属性名 类型 说明
options Object 处理程序的选项
Returns

Promise<Object[]>

返回处理程序

ScaleValueType

Ƭ ScaleValueType: "number" | "lowestValue" | "highestValue" | "percent" | "percentile" | "automin" | "formula" | "automax"

description 刻度值类型

SliderOptions

Ƭ SliderOptions: Object

属性 scaleVisible - 是否只能拖动勾选，默认值为false

属性 max - 滑块可以滑动到的最大值，默认值为100

属性 min - 滑块可以滑动到的最小值，默认值为0

属性 step - 滑块可以逐步浏览值的粒度。必须大于 0，并除以（最大值 - 最小值）。当标记不为空时，step可以为空，默认值为1

属性 tooltipVisible - 如果为true,则工具提示将始终显示，或者无论如何也不会显示，即使拖动或悬停，默认值为false

属性 width - 滑块的宽度当方向为水平时，默认值为350

属性 height - 当方向为垂直时，滑块的高度默认值为350

属性 direction - 滑块的方向，支持"horizontal", "vertical",默认值为水平

property {number[]} marks - 滑块的勾号

属性 formatString - 显示格式，用于工具提示或标记

Type declaration

属性名 类型 说明
direction "horizontal" | "vertical" 滑块的方向，支持"horizontal", "vertical",默认值为水平
formatString string 显示格式，用于工具提示或标记
height number 当方向为垂直时，滑块的高度默认值为350
marks number[] 滑块的勾号
max number 滑块可以滑动到的最大值，默认值为100
min number 滑块可以滑动到的最小值，默认值为0
scaleVisible boolean 是否只能拖动勾选，默认值为false
step number 滑块可以逐步浏览值的粒度。必须大于 0，并除以（最大值 - 最小值）。当标记不为空时，step可以为空，默认值为1
tooltipVisible boolean 如果为true,则工具提示将始终显示，或者无论如何也不会显示，即使拖动或悬停，默认值为false
width number 滑块的宽度当方向为水平时，默认值为350

SpecificTextComparisonOperator

Ƭ SpecificTextComparisonOperator: "contains" | "doesNotContain" | "beginsWith" | "endsWith"

description 文本比较运算符

SpecificTextRuleOptions

Ƭ SpecificTextRuleOptions: Object

属性 ruleType - 如果要使用特定的文本规则，则使用规则类型

属性 comparisonOperator - 文本的比较运算符

属性 text - 文本

属性 style - 满足条件时应用于单元格的样式

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
comparisonOperator SpecificTextComparisonOperator 文本的比较运算符
priority number 规则的优先级
ruleType "specificTextRule" 如果要使用特定的文本规则，则使用规则类型
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则
style StyleOptions 满足条件时应用于单元格的样式
text string 文本

StateRule

Ƭ StateRule: Object

属性 direction - 状态规则方向

属性 state - 状态

property [area] - 规则区域。

description 状态规则

Type declaration

属性名 类型 说明
area? ViewArea 规则生效的位置
direction StateRuleDirection 状态规则方向
state RowColumnStates 公式字符串

StyleOptions

Ƭ StyleOptions: Object

property {string | GC.Data.PatternFillOptions | GC.Data.GradientFillOptions | GC.Data.GradientPathFillOptions} backColor - 背景颜色字符串或图案填充选项、渐变填充选项、渐变路径填充选项

属性 foreColor - 前景颜色

属性 hAlign - 水平对齐方式，支持 "left"（左对齐）、"center"（居中对齐）、"right"（右对齐）、"general"（一般对齐）

属性 vAlign - 垂直对齐方式，支持 "top"（顶部对齐）、"center"（居中对齐）、"bottom"（底部对齐）

属性 font - 字体

属性 themeFont - 主题字体

属性 formatter - 格式化字符串

属性 borderLeft - 左边框

属性 borderTop - 上边框

属性 borderRight - 右边框

属性 borderBottom - 下边框

属性 diagonalDown - 自左上到右下的对角线

属性 diagonalUp - 自右上到左下的对角线

属性 locked - 是否锁定单元格、行或列

属性 textIndent - 文本缩进量

属性 wordWrap - 文字是否换行

属性 shrinkToFit - 内容是否收缩以适应单元格

属性 backgroundImage - 背景图片路径

property {GC.Data.CheckboxOptions | GC.Data.ComboBoxOptions | GC.Data.HyperlinkOptions | GC.Data.RadioButtonCheckboxListOptions} cellType - 单元格类型

属性 backgroundImageLayout - 背景图片的布局方式，支持 "stretch"（拉伸）、"center"（居中）、"zoom"（缩放）、"none"（无）

属性 tabStop - 用户是否可以使用 Tab 键聚焦到单元格

属性 textDecoration - 添加到文本的修饰

属性 imeMode - 输入法编辑器模式，支持 "auto"（自动）、"active"（激活）、"inactive"（非激活）、"disabled"（禁用）

属性 name - 名称

属性 parentName - 父样式的名称

属性 watermark - 水印内容

属性 cellPadding - 单元格内边距

属性 labelOptions - 单元格标签选项

属性 isVerticalText - 是否将单元格的文字垂直显示

属性 textOrientation - 单元格文本的旋转角度

属性 showEllipsis - 当文本超出边界时是否显示省略号

property {GC.Data.CellButtonOptions[]} cellButtons - 单元格按钮

property {GC.Data.DropDownOptions[]} dropDowns - 下拉选择框

属性 decoration - 所添加的修饰效果

属性 mask - The mask.

Type declaration

属性名 类型 说明
backColor? string | PatternFillOptions | GradientFillOptions | GradientPathFillOptions 背景颜色字符串或图案填充选项、渐变填充选项、渐变路径填充选项
backgroundImage? string 要显示的背景图片
backgroundImageLayout? "stretch" | "center" | "zoom" | "none" 背景图片的布局方式，支持 "stretch"（拉伸）、"center"（居中）、"zoom"（缩放）、"none"（无）
borderBottom? LineBorder 下边框
borderLeft? LineBorder 左边框
borderRight? LineBorder 右边框
borderTop? LineBorder 上边框
cellButtons? CellButtonOptions[] 单元格按钮
cellPadding? string 单元格填充
cellType? CheckboxOptions | ComboBoxOptions | HyperlinkOptions | RadioButtonCheckboxListOptions 单元格类型
decoration? Decoration 修饰效果
diagonalDown? LineBorder 自左上到右下的对角线
diagonalUp? LineBorder 自右上到左下的对角线
dropDowns? DropDownOptions[] 下拉选择框
font? string 字体
foreColor? string 前景颜色
formatter? string 格式化字符串
hAlign? "left" | "center" | "right" | "general" 水平对齐方式，支持 "left"（左对齐）、"center"（居中对齐）、"right"（右对齐）、"general"（一般对齐）
imeMode? "auto" | "active" | "inactive" | "disabled" 输入法编辑器模式，支持 "auto"（自动）、"active"（激活）、"inactive"（非激活）、"disabled"（禁用）
isVerticalText? boolean 是否将单元格的文本垂直显示
labelOptions? LabelOptions 单元格标签选项
locked? boolean 单元格、行或列是否被锁定
mask? MaskType The mask.
name? string 名称
parentName? string 父样式的名称
showEllipsis? boolean 文本超出边界时是否显示省略号
shrinkToFit? boolean 是否收缩内容以适应单元格
tabStop? boolean 用户是否可以使用 Tab 键将焦点设置到单元格
textDecoration? TextDecoration 添加到文本的修饰效果
textIndent? number 文本缩进量
textOrientation? number 单元格文本的旋转角度
themeFont? string 主题字体
vAlign? "top" | "center" | "bottom" 垂直对齐方式，支持 "top"（顶部对齐）、"center"（居中对齐）、"bottom"（底部对齐）
watermark? string 水印内容
wordWrap? boolean 文字是否在单元格内换行

StyleRule

Ƭ StyleRule: Object

property {GC.Data.FormulaRule | GC.Data.StateRule} [rule] - 样式规则

property [style] - 样式规则的样式

description 样式规则

Type declaration

属性名 类型 说明
rule? FormulaRule | StateRule 公式规则或状态规则
style? StyleOptions 如果规则满足，则应用的样式

StyleRules

Ƭ StyleRules: Object

属性 name - 样式规则

description 样式规则

Type declaration

属性名 类型 说明
name StyleRule 样式规则

TextDecoration

Ƭ TextDecoration: "underline" | "lineThrough" | "overline" | "doubleUnderline" | "none" | "lineThroughUnderline" | "lineThroughDoubleUnderline"

description 文本修饰

TextLengthString

Ƭ TextLengthString: string

description 文本长度类型字符串，如"10"

TextLengthValidatorOptions

Ƭ TextLengthValidatorOptions: Object

属性 type - 数据验证类型

属性 comparisonOperator - 数据验证器比较运算符

property {GC.Data.TextLengthString | GC.Data.FormulaString} value1 - 数据验证器第一个值

property {GC.Data.TextLengthString | GC.Data.FormulaString} value2 - 如果验证器比较运算符为“ Between”或“ notBetween”，则数据验证器的第二个值

属性 ignoreBlank - 是否忽略空值

属性 inCellDropdown - 是否显示下拉按钮

属性 errorStyle - 数据验证器错误样式

属性 errorTitle - 数据验证器错误标题

属性 errorMessage - 数据验证器错误消息

属性 showErrorMessage - 是否显示错误消息

属性 inputMessage - 数据验证器输入消息

属性 inputTitle - 数据验证器输入标题

属性 showInputMessage - 是否显示输入消息

属性 highlightStyle - 高亮错误样式

Type declaration

属性名 类型 说明
comparisonOperator CellValueComparisonOperator 数据验证器比较运算符
errorMessage string 数据验证器错误消息
errorStyle ErrorStyle 数据验证器错误样式
errorTitle string 数据验证器错误标题
highlightStyle HighlightStyle 高亮错误样式
ignoreBlank boolean 是否忽略空值
inCellDropdown boolean 是否显示下拉按钮
inputMessage string 数据验证器输入消息
inputTitle string 数据验证器输入标题
showErrorMessage boolean 是否显示错误消息
showInputMessage boolean 是否显示输入消息
type "textLength" 数据验证类型
value1 TextLengthString | FormulaString 数据验证器第一个值
value2? TextLengthString | FormulaString 如果验证器比较运算符为“ Between”或“ notBetween”，则数据验证器的第二个值

ThreeScaleRuleOptions

Ƭ ThreeScaleRuleOptions: Object

property {"threeScaleRule"} ruleType - 如果要使用三比例规则，则规则类型。

属性 minType - 最小的比例类型

属性 minValue - 最小刻度值

属性 minColor - 最小刻度颜色字符串

属性 midType - 中点刻度类型

属性 midValue - 中点刻度值

属性 midColor - 中点刻度颜色字符串

属性 maxType - 最大的比例类型

属性 maxValue - 最大刻度值

属性 maxColor - 最大刻度的颜色字符串

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
maxColor ColorString 最大刻度的颜色字符串
maxType ScaleValueType 最大的比例类型
maxValue number 最大刻度值
midColor ColorString 中点刻度颜色字符串
midType ScaleValueType 中点刻度类型
midValue number 中点刻度值
minColor ColorString 最小刻度颜色字符串
minType ScaleValueType 最小的比例类型
minValue number 最小刻度值
priority number 规则的优先级
ruleType "threeScaleRule" 如果要使用色三刻度规则，则使用规则类型
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则

TimePickerOptions

Ƭ TimePickerOptions: Object

属性 max - 时间选择器可以显示的最大值，该值需要hour、minute和second属性

属性 min - 时间选择器可以显示的最小值，该值需要hour、minute和second属性

属性 step - 时间选择器可以单步遍历值的粒度

属性 formatString - 时间项的格式

属性 height - 时间选择器大小的容器

Type declaration

属性名 类型 说明
formatString string 时间项的格式
height number 时间选择器大小的容器
max TimePickerValue 时间选择器可以显示的最大值，该值需要hour、minute和second属性
min TimePickerValue 时间选择器可以显示的最小值，该值需要hour、minute和second属性
step TimePickerValue 时间选择器可以单步遍历值的粒度

TimePickerValue

Ƭ TimePickerValue: Object

属性 hour - 小时值

属性 minute - 分钟值

属性 second - 秒钟值

Type declaration

属性名 类型 说明
hour number 小时值
minute number 分钟值
second number 秒钟值

TimeValidatorOptions

Ƭ TimeValidatorOptions: Object

property {"time"} type - 验证器类型

属性 comparisonOperator - 数据验证器比较运算符

property {Date | GC.Data.FormulaString} value1 - 数据验证器第一个值

property {Date | GC.Data.FormulaString} value2 - 如果验证器比较运算符为“ Between”或“ notBetween”，则数据验证器的第二个值

属性 ignoreBlank - 是否忽略空值

属性 inCellDropdown - 是否显示下拉按钮

属性 errorStyle - 数据验证器错误样式

属性 errorTitle - 数据验证器错误标题

属性 errorMessage - 数据验证器错误消息

属性 showErrorMessage - 是否显示错误消息

属性 inputMessage - 数据验证器输入消息

属性 inputTitle - 数据验证器输入标题

属性 showInputMessage - 是否显示输入消息

属性 highlightStyle - 高亮错误样式

Type declaration

属性名 类型 说明
comparisonOperator CellValueComparisonOperator 数据验证器比较运算符
errorMessage string 数据验证器错误消息
errorStyle ErrorStyle 数据验证器错误样式
errorTitle string 数据验证器错误标题
highlightStyle HighlightStyle 高亮错误样式
ignoreBlank boolean 是否忽略空值
inCellDropdown boolean 是否显示下拉按钮
inputMessage string 数据验证器输入消息
inputTitle string 数据验证器输入标题
showErrorMessage boolean 是否显示错误消息
showInputMessage boolean 是否显示输入消息
type "time" 数据验证类型
value1 Date | FormulaString 数据验证器第一个值
value2? Date | FormulaString 如果验证器比较运算符为“ Between”或“ notBetween”，则数据验证器的第二个值

Top10RuleOptions

Ƭ Top10RuleOptions: Object

property {"top10Rule"} ruleType - 如果要使用排名前10的规则，则规则类型是 "Top-10"

属性 type - 前10类型

属性 rank - 要应用样式的顶部或底部项的数量

属性 style - 满足条件时应用于单元格的样式

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
priority number 规则的优先级
rank number 要应用样式的顶部或底部项的数量
ruleType "top10Rule" 如果要使用前10规则的规则类型.
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则
style StyleOptions 满足条件时应用于单元格的样式
type Top10Type 前10类型

Top10Type

Ƭ Top10Type: "top" | "bottom"

description 前10类型

TwoScaleRuleOptions

Ƭ TwoScaleRuleOptions: Object

property {"twoScaleRule"} ruleType - 如果要使用两种规模的规则，则规则类型是 "Two-Scale"

属性 minType - 最小的比例类型

属性 minValue - 最小刻度值

属性 minColor - 最小刻度颜色字符串

属性 maxType - 最大的比例类型

属性 maxValue - 最大刻度值

属性 maxColor - 最大刻度的颜色字符串

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
maxColor ColorString 最大刻度的颜色字符串
maxType ScaleValueType 最大的比例类型
maxValue number 最大刻度值
minColor ColorString 最小刻度颜色字符串
minType ScaleValueType 最小的比例类型
minValue number 最小刻度值
priority number 规则的优先级
ruleType "twoScaleRule" 如果要使用双刻度规则，请选择规则类型
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则

UniqueRuleOptions

Ƭ UniqueRuleOptions: Object

属性 ruleType - 如果要使用唯一规则，请选择规则类型

属性 style - 满足条件时应用于单元格的样式

属性 priority - 规则的优先级

属性 stopIfTrue - 是否在此规则之前应用优先级较低的规则

Type declaration

属性名 类型 说明
priority number 规则的优先级
ruleType "uniqueRule" 如果要使用唯一规则，请选择规则类型
stopIfTrue boolean 是否在此规则之前应用优先级较低的规则
style StyleOptions 满足条件时应用于单元格的样式

ViewOptions

Ƭ ViewOptions: Object

property [defaultColumnWidth] - 默认列宽

property [styleRules] - 样式规则

property [showCrossValueHeader] - 堆叠列头值是否可见

property [cross] - 堆叠列头选项

description 视图选项

Type declaration

属性名 类型 说明
cross? ICrossViewOptions 堆叠列头选项
defaultColumnWidth? number 默认列宽
showCrossValueHeader? boolean 堆叠列头值是否可见
styleRules? StyleRules 样式规则

WorkFlowItem

Ƭ WorkFlowItem: Object

属性 value - 值

property {number[]|string[]} transitions - 转换

Type declaration

属性名 类型 说明
transitions number[] | string[] 转换
value string 值

WorkFlowOptions

Ƭ WorkFlowOptions: Object

property {GC.Data.WorkFlowItem[]} items - 项

Type declaration

属性名 类型 说明
items WorkFlowItem[] 项