类: DataObject

Sheets.CellTypes.DataObject

继承关系

• Text

  ↳ DataObject

Table of contents

构造方法

• constructor

属性

• typeName

方法

• activateEditor
• createEditorElement
• deactivateEditor
• focus
• format
• fromJSON
• getAutoFitHeight
• getAutoFitWidth
• getEditorValue
• getHitInfo
• isEditingValueChanged
• isImeAware
• isReservedKey
• paint
• paintContent
• parse
• processKeyDown
• processKeyUp
• processMouseDown
• processMouseEnter
• processMouseLeave
• processMouseMove
• processMouseUp
• selectAll
• setEditorValue
• toJSON
• updateEditor
• updateEditorContainer
• updateImeMode

构造方法

constructor

• new DataObject()

Represents a data object cell type.

代码示例

//set a DataObject celltype which uses WEBSERVICE function to provide data
sheet.setFormula(1, 1, '=FILTERJSON(WEBSERVICE("https://demodata.mescius.io/northwind/api/v1/Products/1"))');
var cellType1 = new GC.Spread.Sheets.CellTypes.DataObject('=@.productName & " " & @.unitPrice');
sheet.setCellType(1, 1, cellType1);

Overrides

Text.constructor

属性

typeName

• typeName: string

支持序列化的类型名称字符串

继承自

Text.typeName

方法

activateEditor

▸ activateEditor(editorContext, cellStyle, cellRect, context?): void

激活编辑器，包括为编辑器设置属性或属性以及为编辑器绑定事件

参数

属性名	类型	说明
editorContext	HTMLElement	由createEditorElement方法创建的DOM元素
cellStyle	Style	单元格的实际样式
cellRect	Rect	单元格的布局信息
context?	any	与单元格类型关联的上下文

返回值

void

继承自

Text.activateEditor

---

createEditorElement

▸ createEditorElement(context?): HTMLElement

创建一个DOM元素，然后返回

参数

属性名	类型	说明
context?	any	与单元格类型关联的上下文

返回值

HTMLElement

创建一个DOM元素，然后返回

继承自

Text.createEditorElement

---

deactivateEditor

▸ deactivateEditor(editorContext, context?): void

停用编辑器，例如解除绑定编辑器事件

参数

属性名	类型	说明
editorContext	HTMLElement	由createEditorElement方法创建的DOM元素
context?	any	与单元格类型关联的上下文

返回值

void

继承自

Text.deactivateEditor

---

focus

▸ focus(editorContext, context?): void

关注编辑器DOM元素

参数

属性名	类型	说明
editorContext	HTMLElement	由createEditorElement方法创建的DOM元素
context?	any	与单元格类型关联的上下文

返回值

void

继承自

Text.focus

---

format

▸ format(value, format, formattedData?, context?): string

将具有指定格式的值格式化为字符串

参数

属性名	类型	说明
value	any	要格式化的对象值
format	string | GeneralFormatter	格式化
formattedData?	FormattedData	格式化的数据
context?	any	与单元格类型关联的上下文

返回值

string

返回格式化的字符串

继承自

Text.format

---

fromJSON

▸ fromJSON(settings): void

从指定的JSON字符串加载对象状态

参数

属性名	类型	说明
settings	any	反序列化的单元格类型数据

返回值

void

继承自

Text.fromJSON

---

getAutoFitHeight

▸ getAutoFitHeight(value, text, cellStyle, zoomFactor, context?): number

获取单元格的高度，该高度可用于处理该行的自适应

参数

属性名	类型	说明
value	any	单元格的值
text	string	单元格的文本
cellStyle	Style	单元格的实际值
zoomFactor	number	当前表单的缩放系数
context?	any	与单元格类型关联的上下文

返回值

number

返回单元格的高度，该高度可用于处理行的自适应

继承自

Text.getAutoFitHeight

---

getAutoFitWidth

▸ getAutoFitWidth(value, text, cellStyle, zoomFactor, context?): number

获取可用于处理列的自适应的单元格宽度

参数

