[]
产品首页 在线 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 - 要使用单元格值条件格式的类型

属性 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 列的可见性

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 - 数据条规则的规则类型

属性 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 - 要使用数据发生规则的规则类型

属性 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 - 数据验证类型

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

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

property {Date | GC.Data.FormulaString} value2 - The data validator second value if validator comparison operator is "between" or "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 The data validator second value if validator comparison operator is "between" or "notBetween".

Decoration

Ƭ Decoration: Object

property {GC.Data.Icon[]} icons - The icons of the decoration in the style.

Type declaration

属性名 类型 说明
icons? Icon[] The icons of the decoration in the style.

Ƭ 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 - The option of drop down.

属性 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 - 如果要使用重复规则,请选择规则类型

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

属性 priority - 规则的优先级

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

Type declaration

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

ErrorStyle

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

description 验证错误样式

FormulaListValidatorOptions

Ƭ FormulaListValidatorOptions: Object

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

属性 formula - The data validator formula if the validator type if "formula" or "formulaList".

属性 ignoreBlank - 是否忽略空值

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

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

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

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

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

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

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

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

属性 highlightStyle - 高亮错误样式

Type declaration

属性名 类型 说明
errorMessage string 数据验证器错误消息
errorStyle ErrorStyle 数据验证器错误样式
errorTitle string 数据验证器错误标题
formula FormulaString The data validator formula if the validator type if "formula" or "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 the formula string

FormulaRuleOptions

Ƭ FormulaRuleOptions: Object

property {"formulaRule"} ruleType - 要使用公式规则的规则类型

属性 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 - The data validator formula if the validator type if "formula" or "formulaList".

属性 ignoreBlank - 是否忽略空值

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

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

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

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

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

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

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

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

属性 highlightStyle - 高亮错误样式

Type declaration

属性名 类型 说明
errorMessage string 数据验证器错误消息
errorStyle ErrorStyle 数据验证器错误样式
errorTitle string 数据验证器错误标题
formula FormulaString The data validator formula if the validator type if "formula" or "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 - The background color string or pattern fill options, gradient fill options, gradient path fill options.

属性 foreColor - The foreground color.

属性 hAlign - The horizontal alignment, which supports "left", "center", "right", "general".

属性 vAlign - The vertical alignment, which supports "top", "center", "bottom".

属性 font - 字体

属性 themeFont - The theme font.

属性 formatter - The formatter string.

属性 borderLeft - The 左边框

属性 borderTop - The 上边框

属性 borderRight - The 右边框

属性 borderBottom - The 下边框

属性 diagonalDown - The diagonal with LeftTop to bottomRight.

属性 diagonalUp - The diagonal with topRight to bottomLeft.

属性 locked - Whether the cell, row, or column is locked.

属性 textIndent - The text indent amount.

属性 wordWrap - Whether words wrap within the cell or cells.

属性 shrinkToFit - Whether content shrinks to fit the cell or cells.

属性 backgroundImage - The background image to display.

属性 backgroundImageLayout - The layout for the background image, which supports "stretch", "center", "zoom", "none".

属性 textDecoration - The decoration added to text.

属性 name - 名称

属性 parentName - The name of the parent style.

属性 watermark - The watermark content.

属性 cellPadding - 单元格填充

属性 labelOptions - 单元格标签选项

属性 isVerticalText - Whether to set the cell's text vertical.

属性 showEllipsis - Whether the text out of bounds shows ellipsis.

Type declaration

属性名 类型 说明
backColor? string | PatternFillOptions | GradientFillOptions | GradientPathFillOptions The background color string or pattern fill options, gradient fill options, gradient path fill options.
backgroundImage? string The background image to display.
backgroundImageLayout? "stretch" | "center" | "zoom" | "none" The layout for the background image, which supports "stretch", "center", "zoom", "none".
borderBottom? LineBorder The 下边框
borderLeft? LineBorder The 左边框
borderRight? LineBorder The 右边框
borderTop? LineBorder The 上边框
cellPadding? string 单元格填充
diagonalDown? LineBorder The diagonal with LeftTop to bottomRight.
diagonalUp? LineBorder The diagonal with topRight to bottomLeft.
font? string 字体
foreColor? string The foreground color.
formatter? string The formatter string.
hAlign? "left" | "center" | "right" | "general" The horizontal alignment, which supports "left", "center", "right", "general".
isVerticalText? boolean Whether to set the cell's text vertical.
labelOptions? LabelOptions 单元格标签选项
locked? boolean Whether the cell, row, or column is locked.
name? string 名称
parentName? string The name of the parent style.
showEllipsis? boolean Whether the text out of bounds shows ellipsis.
shrinkToFit? boolean Whether content shrinks to fit the cell or cells.
textDecoration? TextDecoration The decoration added to text.
textIndent? number The text indent amount.
themeFont? string The theme font.
vAlign? "top" | "center" | "bottom" The vertical alignment, which supports "top", "center", "bottom".
watermark? string The watermark content.
wordWrap? boolean Whether words wrap within the cell or cells.

