[]
GC.Data
Ƭ AverageRuleOptions: Object
property {"averageRule"} ruleType - 若要使用平均值规则，需指定此规则类型。
property type - 平均值类型。
property style - 当条件满足时应用于单元格的样式。
property priority - 规则的优先级。
property stopIfTrue - 在应用此规则前是否应用优先级较低的规则。
| Name | Type | Description |
|---|---|---|
priority |
number |
规则的优先级。 |
ruleType |
"averageRule" |
若要使用平均值规则，需指定此规则类型。 |
stopIfTrue |
boolean |
在应用此规则前是否应用优先级较低的规则。 |
style |
StyleOptions |
当条件满足时应用于单元格的样式。 |
type |
AverageType |
平均值类型。 |
Ƭ AverageType: "above" | "below" | "equalOrAbove" | "equalOrBelow" | "above1StdDev" | "below1StdDev" | "above2StdDev" | "below2StdDev" | "above3StdDev" | "below3StdDev"
description 平均值类型。
Ƭ CellButtonOptions: Object
property position - 按钮在单元格中的位置，支持"left"(左)、"right"(右)、"leftOfText"(文本左侧)、"rightOfText"(文本右侧)
property useButtonStyle - 单元格按钮是否使用按钮样式，默认值为false
property enabled - 单元格按钮是否响应用户操作，默认值为true
property width - 按钮宽度。若设置为null或undefined，按钮宽度将根据标题和图像大小自动适应
property caption - 按钮显示的文本
property imageSrc - 当imageType为custom时，可通过imageSrc指定图片(使用base64格式)
property imageSize - 图片尺寸，使用对象格式{width: 16, height: 16}，默认值为16px * 16px
property imageSize.width - 图片宽度
property imageSize.height - 图片高度
property captionAlign - 图片和标题的对齐方式，支持"left"(左对齐)、"right"(右对齐)
property {string | Function} command - 点击按钮时，允许用户执行命令或自定义回调函数
property imageType - 按钮类型(按钮中显示的图像类型)。为单元格按钮提供了一些预定义类型，custom允许指定自定义图标
支持的值包括:"none"(无图标)、"custom"(自定义)、"clear"(清除)、"cancel"(取消)、"ok"(确定)、"dropdown"(下拉箭头)、"ellipsis"(省略号)、"left"(左箭头)、"right"(右箭头)、"plus"(加号)、"minus"(减号)、"undo"(撤销)、"redo"(重做)、"search"(搜索)、"separator"(分隔符)、"spinLeft"(左旋转)、"spinRight"(右旋转)、"collapse"(折叠)、"expand"(展开)
property visibility - 按钮的可见性设置，可以是"always"(始终可见)、"onSelected"(选中时可见)、"onEditing"(编辑时可见)，默认值为"always"
property hoverBackColor - 当按钮可见且启用时，鼠标悬停状态下的背景颜色
property buttonBackColor - 当按钮启用时的背景颜色
| Name | Type | Description |
|---|---|---|
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" |
按钮类型(按钮中显示的图像类型)。为单元格按钮提供了一些预定义类型，custom允许指定自定义图标 |
position? |
"left" | "right" | "leftOfText" | "rightOfText" |
按钮在单元格中的位置，支持"left"(左)、"right"(右)、"leftOfText"(文本左侧)、"rightOfText"(文本右侧) |
useButtonStyle? |
boolean |
单元格按钮是否使用按钮样式，默认值为false |
visibility? |
"always" | "onSelected" | "onEditing" |
按钮的可见性设置，可以是"always"(始终可见)、"onSelected"(选中时可见)、"onEditing"(编辑时可见)，默认值为"always" |
width? |
number |
按钮宽度。若设置为null或undefined，按钮宽度将根据标题和图像大小自动适应 |
Ƭ CellValueComparisonOperator: "equalsTo" | "notEqualsTo" | "greaterThan" | "greaterThanOrEqualsTo" | "lessThan" | "lessThanOrEqualsTo" | "between" | "notBetween"
description 单元格值比较运算符。
Ƭ CellValueRuleOptions: Object
property {"cellValueRule"} ruleType - 若要使用单元格值规则，需指定此规则类型。
property comparisonOperator - 单元格值的比较运算符。
property value1 - 第一个值。
property value2 - 第二个值。
property style - 当条件满足时应用于单元格的样式。
property priority - 规则的优先级。
property stopIfTrue - 在应用此规则前是否应用优先级较低的规则。
| Name | Type | Description |
|---|---|---|
comparisonOperator |
CellValueComparisonOperator |
单元格值的比较运算符。 |
priority |
number |
规则的优先级。 |
ruleType |
"cellValueRule" |
若要使用单元格值规则，需指定此规则类型。 |
stopIfTrue |
boolean |
在应用此规则前是否应用优先级较低的规则。 |
style |
StyleOptions |
当条件满足时应用于单元格的样式。 |
value1 |
CellValueType |
第一个值。 |
value2 |
CellValueType |
第二个值。 |
Ƭ CellValueType: number | string | boolean | Date | FormulaString
description 单元格值类型。
Ƭ CheckboxOptions: Object
property type - 单元格类型，支持"checkbox"(复选框)
property caption - 标题文本
property textTrue - 单元格值为true时显示的文本
property textIndeterminate - 单元格值为不确定状态时显示的文本
property textFalse - 单元格值为false时显示的文本
property textAlign - 文本相对于复选框的对齐方式，支持"top"(顶部)、"bottom"(底部)、"left"(左侧)、"right"(右侧)
property isThreeState - 复选框是否支持三态
property boxSize - 复选框大小
| Name | Type | Description |
|---|---|---|
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: Object
property name - 分组名称
property {string[][]} colors - 分组颜色（二维数组）
property needScaleColor - 是否生成渐变色分组
| Name | Type | Description |
|---|---|---|
colors |
string[][] |
分组颜色（二维数组） |
name |
string |
分组名称 |
needScaleColor |
boolean |
是否生成渐变色分组 |
Ƭ ColorPickerOptions: Object
property colorBlockSize - 每个颜色单元格的尺寸
property {GC.Data.ColorPickerGroup[]} groups - 颜色选择器的分组，每个分组包含一个分组名称（name）和一个颜色数组（colors）作为该分组的颜色集合
| Name | Type | Description |
|---|---|---|
colorBlockSize |
number |
每个颜色单元格的尺寸 |
groups |
ColorPickerGroup[] |
颜色选择器的分组，每个分组包含一个分组名称（name）和一个颜色数组（colors）作为该分组的颜色集合 |
Ƭ ColorString: string
description 字符串类型的颜色。
Ƭ ColumnBindingInfo: Object
property name - 通过名称绑定的数据列
property displayName - 此列的显示名称
property formatter - 此列的格式化器
property {number | string} size - 列的尺寸
property visible - 列的可见性
| Name | Type | Description |
|---|---|---|
displayName? |
string |
此列的显示名称 |
formatter? |
string |
此列的格式化器 |
name |
string |
通过名称绑定的数据列 |
size? |
number | string |
列的尺寸 |
visible? |
boolean |
列的可见性 |
Ƭ ColumnType: "Number" | "Text" | "Formula" | "Checkbox" | "Date" | "Currency" | "Percent" | "Phone" | "Email" | "URL" | "Lookup" | "CreatedTime" | "ModifiedTime" | "Attachment" | "Select" | "Barcode"
Ƭ ComboBoxOptions: Object
property type - 单元格类型，支持"combobox"(组合框)
property editorValueType - 编辑器值类型，支持"text"(文本)、"index"(索引)、"value"(值)
property {string[] | GC.Data.ItemOptions[]} items - 选项列表，支持字符串数组或包含text和value属性的对象数组
property itemHeight - 每个选项的高度
property maxDropDownItems - 下拉列表每页显示的最大选项数
property editable - 组合框是否可编辑
| Name | Type | Description |
|---|---|---|
editable? |
boolean |
组合框是否可编辑 |
editorValueType? |
"text" | "index" | "value" |
编辑器值类型，支持"text"(文本)、"index"(索引)、"value"(值) |
itemHeight? |
number |
每个选项的高度 |
items |
string[] | ItemOptions[] |
选项列表，支持字符串数组或包含text和value属性的对象数组 |
maxDropDownItems? |
number |
下拉列表每页显示的最大选项数 |
type |
"combobox" |
单元格类型，支持"combobox"(组合框) |
Ƭ CornerFold: Object
property size - 边角折叠的尺寸
property position - 边角折叠的位置，支持"leftTop"(左上)、"rightTop"(右上)、"leftBottom"(左下)、"rightBottom"(右下)
property color - 边角折叠的颜色
| Name | Type | Description |
|---|---|---|
color? |
string |
边角折叠的颜色 |
position? |
"leftTop" | "rightTop" | "leftBottom" | "rightBottom" |
边角折叠的位置，支持"leftTop"(左上)、"rightTop"(右上)、"leftBottom"(左下)、"rightBottom"(右下) |
size? |
number |
边角折叠的尺寸 |
Ƭ DataBarAxisPosition: "automatic" | "cellMidPoint" | "none"
description 数据条规则轴位置。
Ƭ DataBarRuleDirection: "leftToRight" | "rightToLeft"
description 数据条规则方向。
Ƭ DataBarRuleNegativeOptions: Object
property negativeFillColor - 负值填充颜色
property useNegativeFillColor - 是否使用负值填充颜色来绘制负值
property negativeBorderColor - 负值边框颜色
property useNegativeBorderColor - 是否使用负值边框颜色来绘制负值边框
property axisColor - 数据条的轴线颜色
property axisPosition - 数据条的轴线位置
| Name | Type | Description |
|---|---|---|
axisColor |
ColorString |
数据条的轴线颜色 |
axisPosition |
DataBarAxisPosition |
数据条的轴线位置 |
negativeBorderColor |
ColorString |
负值边框颜色 |
negativeFillColor |
ColorString |
负值填充颜色 |
useNegativeBorderColor |
boolean |
是否使用负值边框颜色来绘制负值边框 |
useNegativeFillColor |
boolean |
是否使用负值填充颜色来绘制负值 |
Ƭ DataBarRuleOptions: Object
property {"dataBarRule"} ruleType - 若要使用数据条规则，需指定此规则类型
property minType - 最小刻度类型
property minValue - 最小刻度值
property maxType - 最大刻度类型
property maxValue - 最大刻度值
property maxColor - 最大刻度颜色字符串
property priority - 规则的优先级
property stopIfTrue - 在应用此规则前是否应用优先级较低的规则
property gradient - 数据条是否为渐变
property showBarOnly - 是否只显示数据条而不显示文本
property showBorder - 是否绘制边框
property borderColor - 边框颜色
property barDirection - 数据条方向
property negativeData - 数据条规则负数数据选项
| Name | Type | Description |
|---|---|---|
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: Object
property {"dateOccurringRule"} ruleType - 若要使用日期发生规则，需指定此规则类型
property type - 日期发生类型
property style - 当条件满足时应用于单元格的样式
property priority - 规则的优先级
property stopIfTrue - 在应用此规则前是否应用优先级较低的规则
| Name | Type | Description |
|---|---|---|
priority |
number |
规则的优先级 |
ruleType |
"dateOccurringRule" |
若要使用日期发生规则，需指定此规则类型 |
stopIfTrue |
boolean |
在应用此规则前是否应用优先级较低的规则 |
style |
StyleOptions |
当条件满足时应用于单元格的样式 |
type |
DateOccurringType |
日期发生类型 |
Ƭ DateOccurringType: "today" | "yesterday" | "tomorrow" | "last7Days" | "thisMonth" | "lastMonth" | "nextMonth" | "thisWeek" | "lastWeek" | "nextWeek" | "nextQuarter" | "thisQuarter" | "lastQuarter" | "nextYear" | "thisYear" | "lastYear"
description 日期发生类型。
Ƭ DateTimePickerOptions: Object
property showTime - 日历是否需要显示时间部分
property calendarPage - 默认页面，可选值为"year"(年)、"month"(月)、"day"(日)
property startDay - 一周的起始日，通常为周一或周日，用户可设置任意一天作为起始日。可选值为"monday"(周一)、"tuesday"(周二)、"wednesday"(周三)、"thursday"(周四)、"friday"(周五)、"saturday"(周六)、"sunday"(周日)
| Name | Type | Description |
|---|---|---|
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: Object
property {"date"} type - 数据验证器类型
property comparisonOperator - 数据验证器比较运算符
property {Date | GC.Data.FormulaString} value1 - 数据验证器第一个值
property {Date | GC.Data.FormulaString} value2 - 当验证器比较运算符为"between"或"notBetween"时的第二个值
property ignoreBlank - 是否忽略空值
property inCellDropdown - 是否显示下拉按钮
property errorStyle - 数据验证器错误样式
property errorTitle - 数据验证器错误标题
property errorMessage - 数据验证器错误消息
property showErrorMessage - 是否显示错误消息
property inputMessage - 数据验证器输入提示消息
property inputTitle - 数据验证器输入提示标题
property showInputMessage - 是否显示输入提示消息
property highlightStyle - 数据验证器高亮样式
| Name | Type | Description |
|---|---|---|
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: Object
property {GC.Data.Icon[]} icons - 样式中装饰的图标数组
property cornerFold - 样式中装饰的边角折叠效果
| Name | Type | Description |
|---|---|---|
cornerFold? |
CornerFold |
样式中装饰的边角折叠效果 |
icons? |
Icon[] |
样式中装饰的图标数组 |
Ƭ DropDownOptions: Object
property 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 - 下拉选项配置
property submitCommand - 提交下拉值时执行的命令名称或回调函数
| Name | Type | Description |
|---|---|---|
option? |
ColorPickerOptions | DateTimePickerOptions | TimePickerOptions | MonthPickerOptions | ListOptions | SliderOptions | WorkFlowOptions | MultiColumnOptions |
下拉选项配置 |
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: Object
property {"duplicateRule"} ruleType - 若要使用重复值规则，需指定此规则类型
property style - 当条件满足时应用于单元格的样式
property priority - 规则的优先级
property stopIfTrue - 在应用此规则前是否应用优先级较低的规则
| Name | Type | Description |
|---|---|---|
priority |
number |
规则的优先级 |
ruleType |
"duplicateRule" |
若要使用重复值规则，需指定此规则类型 |
stopIfTrue |
boolean |
在应用此规则前是否应用优先级较低的规则 |
style |
StyleOptions |
当条件满足时应用于单元格的样式 |
Ƭ ErrorStyle: "stop" | "warning" | "information"
description 验证器错误样式。
Ƭ FileUploadOptions: Object
property type - 单元格类型，支持"fileUpload"(文件上传)
property maxSize - 可上传的最大文件大小(单位：字节)
property accept - 允许上传的文件类型，格式如："image/*,.pdf,.doc"
property isPreviewEnabled - 是否显示文件预览按钮
property isDownloadEnabled - 是否显示文件下载按钮
property isClearEnabled - 是否显示文件清除按钮
property marginTop - 元素上边距(单位：像素)
property marginRight - 元素右边距(单位：像素)
property marginBottom - 元素下边距(单位：像素)
property marginLeft - 元素左边距(单位：像素)
property valuePath - 从文件对象中获取单元格值的路径，如"name"获取文件名
| Name | Type | Description |
|---|---|---|
accept? |
string |
允许上传的文件类型，格式如："image/*,.pdf,.doc" |
isClearEnabled? |
boolean |
是否显示文件清除按钮 |
isDownloadEnabled? |
boolean |
是否显示文件下载按钮 |
isPreviewEnabled? |
boolean |
是否显示文件预览按钮 |
marginBottom? |
number |
元素下边距(单位：像素) |
marginLeft? |
number |
元素左边距(单位：像素) |
marginRight? |
number |
元素右边距(单位：像素) |
marginTop? |
number |
元素上边距(单位：像素) |
maxSize? |
number |
- |
type |
"fileUpload" |
单元格类型，支持"fileUpload"(文件上传) |
valuePath? |
string |
从文件对象中获取单元格值的路径，如"name"获取文件名 |
Ƭ FormulaListValidatorOptions: Object
property {"formulaList"} type - 数据验证器类型
property formula - 当验证器类型为"formula"或"formulaList"时使用的公式
property ignoreBlank - 是否忽略空值
property inCellDropdown - 是否显示下拉按钮
property errorStyle - 数据验证错误样式
property errorTitle - 数据验证错误标题
property errorMessage - 数据验证错误消息
property showErrorMessage - 是否显示错误消息
property inputMessage - 数据验证输入提示消息
property inputTitle - 数据验证输入提示标题
property showInputMessage - 是否显示输入提示消息
property highlightStyle - 数据验证高亮样式
| Name | Type | Description |
|---|---|---|
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: Object
property formula - 公式。
description 公式规则。
| Name | Type | Description |
|---|---|---|
formula |
FormulaString |
公式字符串 |
Ƭ FormulaRuleOptions: Object
property {"formulaRule"} ruleType - 若要使用公式规则，需指定此规则类型
property formula - 公式
property style - 当条件满足时应用于单元格的样式
property priority - 规则的优先级
property stopIfTrue - 在应用此规则前是否应用优先级较低的规则
| Name | Type | Description |
|---|---|---|
formula |
FormulaString |
公式 |
priority |
number |
规则的优先级 |
ruleType |
"formulaRule" |
若要使用公式规则，需指定此规则类型 |
stopIfTrue |
boolean |
在应用此规则前是否应用优先级较低的规则 |
style |
StyleOptions |
当条件满足时应用于单元格的样式 |
Ƭ FormulaString: string
Ƭ FormulaValidatorOptions: Object
property {"formula"} type - 数据验证器类型
property formula - 当验证器类型为"formula"或"formulaList"时使用的公式
property ignoreBlank - 是否忽略空值
property inCellDropdown - 是否显示下拉按钮
property errorStyle - 数据验证错误样式
property errorTitle - 数据验证错误标题
property errorMessage - 数据验证错误消息
property showErrorMessage - 是否显示错误消息
property inputMessage - 数据验证输入提示消息
property inputTitle - 数据验证输入提示标题
property showInputMessage - 是否显示输入提示消息
property highlightStyle - 数据验证高亮样式
| Name | Type | Description |
|---|---|---|
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: Object
property degree - 渐变填充角度。
property {GC.Data.GradientStop[]} stops - 渐变填充停止点。
| Name | Type | Description |
|---|---|---|
degree? |
number |
渐变填充角度。 |
stops |
GradientStop[] |
渐变填充停止点。 |
Ƭ GradientPathFillOptions: Object
property type - 渐变路径填充类型，支持"path"(路径)
property left - 渐变路径填充的左侧位置
property right - 渐变路径填充的右侧位置
property top - 渐变路径填充的顶部位置
property bottom - 渐变路径填充的底部位置
property {GC.Data.GradientStop[]} stops - 渐变路径填充的色标数组
| Name | Type | Description |
|---|---|---|
bottom? |
number |
渐变路径填充的底部位置 |
left? |
number |
渐变路径填充的左侧位置 |
right? |
number |
渐变路径填充的右侧位置 |
stops |
GradientStop[] |
渐变路径填充的色标数组 |
top? |
number |
渐变路径填充的顶部位置 |
type |
"path" |
渐变路径填充类型，支持"path"(路径) |
Ƭ GradientStop: Object
property color - 渐变色标颜色
property position - 渐变色标位置（取值范围通常为0-1）
| Name | Type | Description |
|---|---|---|
color |
string |
渐变色标颜色 |
position |
number |
渐变色标位置（取值范围通常为0-1） |
Ƭ HeaderStyleOptions: Object
property {string | GC.Data.PatternFillOptions | GC.Data.GradientFillOptions | GC.Data.GradientPathFillOptions} backColor - 背景颜色字符串或图案填充选项、渐变填充选项、渐变路径填充选项
property foreColor - 前景色（字体颜色）
property hAlign - 水平对齐方式，支持"left"(左对齐)、"center"(居中对齐)、"right"(右对齐)、"general"(常规对齐)
property vAlign - 垂直对齐方式，支持"top"(顶端对齐)、"center"(居中对齐)、"bottom"(底端对齐)
property font - 字体样式（如"微软雅黑, 12px"）
property themeFont - 主题字体
property formatter - 格式化字符串（用于数据展示格式控制）
property borderLeft - 左边框样式
property borderTop - 上边框样式
property borderRight - 右边框样式
property borderBottom - 下边框样式
property diagonalDown - 从左上到右下的对角线边框
property diagonalUp - 从右上到左下的对角线边框
property locked - 单元格/行/列是否锁定（禁止编辑）
property textIndent - 文本缩进量（单位：像素）
property wordWrap - 是否自动换行
property shrinkToFit - 内容是否自动缩小以适应单元格
property backgroundImage - 背景图片路径或数据URL
property backgroundImageLayout - 背景图片布局方式，支持"stretch"(拉伸)、"center"(居中)、"zoom"(缩放)、"none"(原始尺寸)
property textDecoration - 文本装饰（如下划线、删除线等）
property name - 样式名称
property parentName - 父样式名称（继承样式时使用）
property watermark - 水印内容
property cellPadding - 单元格内边距（如"5px 10px"）
property labelOptions - 单元格标签选项
property isVerticalText - 是否设置单元格文本垂直显示
property showEllipsis - 文本超出范围时是否显示省略号（...）
property decoration - 装饰样式（图标、边角折叠等）
| Name | Type | Description |
|---|---|---|
backColor? |
string | PatternFillOptions | GradientFillOptions | GradientPathFillOptions |
背景颜色字符串或图案填充选项、渐变填充选项、渐变路径填充选项 |
backgroundImage? |
string |
背景图片路径或数据URL |
backgroundImageLayout? |
"stretch" | "center" | "zoom" | "none" |
背景图片布局方式，支持"stretch"(拉伸)、"center"(居中)、"zoom"(缩放)、"none"(原始尺寸) |
borderBottom? |
LineBorder |
下边框样式 |
borderLeft? |
LineBorder |
左边框样式 |
borderRight? |
LineBorder |
右边框样式 |
borderTop? |
LineBorder |
上边框样式 |
cellPadding? |
string |
单元格内边距（如"5px 10px"） |
decoration? |
Decoration |
装饰样式（图标、边角折叠等） |
diagonalDown? |
LineBorder |
从左上到右下的对角线边框 |
diagonalUp? |
LineBorder |
从右上到左下的对角线边框 |
font? |
string |
字体样式（如"微软雅黑, 12px"） |
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: (options: IHierarchyCustomParseOptions) => any
▸ (options): any
description 获取当前记录的父级ID
| Name | Type | Description |
|---|---|---|
options |
IHierarchyCustomParseOptions |
处理器选项 |
any
当前记录的父级ID返回值
Ƭ HierarchyCustomUnparseHandler: (options: IHierarchyCustomUnparseOptions) => any
▸ (options): any
description 获取当前记录的ID
| Name | Type | Description |
|---|---|---|
options |
IHierarchyCustomUnparseOptions |
处理器选项 |
any
当前记录的ID返回值
Ƭ HighlightStyle: Object
property {"circle" | "dogEar" | "icon"} type - 高亮类型，支持"circle"(圆形)、"dogEar"(狗耳形)、"icon"(图标)
property color - 高亮颜色
property {"topLeft" | "topRight" | "bottomRight" | "bottomLeft" | "outsideLeft" | "outsideRight"} position - 高亮位置，支持"topLeft"(左上)、"topRight"(右上)、"bottomRight"(右下)、"bottomLeft"(左下)、"outsideLeft"(外侧左)、"outsideRight"(外侧右)
property image - 高亮图像，支持URL或Base64数据
| Name | Type | Description |
|---|---|---|
color? |
string |
高亮颜色 |
image? |
string |
高亮图像，支持URL或Base64数据 |
position |
"topLeft" | "topRight" | "bottomRight" | "bottomLeft" | "outsideLeft" | "outsideRight" |
高亮位置 |
type? |
"circle" | "dogEar" | "icon" |
高亮类型 |
Ƭ HyperlinkOptions: Object
property type - 单元格类型，支持"hyperlink"(超链接)
property linkColor - 链接颜色
property visitedLinkColor - 已访问链接的颜色
property text - 链接文本
property linkToolTip - 链接提示文本
property target - 链接目标类型，支持"blank"(新窗口)、"self"(当前窗口)、"parent"(父框架)、"top"(顶级框架)
property activeOnClick - 点击时是否移动到活动单元格
| Name | Type | Description |
|---|---|---|
activeOnClick |
boolean |
点击时是否移动到活动单元格 |
linkColor |
string |
链接颜色 |
linkToolTip |
string |
链接提示文本 |
target |
"blank" | "self" | "parent" | "top" |
链接目标类型，支持"blank"(新窗口)、"self"(当前窗口)、"parent"(父框架)、"top"(顶级框架) |
text |
string |
链接文本 |
type |
"hyperlink" |
单元格类型，支持"hyperlink"(超链接) |
visitedLinkColor |
string |
已访问链接的颜色 |
Ƭ IColumn: Object
property name - 列的唯一名称
property value - 列的值，可以是数据库表的字段名，或使用字段名的公式
property type - 列类型，可选"Number"(数字)、"Text"(文本)、"Formula"(公式)、"Checkbox"(复选框)、"Date"(日期)、"Currency"(货币)、"Percent"(百分比)、"Phone"(电话)、"Email"(电子邮件)、"URL"(网址)、"Lookup"(查找)、"CreatedTime"(创建时间)、"ModifiedTime"(修改时间)、"Attachment"(附件)、"Select"(选择)、"Barcode"(条形码)
property {string | string[]} caption - 列标题
property {number | string} width - 列宽度，支持像素值或星号大小
property 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 - 列的数据验证器
property isPrimaryKey - 将列标记为主键列
property readonly - 标记列为只读
property required - 标记在插入新行时列为必填项
property defaultValue - 在插入新行时提供默认值，可以是常量或公式
property headerStyle - 列的表头样式
property visible - 标记列是否可见
property headerFit - 表头适应模式，可选"normal"(正常)、"vertical"(垂直)或"stack"(堆叠)。默认值为"normal"
property dataType - 原始值的实际数据类型，可选"string"(字符串)、"number"(数字)、"boolean"(布尔值)、"object"(对象)、"formula"(公式)、"array"(数组)、"date"(日期)或"rowOrder"(行顺序)。这对日期特别有用，因为日期在JSON数据中是字符串，需要转换
property dataPattern - 用于将字符串解析为值的数据模式，如日期字符串的格式"dd/MM/yyyy"、布尔字符串的真假值对"Yes|No"、数字字符串的小数点分隔符","
property dataMap - 一个简单的映射，使原始值显示得更有意义，其键可以是数字或字符串，其值可以是数字、字符串或日期
property spread - 当列的值是对象时是否展开列
property dataName - 表字段的原始名称，使用此属性将原始名称映射到指定名称
property indexed - 在创建表时是否需要创建过滤缓存
property allowSort - 打开过滤对话框后是否显示排序选项
property allowFilterByValue - 打开过滤对话框后是否显示按值过滤选项
property 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 - 仅当数据是层次结构数据时定义大纲列
property trigger - 列的触发公式
| Name | Type | Description |
|---|---|---|
allowFilterByList? |
boolean |
打开过滤对话框后是否显示按列表过滤选项 |
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 |
用于将字符串解析为值的数据模式 |
dataType? |
"string" | "number" | "boolean" | "object" | "formula" | "array" | "date" | "rowOrder" | "TaskStartDate" | "TaskFinishDate" | "TaskDuration" | "TaskSubject" | "TaskSchedulingMode" | "TaskComplete" | "TaskPredecessor" |
原始值的实际数据类型 |
defaultValue? |
any |
在插入新行时提供默认值 |
headerFit? |
"normal" | "vertical" | "stack" |
表头适应模式 |
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 |
列的触发公式 |
type? |
string |
列类型 |
validator? |
NumberValidatorOptions | DateValidatorOptions | TimeValidatorOptions | TextLengthValidatorOptions | FormulaValidatorOptions | FormulaListValidatorOptions | ListValidatorOptions |
列的数据验证器 |
value? |
string |
列的值，可以是数据库表的字段名，或使用字段名的公式 |
visible? |
boolean |
标记列是否可见 |
width? |
number | string |
列宽度 |
Ƭ IColumnCollection: Object
property key - 一个键值对集合，其中键为字符串，值为GC.Data.IColumn对象。
▪ [key: string]: IColumn
Ƭ ICrossAttributeOptions: Object
property value - 用于定义交叉列的标题
property formatter - 用于格式化值
description 定义交叉列标题的选项
| Name | Type | Description |
|---|---|---|
formatter? |
string |
用于格式化值 |
value |
string |
用于定义交叉列的标题 |
Ƭ ICrossOptions: Object
property over - 用于查找交叉列的键
property {(string | GC.Data.ICrossAttributeOptions)[]} attributes - 用于定义交叉列多级标题的属性
property filter - 用于过滤交叉列的公式
property caption - 自定义标题
description 定义交叉列的选项
| Name | Type | Description |
|---|---|---|
attributes? |
(string | ICrossAttributeOptions)[] |
用于定义交叉列多级标题的属性 |
caption? |
string |
自定义标题 |
filter? |
string |
用于过滤交叉列的公式 |
over |
string |
用于查找交叉列的键 |
Ƭ ICrossViewOptions: Object
property key - 一个键值对集合，其中键为字符串，值为GC.Data.ICrossOptions对象。
▪ [key: string]: ICrossOptions
Ƭ IDataSourceOption: Object
property {Array | string} data - 本地数据源，可以是JSON对象数组、CSV或XML字符串
property remote - 远程数据源，支持REST API、OData、GraphQL
property autoSync - 自动同步模式下，数据变更会立即同步到服务器
property batch - 批量模式下，数据变更会暂存于数据源，需调用submitChanges方法同步到服务器
property schema - 数据源架构选项
| Name | Type | Description |
|---|---|---|
autoSync? |
boolean |
是否启用自动同步 |
batch? |
boolean |
是否启用批量模式 |
data? |
any |
本地数据源 |
remote? |
IRemoteTransportOption |
远程数据源 |
schema? |
ISchemaOption |
数据源架构选项 |
Ƭ IFormulaCollection: Object
property key - 键值集合，键为字符串，值为公式字符串
▪ [key: string]: string
Ƭ IHierarchyCustomParseOptions: Object
property data - 当前记录的数据
property index - 记录索引
| Name | Type | Description |
|---|---|---|
data |
any |
当前记录的数据 |
index |
number |
记录索引 |
Ƭ IHierarchyCustomUnparseOptions: Object
property data - 当前记录的数据
property index - 记录索引
property parentData - 父级记录的数据
| Name | Type | Description |
|---|---|---|
data |
any |
当前记录的数据 |
index |
number |
记录索引 |
parentData |
any |
父级记录的数据 |
Ƭ IHierarchyOption: Object
property type - 支持'Parent'(父级)、'ChildrenPath'(子路径)、'Level'(层级)、'Custom'(自定义)
property column - 用于构建层级结构数据的列
property {string | GC.Data.IHierarchyOutlineColumnOptions} outlineColumn - 层级结构显示列的大纲列定义
property summaryFields - 层级结构汇总字段集合定义
property parse - 自定义层级结构解析父级ID的处理器
property unparse - 自定义层级结构反解析记录ID的处理器
| Name | Type | Description |
|---|---|---|
column |
string |
构建层级结构的列 |
outlineColumn? |
string | IHierarchyOutlineColumnOptions |
大纲列定义 |
parse? |
HierarchyCustomParseHandler |
自定义解析处理器 |
summaryFields? |
IHierarchySummaryFieldCollection |
汇总字段集合定义 |
type |
"Parent" | "ChildrenPath" | "Level" | "Custom" |
层级结构类型 |
unparse? |
HierarchyCustomUnparseHandler |
自定义反解析处理器 |
Ƭ IHierarchyOutlineColumnOptions: Object
property value - 指定显示为层级结构的列
property showCheckBox - 是否显示复选框
property showImage - 是否显示图片
property {string[]} images - 按层级显示的图片（URL或Base64图片）
property showIndicator - 是否显示指示器
property expandIndicator - 展开指示器（URL或Base64图片）
property collapseIndicator - 折叠指示器（URL或Base64图片）
| Name | Type | Description |
|---|---|---|
collapseIndicator? |
string |
折叠指示器 |
expandIndicator? |
string |
展开指示器 |
images? |
string[] |
按层级显示的图片 |
showCheckBox? |
boolean |
是否显示复选框 |
showImage? |
boolean |
是否显示图片 |
showIndicator? |
boolean |
是否显示指示器 |
value |
string |
指定显示为层级结构的列 |
Ƭ IHierarchySummaryFieldCollection: Object
property key - 键值集合，键为字段字符串，值为公式字符串
▪ [key: string]: string
Ƭ ILookupOptions: Object
property name - 关联关系名称
property {string[] | GC.Data.IColumn[]} columns - 相关表的列定义，用于多列下拉
| Name | Type | Description |
|---|---|---|
columns |
string[] | IColumn[] |
相关表的列定义 |
name |
string |
关联关系名称 |
Ƭ IOutlineColumnOptions: Object
property showCheckBox - 是否显示复选框
property showImage - 是否显示图片
property {string[]} images - 按层级显示的图片（URL或Base64图片）
property showIndicator - 是否显示指示器
property expandIndicator - 展开指示器（URL或Base64图片）
property collapseIndicator - 折叠指示器（URL或Base64图片）
| Name | Type | Description |
|---|---|---|
collapseIndicator? |
string |
折叠指示器 |
expandIndicator? |
string |
展开指示器 |
images? |
string[] |
按层级显示的图片 |
showCheckBox? |
boolean |
是否显示复选框 |
showImage? |
boolean |
是否显示图片 |
showIndicator? |
boolean |
是否显示指示器 |
Ƭ IRemoteFetchOption: RequestInit
Ƭ IRemoteReadRequestOption: Object
property url - 请求URL
property method - 请求方法，如'GET'、'POST'、'PUT'、'DELETE'，默认值为'GET'
property options - 请求选项（类似Fetch API的RequestInit，可选）
property adapter - 适配不同数据协议，支持"rest"、"odata"、"odata4"、"graphql"
property body - 请求体
| Name | Type | Description |
|---|---|---|
adapter? |
string |
适配的数据协议 |
body? |
Object |
请求体 |
method? |
"GET" | "POST" | "PUT" | "DELETE" |
请求方法 |
options? |
IRemoteFetchOption |
请求选项 |
url |
string |
请求URL |
Ƭ IRemoteRequestOption: Object
property url - 请求URL
property method - 请求方法，如'GET'、'POST'、'PUT'、'DELETE'，默认值为'GET'
property options - 请求选项（类似Fetch API的RequestInit，可选）
| Name | Type | Description |
|---|---|---|
method? |
"GET" | "POST" | "PUT" | "DELETE" |
请求方法，如'GET'、'POST'、'PUT'、'DELETE'，默认值为'GET' |
options? |
IRemoteFetchOption |
请求选项（类似Fetch API的RequestInit，可选） |
url |
string |
请求URL |
Ƭ 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 - 删除列操作选项
| Name | Type | Description |
|---|---|---|
addColumn? |
IRemoteRequestOption | RemoteChangeHandler |
添加列操作选项 |
batch? |
IRemoteRequestOption | RemoteChangeHandler |
批量操作选项 |
create? |
IRemoteRequestOption | RemoteChangeHandler |
创建操作选项 |
delete? |
IRemoteRequestOption | RemoteChangeHandler |
删除操作选项 |
getColumns? |
IRemoteReadRequestOption | RemoteReadHandler |
获取列操作选项 |
read |
IRemoteReadRequestOption | RemoteReadHandler |
读取操作选项 |
removeColumn? |
IRemoteRequestOption | RemoteChangeHandler |
删除列操作选项 |
update? |
IRemoteRequestOption | RemoteChangeHandler |
更新操作选项 |
updateColumn? |
IRemoteRequestOption | RemoteChangeHandler |
更新列操作选项 |
Ƭ ISchemaOption: Object
property type - 支持'json'、'csv'、'xml'、'columnJson'
property countPath - 数据读取器用于获取数据源集合长度，未指定时返回当前数据源集合长度
property dataPath - 数据读取器用于获取解析后的数据源集合，未指定时返回整个解析对象
property columns - 当前表所有列的定义
property window - 窗口链所有公式的定义
property hierarchy - 层级结构选项定义
| Name | Type | Description |
|---|---|---|
columns? |
IColumnCollection |
当前表所有列的定义 |
countPath? |
string |
数据读取器用于获取数据源集合长度，未指定时返回当前数据源集合长度 |
dataPath? |
string |
数据读取器用于获取解析后的数据源集合，未指定时返回整个解析对象 |
hierarchy? |
IHierarchyOption |
层级结构选项定义 |
type? |
string |
支持'json'、'csv'、'xml'、'columnJson' |
window? |
IFormulaCollection |
窗口链所有公式的定义 |
Ƭ ITriggerFormulaOption: Object
property when - 指示何时触发公式
property formula - 要触发的公式
property fields - 监控的字段，更新时可触发公式，"*" 表示任意字段，新增数据时可省略
description 定义触发公式的选项
| Name | Type | Description |
|---|---|---|
fields? |
string |
监控的字段，更新时可触发公式，"*" 表示任意字段，新增数据时可省略 |
formula |
string |
要触发的公式 |
when |
"onNew" | "onNewAndUpdate" |
指示何时触发公式 |
Ƭ Icon: Object
property position - 图标位置，支持"left"(左侧)、"right"(右侧)、"leftOfText"(文本左侧)、"rightOfText"(文本右侧)、"outsideLeft"(外侧左)、"outsideRight"(外侧右)
property width - 绘制宽度
property height - 绘制高度
property src - 图标路径
| Name | Type | Description |
|---|---|---|
height? |
number |
绘制高度 |
position? |
"left" | "right" | "leftOfText" | "rightOfText" | "outsideLeft" | "outsideRight" |
图标位置 |
src? |
string |
图标路径 |
width? |
number |
绘制宽度 |
Ƭ IconCriteriaOptions: Object
property isGreaterThanOrEqualTo - 若设置为true，使用大于或等于运算符计算值
property iconValueType - 图标值类型
property {number|string} iconValue - 图标值
| Name | Type | Description |
|---|---|---|
iconValue |
number | string |
图标值 |
iconValueType |
IconValueType |
图标值类型 |
isGreaterThanOrEqualTo |
boolean |
若设置为true，使用大于或等于运算符计算值 |
Ƭ IconOptions: Object
property iconSetType - 图标集类型
property iconIndex - 自定义图标索引
| Name | Type | Description |
|---|---|---|
iconIndex |
number |
自定义图标索引 |
iconSetType |
IconSetType |
图标集类型 |
Ƭ IconSetRuleOptions: Object
property {"iconSetRule"} ruleType - 若要使用图标集规则，需指定此规则类型
property iconSetType - 图标集类型
property reverseIconOrder - 是否反转图标顺序
property showIconOnly - 是否仅显示图标
property {GC.Data.IconOptions[]} icons - 图标选项数组
property priority - 规则的优先级
property stopIfTrue - 在应用此规则前是否应用优先级较低的规则
| Name | Type | Description |
|---|---|---|
iconSetType |
IconSetType |
图标集类型 |
icons |
IconOptions[] |
图标选项数组 |
priority |
number |
规则的优先级 |
reverseIconOrder |
boolean |
是否反转图标顺序 |
ruleType |
"iconSetRule" |
若要使用图标集规则，需指定此规则类型 |
showIconOnly |
boolean |
是否仅显示图标 |
stopIfTrue |
boolean |
在应用此规则前是否应用优先级较低的规则 |
Ƭ IconSetType: "threeArrowsColored" | "threeArrowsGray" | "threeTriangles" | "threeStars" | "threeFlags" | "threeTrafficLightsUnrimmed" | "threeTrafficLightsRimmed" | "threeSigns" | "threeSymbolsCircled" | "threeSymbolsUncircled" | "fourArrowsColored" | "fourArrowsGray" | "fourRedToBlack" | "fourRatings" | "fourTrafficLights" | "fiveArrowsColored" | "fiveArrowsGray" | "fiveRatings" | "fiveQuarters" | "fiveBoxes" | "noIcons"
description 图标集类型
Ƭ IconValueType: "number" | "percent" | "formula" | "percentile"
description 图标值类型
Ƭ ItemOptions: Object
property text - 条目文本
property value - 条目值，可以是数字、字符串、布尔值、日期
| Name | Type | Description |
|---|---|---|
text |
string |
条目文本 |
value |
any |
条目值，可以是数字、字符串、布尔值、日期 |
Ƭ LabelOptions: Object
property alignment - 单元格标签位置，支持"topLeft"(左上)、"topCenter"(中上)、"topRight"(右上)、"bottomLeft"(左下)、"bottomCenter"(中下)、"bottomRight"(右下)
property visibility - 单元格标签可见性，支持"visible"(可见)、"hidden"(隐藏)、"auto"(自动)
property font - 单元格标签字体
property foreColor - 单元格标签前景色
property margin - 单元格标签边距
| Name | Type | Description |
|---|---|---|
alignment |
"topLeft" | "topCenter" | "topRight" | "bottomLeft" | "bottomCenter" | "bottomRight" |
单元格标签位置 |
font |
string |
单元格标签字体 |
foreColor |
string |
单元格标签前景色 |
margin |
string |
单元格标签边距 |
visibility |
"visible" | "hidden" | "auto" |
单元格标签可见性 |
Ƭ LineBorder: Object
property color - 边框颜色
property style - 边框样式，支持"empty"(无)、"thin"(细)、"medium"(中)、"dashed"(虚线)、"dotted"(点线)、"thick"(粗)、"double"(双线)、"hair"(极细)、"mediumDashed"(中虚线)、"dashDot"(点划线)、"mediumDashDot"(中点划线)、"dashDotDot"(双点划线)、"mediumDashDotDot"(中双点划线)、"slantedDashDot"(斜点划线)
| Name | Type | Description |
|---|---|---|
color |
string |
边框颜色 |
style |
"empty" | "thin" | "medium" | "dashed" | "dotted" | "thick" | "double" | "hair" | "mediumDashed" | "dashDot" | "mediumDashDot" | "dashDotDot" | "mediumDashDotDot" | "slantedDashDot" |
边框样式 |
Ƭ ListItem: Object
property text - 项文本
property value - 项值
property icon - 项图标
| Name | Type | Description |
|---|---|---|
icon? |
string |
项图标 |
text? |
string |
项文本 |
value? |
string |
项值 |
Ƭ ListLayout: Object
property direction - 布局方向，支持"horizontal"(水平)、"vertical"(垂直)
property displayAs - 布局显示方式，支持"inline"(内联)、"popup"(弹出)、"tree"(树状)
property collapsible - 列表是否可折叠
| Name | Type | Description |
|---|---|---|
collapsible? |
boolean |
列表是否可折叠 |
direction? |
"horizontal" | "vertical" |
布局方向 |
displayAs? |
"inline" | "popup" | "tree" |
布局显示方式 |
Ƭ ListOptions: Object
property text - 文本
property layout - 布局
property multiSelect - 是否设置为多选列表
property valueType - 下拉列表结果的单元格值类型，支持"string"(字符串)、"array"(数组)
property {GC.Data.ListItem[] | GC.Data.ListOptions[] | Function} items - 列表项。通常接受数组，特殊情况下可接受函数（返回DOM元素）
property onItemSelected - 选中项或子项时触发的回调
| Name | Type | Description |
|---|---|---|
items |
ListItem[] | ListOptions[] | () => HTMLElement |
返回DOM元素的函数 |
layout? |
ListLayout |
布局 |
multiSelect? |
boolean |
是否设置为多选列表 |
text? |
string |
文本 |
valueType? |
"string" | "array" |
下拉列表结果的单元格值类型 |
onItemSelected? |
(e: MouseEvent) => string |
选中项时的回调（当items为函数时使用） |
Ƭ ListString: string
description 列表类型字符串，如"1,2,3"。
Ƭ ListValidatorOptions: Object
property {"list"} type - 数据验证器类型
property source - 数据验证器来源
property ignoreBlank - 是否忽略空值
property inCellDropdown - 是否显示下拉按钮
property errorStyle - 数据验证错误样式
property errorTitle - 数据验证错误标题
property errorMessage - 数据验证错误消息
property showErrorMessage - 是否显示错误消息
property inputMessage - 数据验证输入提示消息
property inputTitle - 数据验证输入提示标题
property showInputMessage - 是否显示输入提示消息
property highlightStyle - 数据验证高亮样式
| Name | Type | Description |
|---|---|---|
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: Object
property pattern - 掩码模式
property placeholder - 掩码占位符
property excludeLiteral - 是否排除文本字符
property excludePlaceholder - 是否排除占位符
| Name | Type | Description |
|---|---|---|
excludeLiteral? |
boolean |
是否排除文本字符 |
excludePlaceholder? |
boolean |
是否排除占位符 |
pattern |
string |
掩码模式 |
placeholder? |
string |
掩码占位符 |
Ƭ MonthPickerOptions: Object
property startYear - 月份选择器的起始年份，默认值为十年前
property stopYear - 月份选择器的结束年份，默认值为当年
property height - 月份选择器DOM元素的高度，默认值为300
| Name | Type | Description |
|---|---|---|
height |
number |
月份选择器DOM元素的高度，默认值为300 |
startYear |
number |
月份选择器的起始年份，默认值为十年前 |
stopYear |
number |
月份选择器的结束年份，默认值为当年 |
Ƭ MultiColumnOptions: Object
property width - 用户可自定义多列下拉的宽度，默认值为800与自动计算的列宽最小值
property height - 用户可自定义多列下拉的高度，默认值为400与自动计算的行高最小值
property {string | Object[]} dataSource - 用户需指定绑定的数据源（必填），支持数组或返回数组的公式
property {GC.Data.ColumnBindingInfo[]} bindingInfos - 用户可自定义绑定的列信息
| Name | Type | Description |
|---|---|---|
bindingInfos? |
ColumnBindingInfo[] |
用户可自定义绑定的列信息 |
dataSource |
string | any[] |
用户需指定绑定的数据源（必填），支持数组或返回数组的公式 |
height? |
number |
用户可自定义多列下拉的高度，默认值为400与自动计算的行高最小值 |
width? |
number |
用户可自定义多列下拉的宽度，默认值为800与自动计算的列宽最小值 |
Ƭ NumberValidatorOptions: Object
property {"number"} type - 数据验证器类型
property comparisonOperator - 数据验证比较运算符
property {number | GC.Data.FormulaString} value1 - 数据验证器第一个值
property {number | GC.Data.FormulaString} value2 - 当验证比较运算符为"between"或"notBetween"时的第二个值（可选）
property isIntegerValue - 当验证器类型为"number"时是否为整数值
property ignoreBlank - 是否忽略空值
property inCellDropdown - 是否显示下拉按钮
property errorStyle - 数据验证错误样式
property errorTitle - 数据验证错误标题
property errorMessage - 数据验证错误消息
property showErrorMessage - 是否显示错误消息
property inputMessage - 数据验证输入提示消息
property inputTitle - 数据验证输入提示标题
property showInputMessage - 是否显示输入提示消息
property highlightStyle - 数据验证高亮样式
| Name | Type | Description |
|---|---|---|
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: Object
property type - 图案填充类型，支持"solid"(纯色)、"darkGray"(深灰)、"mediumGray"(中灰)、"lightGray"(浅灰)、"gray125"(12.5%灰)、"gray0625"(6.25%灰)、"darkHorizontal"(深水平条纹)、"darkVertical"(深垂直条纹)、"darkDown"(深向下斜线)、"darkUp"(深向上斜线)、"darkGrid"(深网格)、"darkTrellis"(深格线)、"lightHorizontal"(浅水平条纹)、"lightVertical"(浅垂直条纹)、"lightDown"(浅向下斜线)、"lightUp"(浅向上斜线)、"lightGrid"(浅网格)、"lightTrellis"(浅格线)
property patternColor - 图案填充颜色
property backgroundColor - 图案填充背景颜色（可选）
| Name | Type | Description |
|---|---|---|
backgroundColor? |
string |
图案填充背景颜色（可选） |
patternColor |
string |
图案填充颜色 |
type |
"solid" | "darkGray" | "mediumGray" | "lightGray" | "gray125" | "gray0625" | "darkHorizontal" | "darkVertical" | "darkDown" | "darkUp" | "darkGrid" | "darkTrellis" | "lightHorizontal" | "lightVertical" | "lightDown" | "lightUp" | "lightGrid" | "lightTrellis" |
图案填充类型 |
Ƭ RadioButtonCheckboxListOptions: Object
property type - 单元格类型，支持"radioButtonList"(单选按钮列表)、"checkboxList"(复选框列表)
property {GC.Data.ItemOptions[]} items - 选项列表，支持包含text和value的对象数组
property direction - 单选框/复选框排列方向，支持"horizontal"(水平)、"vertical"(垂直)
property maxColumnCount - 最大列数
property maxRowCount - 最大行数
property isFlowLayout - 是否为流式布局（自动适配）
property itemSpacing - 选项间距
property itemSpacing.horizontal - 水平间距
property itemSpacing.vertical - 垂直间距
property textAlign - 文本相对控件的对齐方式，支持"left"(左对齐)、"right"(右对齐)
property boxSize - 控件大小（像素）
| Name | Type | Description |
|---|---|---|
boxSize |
number |
控件大小（像素） |
direction |
"horizontal" | "vertical" |
排列方向 |
isFlowLayout |
boolean |
是否为流式布局（自动适配） |
itemSpacing |
{ horizontal: number ; vertical: number } |
选项间距 |
itemSpacing.horizontal |
number |
- |
itemSpacing.vertical |
number |
- |
items |
ItemOptions[] |
选项列表 |
maxColumnCount |
number |
最大列数 |
maxRowCount |
number |
最大行数 |
textAlign |
"left" | "right" |
文本对齐方式 |
type |
"radioButtonList" | "checkboxList" |
单元格类型 |
Ƭ RemoteChangeHandler: (data: Object | Object[], options: IRemoteFetchOption) => Promise<Object | Object[]>
▸ (data, options): Promise<Object | Object[]>
description 处理数据变更
| Name | Type | Description |
|---|---|---|
data |
Object | Object[] |
数据变更内容 |
options |
IRemoteFetchOption |
处理器选项（类似Fetch API的RequestInit） |
Promise<Object | Object[]>
处理器返回值
Ƭ RemoteReadHandler: (options: Object) => Promise<Object[]>
▸ (options): Promise<Object[]>
description 处理数据读取
| Name | Type | Description |
|---|---|---|
options |
Object |
处理器选项（类似Fetch API的RequestInit） |
Promise<Object[]>
处理器返回值
Ƭ ScaleValueType: "number" | "lowestValue" | "highestValue" | "percent" | "percentile" | "automin" | "formula" | "automax"
description 比例值类型
Ƭ SliderOptions: Object
property scaleVisible - 滑块 thumb 是否仅可在刻度上拖动（默认值：false）
property max - 滑块可滑动到的最大值（默认值：100）
property min - 滑块可滑动到的最小值（默认值：0）
property step - 滑块取值的粒度（必须大于0且能被(max - min)整除；当marks不为空时step可为空，默认值：1）
property tooltipVisible - 是否始终显示提示框（true则始终显示，否则即使拖动/悬停也不显示，默认值：false）
property width - 水平方向时滑块的宽度（默认值：350）
property height - 垂直方向时滑块的高度（默认值：350）
property direction - 滑块方向（支持"horizontal"(水平)、"vertical"(垂直)，默认值：horizontal）
property {number[]} marks - 滑块刻度标记
property formatString - 用于提示框或刻度的显示格式字符串
| Name | Type | Description |
|---|---|---|
direction |
"horizontal" | "vertical" |
滑块方向（支持"horizontal"(水平)、"vertical"(垂直)，默认值：horizontal） |
formatString |
string |
用于提示框或刻度的显示格式字符串 |
height |
number |
垂直方向时滑块的高度（默认值：350） |
marks |
number[] |
滑块刻度标记 |
max |
number |
滑块可滑动到的最大值（默认值：100） |
min |
number |
滑块可滑动到的最小值（默认值：0） |
scaleVisible |
boolean |
滑块 thumb 是否仅可在刻度上拖动（默认值：false） |
step |
number |
滑块取值的粒度（必须大于0且能被(max - min)整除；当marks不为空时step可为空，默认值：1） |
tooltipVisible |
boolean |
是否始终显示提示框（true则始终显示，否则即使拖动/悬停也不显示，默认值：false） |
width |
number |
水平方向时滑块的宽度（默认值：350） |
Ƭ SpecificTextComparisonOperator: "contains" | "doesNotContain" | "beginsWith" | "endsWith"
description 特定文本比较运算符
Ƭ SpecificTextRuleOptions: Object
property {"specificTextRule"} ruleType - 若使用特定文本规则，需指定此规则类型
property comparisonOperator - 特定文本比较运算符
property text - 特定文本
property style - 条件满足时应用于单元格的样式
property priority - 规则优先级
property stopIfTrue - 是否在应用此规则前先应用优先级较低的规则
| Name | Type | Description |
|---|---|---|
comparisonOperator |
SpecificTextComparisonOperator |
特定文本比较运算符 |
priority |
number |
规则优先级 |
ruleType |
"specificTextRule" |
若使用特定文本规则，需指定此规则类型 |
stopIfTrue |
boolean |
是否在应用此规则前先应用优先级较低的规则 |
style |
StyleOptions |
条件满足时应用于单元格的样式 |
text |
string |
特定文本 |
Ƭ StateRule: Object
property direction - 状态规则方向
property state - 状态
property [area] - 规则作用区域（可选）
description 状态规则
| Name | Type | Description |
|---|---|---|
area? |
ViewArea |
规则作用区域 |
direction |
StateRuleDirection |
状态规则方向 |
state |
RowColumnStates |
状态 |
Ƭ StyleOptions: Object
property {string | GC.Data.PatternFillOptions | GC.Data.GradientFillOptions | GC.Data.GradientPathFillOptions} backColor - 背景颜色字符串或图案填充选项、渐变填充选项、渐变路径填充选项
property foreColor - 前景色
property hAlign - 水平对齐方式，支持"left"(左)、"center"(居中)、"right"(右)、"general"(常规)
property vAlign - 垂直对齐方式，支持"top"(上)、"center"(居中)、"bottom"(下)
property font - 字体
property themeFont - 主题字体
property formatter - 格式化字符串
property borderLeft - 左边框
property borderTop - 上边框
property borderRight - 右边框
property borderBottom - 下边框
property diagonalDown - 从左上到右下的对角线边框
property diagonalUp - 从右上到左下的对角线边框
property locked - 单元格、行或列是否锁定
property textIndent - 文本缩进量
property wordWrap - 文本是否在单元格内换行
property shrinkToFit - 内容是否自动缩小以适应单元格
property backgroundImage - 要显示的背景图片
property {GC.Data.CheckboxOptions | GC.Data.ComboBoxOptions | GC.Data.HyperlinkOptions | GC.Data.FileUploadOptions | GC.Data.RadioButtonCheckboxListOptions} cellType - 单元格类型
property backgroundImageLayout - 背景图片布局方式，支持"stretch"(拉伸)、"center"(居中)、"zoom"(缩放)、"none"(无)
property tabStop - 用户是否可通过Tab键聚焦到该单元格
property textDecoration - 文本装饰样式
property imeMode - 输入法编辑器模式，支持"auto"(自动)、"active"(激活)、"inactive"(非激活)、"disabled"(禁用)
property name - 名称
property parentName - 父样式名称
property watermark - 水印内容
property cellPadding - 单元格内边距
property labelOptions - 单元格标签选项
property isVerticalText - 是否将单元格文本设置为垂直方向
property textOrientation - 单元格文本旋转角度
property showEllipsis - 文本超出边界时是否显示省略号
property {GC.Data.CellButtonOptions[]} cellButtons - 单元格按钮
property {GC.Data.DropDownOptions[]} dropDowns - 下拉选项
property decoration - 装饰样式
property mask - 掩码
| Name | Type | Description |
|---|---|---|
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 | FileUploadOptions | 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 |
掩码 |
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: Object
property {GC.Data.FormulaRule | GC.Data.StateRule} [rule] - 样式规则（公式规则或状态规则）
property [style] - 规则满足时应用的样式
description 样式规则
| Name | Type | Description |
|---|---|---|
rule? |
FormulaRule | StateRule |
公式规则或状态规则 |
style? |
StyleOptions |
规则满足时应用的样式 |
Ƭ StyleRules: Object
property name - 样式规则
description 样式规则集合
| Name | Type | Description |
|---|---|---|
name |
StyleRule |
样式规则 |
Ƭ TextDecoration: "underline" | "lineThrough" | "overline" | "doubleUnderline" | "none" | "lineThroughUnderline" | "lineThroughDoubleUnderline"
description 文本装饰类型
Ƭ TextLengthString: string
description 文本长度类型字符串，例如"10"
Ƭ TextLengthValidatorOptions: Object
property {"textLength"} type - 数据验证器类型
property comparisonOperator - 数据验证比较运算符
property {GC.Data.TextLengthString | GC.Data.FormulaString} value1 - 数据验证器第一个值
property {GC.Data.TextLengthString | GC.Data.FormulaString} value2 - 当验证比较运算符为"between"或"notBetween"时的第二个值（可选）
property ignoreBlank - 是否忽略空值
property inCellDropdown - 是否显示下拉按钮
property errorStyle - 数据验证错误样式
property errorTitle - 数据验证错误标题
property errorMessage - 数据验证错误消息
property showErrorMessage - 是否显示错误消息
property inputMessage - 数据验证输入提示消息
property inputTitle - 数据验证输入提示标题
property showInputMessage - 是否显示输入提示消息
property highlightStyle - 数据验证高亮样式
| Name | Type | Description |
|---|---|---|
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: Object
property {"threeScaleRule"} ruleType - 若使用三刻度规则，需指定此规则类型
property minType - 最小值刻度类型
property minValue - 最小值刻度值
property minColor - 最小值刻度颜色字符串
property midType - 中点刻度类型
property midValue - 中点刻度值
property midColor - 中点刻度颜色字符串
property maxType - 最大值刻度类型
property maxValue - 最大值刻度值
property maxColor - 最大值刻度颜色字符串
property priority - 规则优先级
property stopIfTrue - 是否在应用此规则前先应用优先级较低的规则
| Name | Type | Description |
|---|---|---|
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: Object
property max - 时间选择器可显示的最大值（需包含小时、分钟、秒属性）
property min - 时间选择器可显示的最小值（需包含小时、分钟、秒属性）
property step - 时间选择器取值的粒度
property formatString - 时间项的格式
property height - 时间选择器容器的高度
| Name | Type | Description |
|---|---|---|
formatString |
string |
时间项的格式 |
height |
number |
时间选择器容器的高度 |
max |
TimePickerValue |
时间选择器可显示的最大值（需包含小时、分钟、秒属性） |
min |
TimePickerValue |
时间选择器可显示的最小值（需包含小时、分钟、秒属性） |
step |
TimePickerValue |
时间选择器取值的粒度 |
Ƭ TimePickerValue: Object
property hour - 小时
property minute - 分钟
property second - 秒
| Name | Type | Description |
|---|---|---|
hour |
number |
小时 |
minute |
number |
分钟 |
second |
number |
秒 |
Ƭ TimeValidatorOptions: Object
property {"time"} type - 数据验证器类型
property comparisonOperator - 数据验证比较运算符
property {Date | GC.Data.FormulaString} value1 - 数据验证器第一个值
property {Date | GC.Data.FormulaString} value2 - 当验证比较运算符为"between"或"notBetween"时的第二个值（可选）
property ignoreBlank - 是否忽略空值
property inCellDropdown - 是否显示下拉按钮
property errorStyle - 数据验证错误样式
property errorTitle - 数据验证错误标题
property errorMessage - 数据验证错误消息
property showErrorMessage - 是否显示错误消息
property inputMessage - 数据验证输入提示消息
property inputTitle - 数据验证输入提示标题
property showInputMessage - 是否显示输入提示消息
property highlightStyle - 数据验证高亮样式
| Name | Type | Description |
|---|---|---|
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: Object
property {"top10Rule"} ruleType - 若使用前10条规则，需指定此规则类型
property type - 前10条类型（如最大、最小等）
property rank - 应用样式的前N或后N项数量
property style - 条件满足时应用于单元格的样式
property priority - 规则优先级
property stopIfTrue - 是否在应用此规则前先应用优先级较低的规则
| Name | Type | Description |
|---|---|---|
priority |
number |
规则优先级 |
rank |
number |
应用样式的前N或后N项数量 |
ruleType |
"top10Rule" |
若使用前10条规则，需指定此规则类型 |
stopIfTrue |
boolean |
是否在应用此规则前先应用优先级较低的规则 |
style |
StyleOptions |
条件满足时应用于单元格的样式 |
type |
Top10Type |
前10条类型 |
Ƭ Top10Type: "top" | "bottom"
description 前10条类型。
Ƭ TwoScaleRuleOptions: Object
property {"twoScaleRule"} ruleType - 若使用双刻度规则，需指定此规则类型
property minType - 最小值刻度类型
property minValue - 最小值刻度值
property minColor - 最小值刻度颜色字符串
property maxType - 最大值刻度类型
property maxValue - 最大值刻度值
property maxColor - 最大值刻度颜色字符串
property priority - 规则优先级
property stopIfTrue - 是否在应用此规则前先应用优先级较低的规则
| Name | Type | Description |
|---|---|---|
maxColor |
ColorString |
最大值刻度颜色字符串 |
maxType |
ScaleValueType |
最大值刻度类型 |
maxValue |
number |
最大值刻度值 |
minColor |
ColorString |
最小值刻度颜色字符串 |
minType |
ScaleValueType |
最小值刻度类型 |
minValue |
number |
最小值刻度值 |
priority |
number |
规则优先级 |
ruleType |
"twoScaleRule" |
若使用双刻度规则，需指定此规则类型 |
stopIfTrue |
boolean |
是否在应用此规则前先应用优先级较低的规则 |
Ƭ UniqueRuleOptions: Object
property {"uniqueRule"} ruleType - 若使用唯一值规则，需指定此规则类型
property style - 条件满足时应用于单元格的样式
property priority - 规则优先级
property stopIfTrue - 是否在应用此规则前先应用优先级较低的规则
| Name | Type | Description |
|---|---|---|
priority |
number |
规则优先级 |
ruleType |
"uniqueRule" |
若使用唯一值规则，需指定此规则类型 |
stopIfTrue |
boolean |
是否在应用此规则前先应用优先级较低的规则 |
style |
StyleOptions |
条件满足时应用于单元格的样式 |
Ƭ ViewOptions: Object
property [defaultColumnWidth] - 默认列宽（可选）
property [styleRules] - 样式规则集合（可选）
property [showCrossValueHeader] - 是否显示交叉值标题（可选）
property [cross] - 定义交叉列选项（可选）
description 视图配置选项
| Name | Type | Description |
|---|---|---|
cross? |
ICrossViewOptions |
定义交叉列选项 |
defaultColumnWidth? |
number |
默认列宽 |
showCrossValueHeader? |
boolean |
是否显示交叉值标题 |
styleRules? |
StyleRules |
样式规则集合 |
Ƭ WorkFlowItem: Object
property value - 项目值
property {number[]|string[]} transitions - 项目过渡值数组
| Name | Type | Description |
|---|---|---|
transitions |
number[] | string[] |
项目过渡值数组 |
value |
string |
项目值 |
Ƭ WorkFlowOptions: Object
property {GC.Data.WorkFlowItem[]} items - 工作流项目数组
| Name | Type | Description |
|---|---|---|
items |
WorkFlowItem[] |
工作流项目数组 |