属性名	类型	说明
value	any	单元格的值
text	string	单元格的文本
cellStyle	Style	单元格的实际值
zoomFactor	number	当前表单的缩放系数
context?	any	与单元格类型关联的上下文

返回值

number

返回单元格的高度，该高度可用于处理列的自适应

继承自

Text.getAutoFitWidth

---

getEditorValue

▸ getEditorValue(editorContext, context?): any

获取编辑器的值

参数

属性名	类型	说明
editorContext	HTMLElement	由createEditorElement方法创建的DOM元素
context?	any	与单元格类型关联的上下文

返回值

any

返回编辑器的值

继承自

Text.getEditorValue

---

getHitInfo

▸ getHitInfo(x, y, cellStyle, cellRect, context?): IHitTestCellTypeHitInfo

获取单元格类型的匹配信息

参数

属性名	类型	说明
x	number	指针相对于画布的当前位置的 x 坐标
y	number	指针相对于画布的当前位置的 y 坐标
cellStyle	Style	当前单元格的实际样式
cellRect	Rect	当前单元格的布局信息
context?	any	与单元格类型关联的上下文

返回值

IHitTestCellTypeHitInfo

返回包含 x , y , row , col , cellRect 的对象 ,以及 sheetArea 参数，以及一个表示 isReservedLocation 的值 如果命中测试位于单元格类型需要处理的特殊区域中，则 isReservedLocation 为true 否则为false

继承自

Text.getHitInfo

---

isEditingValueChanged

▸ isEditingValueChanged(oldValue, newValue, context?): boolean

编辑值是否已更改

参数

属性名	类型	说明
oldValue	any	旧的编辑值
newValue	any	新的编辑值
context?	any	与单元格类型关联的上下文

返回值

boolean

如果oldValue等于newValue,为true;否则为false

继承自

Text.isEditingValueChanged

---

isImeAware

▸ isImeAware(context?): boolean

此单元格类型是否存在IME

参数

属性名	类型	说明
context?	any	与单元格类型关联的上下文

返回值

boolean

如果单元格类型存在IME,为true;否则为false

继承自

Text.isImeAware

---

isReservedKey

▸ isReservedKey(e, context?): boolean

单元格类型是否处理键盘事件本身

参数

属性名	类型	说明
e	KeyboardEvent	键盘事件
context?	any	与单元格类型关联的上下文

返回值

boolean

如果单元格类型处理键盘事件本身，则返回true;否则，返回false 否则为false

继承自

Text.isReservedKey

---

paint

▸ paint(ctx, value, x, y, w, h, style, context?): void

在画布上绘制一个单元格

参数

属性名	类型	说明
ctx	CanvasRenderingContext2D	画布的二维上下文
value	any	单元格的值
x	number	x 相对于画布的坐标
y	number	相对于画布的 y 坐标
w	number	单元格的宽度
h	number	单元格的高度
style	Style	单元格的实际样式
context?	any	与单元格类型关联的上下文

返回值

void

继承自

Text.paint

---

paintContent

▸ paintContent(ctx, value, x, y, w, h, style, context?): void

在画布上绘制单元格内容区域

参数

属性名	类型	说明
ctx	CanvasRenderingContext2D	画布的二维上下文
value	any	单元格的值
x	number	x 相对于画布的坐标
y	number	相对于画布的 y 坐标
w	number	单元格内容区域的宽度
h	number	单元格内容区域的高度
style	Style	单元格的实际样式
context?	any	与单元格类型关联的上下文

返回值

void

继承自

Text.paintContent

---

parse

▸ parse(text, formatStr, context?): any

将具有指定格式字符串的文本解析为对象

参数

属性名	类型	说明
text	string	解析文本字符串
formatStr	string	解析格式字符串
context?	any	与单元格类型关联的上下文

返回值

any

解析对象

继承自

Text.parse

---

processKeyDown

▸ processKeyDown(event, context?): boolean

在显示模式下处理按键

参数

属性名	类型	说明
event	KeyboardEvent	键盘事件
context?	any	与单元格类型关联的上下文

返回值

boolean

如果过程成功，则返回true;否则为false

继承自

Text.processKeyDown

---

processKeyUp