HierarchyCustomParseHandler

Ƭ HierarchyCustomParseHandler: (options: IHierarchyCustomParseOptions) => any

Type declaration

▸ (options): any

description Get the parentId of the current record.

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

any

Returns of the parentId of the current record.

HierarchyCustomUnparseHandler

Ƭ HierarchyCustomUnparseHandler: (options: IHierarchyCustomUnparseOptions) => any

Type declaration

▸ (options): any

description Get the id of the current record.

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

any

Returns of the id of the current record.

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 - The unique name of the column.

属性 value - The value of the column, could be a field name of table from database, or formula which uses the fields names.

property {string | string[]} caption - The caption of the column.

property {number | string} width - The width of the column, support number in pixel, or star size.

属性 style - The style of the column.

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 - The conditional formats array of the column.

property {GC.Data.NumberValidatorOptions | GC.Data.DateValidatorOptions | GC.Data.TimeValidatorOptions | GC.Data.TextLengthValidatorOptions | GC.Data.FormulaValidatorOptions | GC.Data.FormulaListValidatorOptions | GC.Data.ListValidatorOptions} validator - The data validator of the column.

属性 isPrimaryKey - Mark the column as primary key column.

属性 readonly - Mark the column is readonly.

属性 required - Mark the column is required when insert a new row.

属性 defaultValue - Provide the default value when insert a new row, could be a const or a formula.

属性 headerStyle - The header style of the column.

属性 visible - Mark the column is visible.

属性 headerFit - The header fit mode, any of the "normal", "vertical" or "stack". The default value is "normal".

属性 dataType - The actual data type of original value, any of "string", "number", "boolean", "object", "array", "date" or "rowOrder". It is useful for a Date because a Date is a string in JSON data and need be converted.

属性 dataPattern - The data pattern for parsing string to value, such as formatter "dd/MM/yyyy" for a date string, truthy and falsy value pairs "Yes|No" for a boolean string, decimal separator "," for a numeric string.

属性 dataMap - A simple map to display the original value more meaningful, its key could be a number or string, and its value could be a number, string or Date.

属性 spread - Whether to spread a column when its value is an object.

属性 dataName - The original name of the table field, using this property to map the original name to the specified name.

属性 indexed - Weather need to create the filter cache while creating the table.

属性 allowSort - Whether show sort after opening filer dialog.

属性 allowFilterByValue - Whether show filter by value after opening filer dialog.

属性 allowFilterByList - Whether show filter by list after opening filer dialog. If allowSort, allowFilterByValue and allowFilterByList are all false, not show the filter button in this column.

property {string | GC.Data.ICrossOptions} cross - The cross options of the column.

property {string | (string | number | boolean | Date)[] | GC.Data.ILookupOptions} lookup - Define the lookup for the column, only be used in the columns of the schema of the data source.

property {boolean | GC.Data.IOutlineColumnOptions} outlineColumn - Define the outline column only when the data be the hierarchy data.

Type declaration

属性名 类型 说明
allowFilterByList? boolean Whether show filter by list after opening filer dialog. If allowSort, allowFilterByValue and allowFilterByList are all false, not show the filter button in this column.
allowFilterByValue? boolean Whether show filter by value after opening filer dialog.
allowSort? boolean Whether show sort after opening filer dialog.
caption? string | string[] The caption of the column.
conditionalFormats? (CellValueRuleOptions | SpecificTextRuleOptions | FormulaRuleOptions | DateOccurringRuleOptions | Top10RuleOptions | UniqueRuleOptions | DuplicateRuleOptions | AverageRuleOptions | TwoScaleRuleOptions | ThreeScaleRuleOptions | DataBarRuleOptions | IconSetRuleOptions)[] The conditional formats array of the column.
cross? string | ICrossOptions The cross options of the column.
dataMap? any A simple map to display the original value more meaningful, its key could be a number or string, and its value could be a number, string or Date.
dataName? string The original name of the table field, using this property to map the original name to the specified name.
dataPattern? string The data pattern for parsing string to value, such as formatter "dd/MM/yyyy" for a date string, truthy and falsy value pairs "Yes|No" for a boolean string, decimal separator "," for a numeric string.
dataType? "string" | "number" | "boolean" | "object" | "array" | "date" | "rowOrder" The actual data type of original value, any of "string", "number", "boolean", "object", "array", "date" or "rowOrder". It is useful for a Date because a Date is a string in JSON data and need be converted.
defaultValue? any Provide the default value when insert a new row, could be a const or a formula.
headerFit? "normal" | "vertical" | "stack" The header fit mode, any of the "normal", "vertical" or "stack". The default value is "normal".
headerStyle? HeaderStyleOptions The header style of the column.
indexed? boolean Weather need to create the filter cache while creating the table.
isPrimaryKey? boolean Mark the column as primary key column.
lookup? string | (string | number | boolean | Date)[] | ILookupOptions Define the lookup for the column, only be used in the columns of the schema of the data source.
name? string The unique name of the column.
outlineColumn? boolean | IOutlineColumnOptions Define the outline column only when the data be the hierarchy data.
readonly? boolean Mark the column is readonly.
required? boolean Mark the column is required when insert a new row.
spread? boolean Whether to spread a column when its value is an object.
style? StyleOptions The style of the column.
validator? NumberValidatorOptions | DateValidatorOptions | TimeValidatorOptions | TextLengthValidatorOptions | FormulaValidatorOptions | FormulaListValidatorOptions | ListValidatorOptions The data validator of the column.
value? string The value of the column, could be a field name of table from database, or formula which uses the fields names.
visible? boolean Mark the column is visible.
width? number | string The width of the column, support number in pixel, or star size.

IColumnCollection

Ƭ IColumnCollection: Object

属性 key - A key-value collection, which key is a string, and value is a GC.Data.IColumn object.

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 - A key-value collection, which key is a string, and value is a GC.Data.ICrossOptions object.

Index signature

▪ [key: string]: ICrossOptions

IDataSourceOption

Ƭ IDataSourceOption: Object

property {Array | string} data - Local data source, which could be an object array for JSON, a string for CSV or XML.

属性 remote - Remote data source, which supports REST API, OData, GraphQL.

属性 autoSync - In auto sync mode, data changes will be synced to server immediately.

属性 batch - In batch mode, data changes will be held in data source, user need invoke submitChanges method to sync server.

属性 schema - The data source schema options.

Type declaration

属性名 类型 说明
autoSync? boolean In auto sync mode, data changes will be synced to server immediately.
batch? boolean In batch mode, data changes will be held in data source, user need invoke submitChanges method to sync server.
data? any Local data source, which could be an object array for JSON, a string for CSV or XML.
remote? IRemoteTransportOption Remote data source, which supports REST API, OData, GraphQL.
schema? ISchemaOption The data source schema options.

IHierarchyCustomParseOptions

Ƭ IHierarchyCustomParseOptions: Object

属性 data - The data of the current record.

属性 index - The record index.

Type declaration

属性名 类型 说明
data any The data of the current record.
index number The record index.

IHierarchyCustomUnparseOptions

Ƭ IHierarchyCustomUnparseOptions: Object

属性 data - The data of the current record.

属性 index - The record index.

属性 parentData - The data of the parent record.

Type declaration

属性名 类型 说明
data any The data of the current record.
index number The record index.
parentData any The data of the parent record.

IHierarchyOption

Ƭ IHierarchyOption: Object

属性 type - Supports 'Parent', 'ChildrenPath', 'Level', 'Custom'.

属性 column - The column that has the data to build hierarchy.

property {string | GC.Data.IHierarchyOutlineColumnOptions} outlineColumn - The definitions of the outline column of the column that show as hierarchy.

属性 summaryFields - The definitions of the collections of hierarchy summary fields.

属性 parse - The options to parse the parentId for the custom hierarchy type.