▸ processKeyUp(event, context?): boolean

在显示模式下处理按键

参数

属性名	类型	说明
event	KeyboardEvent	键盘事件
context?	any	与单元格类型关联的上下文

返回值

boolean

如果过程成功，则返回true;否则为false

继承自

Text.processKeyUp

---

processMouseDown

▸ processMouseDown(hitInfo): boolean

在显示模式下向下处理鼠标

参数

属性名	类型	说明
hitInfo	IHitTestCellTypeHitInfo	getHitInfo方法返回的命中测试信息

返回值

boolean

如果过程成功，则返回true;否则为false

继承自

Text.processMouseDown

---

processMouseEnter

▸ processMouseEnter(hitInfo): boolean

在显示模式下处理鼠标的输入

参数

属性名	类型	说明
hitInfo	IHitTestCellTypeHitInfo	getHitInfo方法返回的命中测试信息

返回值

boolean

如果过程成功，则返回true;否则为false

继承自

Text.processMouseEnter

---

processMouseLeave

▸ processMouseLeave(hitInfo): boolean

在显示模式下处理鼠标离开

参数

属性名	类型	说明
hitInfo	IHitTestCellTypeHitInfo	getHitInfo方法返回的命中测试信息

返回值

boolean

如果过程成功，则返回true;否则为false

继承自

Text.processMouseLeave

---

processMouseMove

▸ processMouseMove(hitInfo): boolean

在显示模式下处理鼠标移动

参数

属性名	类型	说明
hitInfo	IHitTestCellTypeHitInfo	getHitInfo方法返回的命中测试信息

返回值

boolean

如果过程成功，则返回true;否则为false

继承自

Text.processMouseMove

---

processMouseUp

▸ processMouseUp(hitInfo): boolean

在显示模式下处理鼠标抬起

参数

属性名	类型	说明
hitInfo	IHitTestCellTypeHitInfo	getHitInfo方法返回的命中测试信息

返回值

boolean

如果过程成功，则返回true;否则为false

继承自

Text.processMouseUp

---

selectAll

▸ selectAll(editorContext, context?): void

选择编辑器DOM元素中的所有文本

参数

属性名	类型	说明
editorContext	HTMLElement	由createEditorElement方法创建的DOM元素
context?	any	与单元格类型关联的上下文

返回值

void

继承自

Text.selectAll

---

setEditorValue

▸ setEditorValue(editorContext, value, context?): void

设置编辑器的值

参数

属性名	类型	说明
editorContext	HTMLElement	由createEditorElement方法创建的DOM元素
value	any	从活动单元格返回的值
context?	any	与单元格类型关联的上下文

返回值

void

继承自

Text.setEditorValue

---

toJSON

▸ toJSON(): any

将对象状态保存为JSON字符串

返回值

any

单元格类型数据

继承自

Text.toJSON

---

updateEditor

▸ updateEditor(editorContext, cellStyle, cellRect, context?): Rect

更新编辑器的大小

参数

属性名	类型	说明
editorContext	HTMLElement	由createEditorElement方法创建的DOM元素
cellStyle	Style	单元格的实际样式
cellRect	Rect	单元格的布局信息
context?	any	与单元格类型关联的上下文

返回值

Rect

返回单元格包装器元素的新大小，它应包含两个属性"width"和 "height"

继承自

Text.updateEditor

---

updateEditorContainer

▸ updateEditorContainer(editorContext, editorBounds, cellStyle): void

更新单元格wrapper元素的大小

参数

属性名	类型	说明
editorContext	HTMLElement	由createEditorElement方法创建的DOM元素
editorBounds	Rect	单元格wrapper元素的新大小
cellStyle	Style	单元格的实际样式

返回值

void

继承自

Text.updateEditorContainer

---

updateImeMode

▸ updateImeMode(editorContext, imeMode, context?): void

更新编辑器的ime模式

参数

属性名	类型	说明
editorContext	HTMLElement	由createEditorElement方法创建的DOM元素
imeMode	ImeMode	单元格实际样式中的ime模式
context?	any	与单元格类型关联的上下文

返回值

void

继承自

Text.updateImeMode