属性 unparse - The options to unparse the record to the id for the custom hierarchy type.

Type declaration

属性名 类型 说明
column string The column that has the data to build hierarchy.
outlineColumn? string | IHierarchyOutlineColumnOptions The definitions of the outline column of the column that show as hierarchy.
parse? HierarchyCustomParseHandler The options to parse the parentId for the custom hierarchy type.
summaryFields? IHierarchySummaryFieldCollection The definitions of the collections of hierarchy summary fields.
type "Parent" | "ChildrenPath" | "Level" | "Custom" Supports 'Parent', 'ChildrenPath', 'Level', 'Custom'.
unparse? HierarchyCustomUnparseHandler The options to unparse the record to the id for the custom hierarchy type.

IHierarchyOutlineColumnOptions

Ƭ IHierarchyOutlineColumnOptions: Object

属性 value - Specified the column that show as hierarchy.

属性 showCheckBox - Whether to display the check box.

属性 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 Whether to display the check box.
showImage? boolean 是否显示图像
showIndicator? boolean 是否显示指标
value string Specified the column that show as hierarchy.

IHierarchySummaryFieldCollection

Ƭ IHierarchySummaryFieldCollection: Object

属性 key - A key-value collection, which key is a field string, and value is a formula string.

Index signature

▪ [key: string]: string

ILookupOptions

Ƭ ILookupOptions: Object

属性 name - The relation ship name.

property {string[] | GC.Data.IColumn[]} columns - The columns definitions of the related table, used for multi-column drop down.

Type declaration

属性名 类型 说明
columns string[] | IColumn[] The columns definitions of the related table, used for multi-column drop down.
name string The relation ship name.

IOutlineColumnOptions

Ƭ IOutlineColumnOptions: Object

属性 showCheckBox - Whether to display the check box.

属性 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 Whether to display the check box.
showImage? boolean 是否显示图像
showIndicator? boolean 是否显示指标

IRemoteReadRequestOption

Ƭ IRemoteReadRequestOption: Object

属性 url - Request url.

属性 method - Request method, such as 'GET', 'POST', 'PUT', 'DELETE', default value is 'GET'.

属性 adapter - Adapt different data protocol, supports "rest", "odata", "odata4", "graphql".

属性 body - Request body.

Type declaration

属性名 类型 说明
adapter? string Adapt different data protocol, supports "rest", "odata", "odata4", "graphql".
body? Object Request body.
method? "GET" | "POST" | "PUT" | "DELETE" Request method, such as 'GET', 'POST', 'PUT', 'DELETE', default value is 'GET'.
url string Request url.

IRemoteRequestOption

Ƭ IRemoteRequestOption: Object

属性 url - Request url.

属性 method - Request method, such as 'GET', 'POST', 'PUT', 'DELETE', default value is 'GET'.

Type declaration

属性名 类型 说明
method? "GET" | "POST" | "PUT" | "DELETE" Request method, such as 'GET', 'POST', 'PUT', 'DELETE', default value is 'GET'.
url string Request url.

IRemoteTransportOption

Ƭ IRemoteTransportOption: Object

property {GC.Data.IRemoteReadRequestOption | GC.Data.RemoteReadHandler} read - The options for read operation.

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} create - The options for create operation.

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} update - The options for update operation.

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} delete - The options for delete operation.

property {GC.Data.IRemoteRequestOption | GC.Data.RemoteChangeHandler} batch - The options for batch operation.

Type declaration

属性名 类型 说明
batch? IRemoteRequestOption | RemoteChangeHandler The options for batch operation.
create? IRemoteRequestOption | RemoteChangeHandler The options for create operation.
delete? IRemoteRequestOption | RemoteChangeHandler The options for delete operation.
read IRemoteReadRequestOption | RemoteReadHandler The options for read operation.
update? IRemoteRequestOption | RemoteChangeHandler The options for update operation.

ISchemaOption

Ƭ ISchemaOption: Object

属性 type - Supports 'json', 'csv', 'xml', 'columnJson'.

属性 countPath - Data reader use this to get data source collection length, return the current data source collection length if this is not specified.

属性 dataPath - Data reader use this to get data source collection after parse, return entire parsed object if this is not specified.

属性 columns - The definitions of all columns of current table.

属性 hierarchy - The definitions of hierarchy options.

Type declaration

属性名 类型 说明
columns? IColumnCollection The definitions of all columns of current table.
countPath? string Data reader use this to get data source collection length, return the current data source collection length if this is not specified.
dataPath? string Data reader use this to get data source collection after parse, return entire parsed object if this is not specified.
hierarchy? IHierarchyOption The definitions of hierarchy options.
type? string Supports 'json', 'csv', 'xml', 'columnJson'.

Icon

Ƭ Icon: Object

属性 position - The icon's position, which supports "left", "right", "leftOfText", "rightOfText", "outsideLeft", "outsideRight".

属性 width - The painted width.

属性 height - The painted height.

属性 src - The icon path.

Type declaration

属性名 类型 说明
height? number The painted height.
position? "left" | "right" | "leftOfText" | "rightOfText" | "outsideLeft" | "outsideRight" The icon's position, which supports "left", "right", "leftOfText", "rightOfText", "outsideLeft", "outsideRight".
src? string The icon path.
width? number The painted width.

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

property {"iconSetRule"} 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 a function returns a DOM element
layout? ListLayout 布局
multiSelect? boolean 是否将列表设置为"多选"
text? string 文本
valueType? "string" | "array" 下拉列表结果的单元格值类型,支持 "string", "array"
onItemSelected? (e: MouseEvent) => string used when items or sub-items is (() => HTMLElement)

ListString

Ƭ ListString: string

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

ListValidatorOptions

Ƭ ListValidatorOptions: Object

property {"list"} 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" 数据验证类型

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 - The data validator second value if validator comparison operator is "between" or "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 The data validator second value if validator comparison operator is "between" or "notBetween".

PatternFillOptions

Ƭ PatternFillOptions: Object

属性 type - The pattern fill type, which supports "solid", "darkGray", "mediumGray", "lightGray", "gray125", "gray0625", "darkHorizontal", "darkVertical", "darkDown", "darkUp", "darkGrid", "darkTrellis", "lightHorizontal", "lightVertical", "lightDown", "lightUp", "lightGrid" and "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" The pattern fill type, which supports "solid", "darkGray", "mediumGray", "lightGray", "gray125", "gray0625", "darkHorizontal", "darkVertical", "darkDown", "darkUp", "darkGrid", "darkTrellis", "lightHorizontal", "lightVertical", "lightDown", "lightUp", "lightGrid" and "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 - The granularity that the slider can step through values. Must greater than 0, and be divided by (max - min). When marks no null, step can be null, default value is 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 The granularity that the slider can step through values. Must greater than 0, and be divided by (max - min). When marks no null, step can be null, default value is 1.
tooltipVisible boolean 如果为true,则工具提示将始终显示,或者无论如何也不会显示,即使拖动或悬停,默认值为false
width number 滑块的宽度当方向为水平时,默认值为350

SpecificTextComparisonOperator

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

description 文本比较运算符

SpecificTextRuleOptions

Ƭ SpecificTextRuleOptions: Object

property {"specificTextRule"} 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] - The rule area.

description 状态规则

Type declaration

属性名 类型 说明
area? ViewArea the position where the rule takes an effect
direction StateRuleDirection the state rule direction
state RowColumnStates the formula string

StyleOptions

Ƭ StyleOptions: Object

property {string | GC.Data.PatternFillOptions | GC.Data.GradientFillOptions | GC.Data.GradientPathFillOptions} backColor - The background color string or pattern fill options, gradient fill options, gradient path fill options.

属性 foreColor - The foreground color.

属性 hAlign - The horizontal alignment, which supports "left", "center", "right", "general".

属性 vAlign - The vertical alignment, which supports "top", "center", "bottom".

属性 font - 字体

属性 themeFont - The theme font.

属性 formatter - The formatter string.

属性 borderLeft - The 左边框

属性 borderTop - The 上边框

属性 borderRight - The 右边框

属性 borderBottom - The 下边框

属性 diagonalDown - The diagonal with LeftTop to bottomRight.

属性 diagonalUp - The diagonal with topRight to bottomLeft.

属性 locked - Whether the cell, row, or column is locked.

属性 textIndent - The text indent amount.

属性 wordWrap - Whether words wrap within the cell or cells.

属性 shrinkToFit - Whether content shrinks to fit the cell or cells.

属性 backgroundImage - The background image to display.

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

属性 backgroundImageLayout - The layout for the background image, which supports "stretch", "center", "zoom", "none".

属性 tabStop - Whether the user can set focus to the cell using the Tab key.

属性 textDecoration - The decoration added to text.

属性 imeMode - The input method editor mode, which supports "auto", "active", "inactive", "disabled".

属性 name - 名称

属性 parentName - The name of the parent style.

属性 watermark - The watermark content.

属性 cellPadding - 单元格填充

属性 labelOptions - 单元格标签选项

属性 isVerticalText - Whether to set the cell's text vertical.

属性 textOrientation - The cell text rotation angle.

属性 showEllipsis - Whether the text out of bounds shows ellipsis.

property {GC.Data.CellButtonOptions[]} cellButtons - The cell buttons.

property {GC.Data.DropDownOptions[]} dropDowns - The drop downs.

属性 decoration - The decoration.

Type declaration

属性名 类型 说明
backColor? string | PatternFillOptions | GradientFillOptions | GradientPathFillOptions The background color string or pattern fill options, gradient fill options, gradient path fill options.
backgroundImage? string The background image to display.
backgroundImageLayout? "stretch" | "center" | "zoom" | "none" The layout for the background image, which supports "stretch", "center", "zoom", "none".
borderBottom? LineBorder The 下边框
borderLeft? LineBorder The 左边框
borderRight? LineBorder The 右边框
borderTop? LineBorder The 上边框
cellButtons? CellButtonOptions[] The cell buttons.
cellPadding? string 单元格填充
cellType? CheckboxOptions | ComboBoxOptions | HyperlinkOptions | RadioButtonCheckboxListOptions 单元格类型
decoration? Decoration The decoration.
diagonalDown? LineBorder The diagonal with LeftTop to bottomRight.
diagonalUp? LineBorder The diagonal with topRight to bottomLeft.
dropDowns? DropDownOptions[] The drop downs.
font? string 字体
foreColor? string The foreground color.
formatter? string The formatter string.
hAlign? "left" | "center" | "right" | "general" The horizontal alignment, which supports "left", "center", "right", "general".
imeMode? "auto" | "active" | "inactive" | "disabled" The input method editor mode, which supports "auto", "active", "inactive", "disabled".
isVerticalText? boolean Whether to set the cell's text vertical.
labelOptions? LabelOptions 单元格标签选项
locked? boolean Whether the cell, row, or column is locked.
name? string 名称
parentName? string The name of the parent style.
showEllipsis? boolean Whether the text out of bounds shows ellipsis.
shrinkToFit? boolean Whether content shrinks to fit the cell or cells.
tabStop? boolean Whether the user can set focus to the cell using the Tab key.
textDecoration? TextDecoration The decoration added to text.
textIndent? number The text indent amount.
textOrientation? number The cell text rotation angle.
themeFont? string The theme font.
vAlign? "top" | "center" | "bottom" The vertical alignment, which supports "top", "center", "bottom".
watermark? string The watermark content.
wordWrap? boolean Whether words wrap within the cell or cells.

StyleRule

Ƭ StyleRule: Object

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

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

description 样式规则

Type declaration

属性名 类型 说明
rule? FormulaRule | StateRule the formula rule or the state rule
style? StyleOptions the style if the rule is satisfied

StyleRules

Ƭ StyleRules: Object

属性 name - 样式规则

description 样式规则

Type declaration

属性名 类型 说明
name StyleRule the style rule

TextDecoration

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

description 文本修饰

TextLengthString

Ƭ TextLengthString: string

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

TextLengthValidatorOptions

Ƭ TextLengthValidatorOptions: Object

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

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

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

property {GC.Data.TextLengthString | GC.Data.FormulaString} value2 - The data validator second value if validator comparison operator is "between" or "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 The data validator second value if validator comparison operator is "between" or "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 - The data validator second value if validator comparison operator is "between" or "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 The data validator second value if validator comparison operator is "between" or "notBetween".

Top10RuleOptions

Ƭ Top10RuleOptions: Object

property {"top10Rule"} ruleType - 如果要使用前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 - 如果要使用双刻度规则,请选择规则类型

属性 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

property {"uniqueRule"} 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 the default column width
showCrossValueHeader? boolean 堆叠列头值是否可见
styleRules? StyleRules the style rules

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[] 项