Interface: IDataProvider

Sheets.DataRange.IDataProvider

Table of contents

Properties

• host

Methods

• fromJSON
• getSpans
• getStyle
• getValue
• onClear
• onColumnChange
• onContextMenu
• onCopy
• onDestroy
• onDoubleClick
• onKeyDown
• onKeyUp
• onMouseDown
• onMouseMove
• onMouseUp
• onMouseWheel
• onRowChange
• setValue
• toJSON
• undo

Properties

host

• host: DataRange

数据提供者宿主

Methods

fromJSON

▸ Optional fromJSON(options): void

实现此钩子以处理反序列化。

Parameters

Name	Type
options	Object
options.typeName	string

Returns

void

---

getSpans

▸ Optional getSpans(row, col, rowCount, colCount): Range[]

实现此钩子以为数据范围单元格提供跨度。row、col、rowCount和colCount参数基于数据范围轴。

Parameters

Name	Type
row	number
col	number
rowCount	number
colCount	number

Returns

Range[]

---

getStyle

▸ Optional getStyle(row, col): Style

实现此钩子以为数据范围单元格提供样式。row和col参数基于数据范围轴。它应该返回GC.Spread.Sheets.Style类型的样式，否则表示无法从数据提供者获取样式，将继续从工作表模型获取样式。

Parameters

Name	Type
row	number
col	number

Returns

Style

---

getValue

▸ Optional getValue(row, col): unknown

实现此钩子以为数据范围单元格提供值。row和col参数基于数据范围轴。如果返回undefined，表示无法从数据提供者获取值，将继续从工作表模型获取值。

Parameters

Name	Type
row	number
col	number

Returns

unknown

---

onClear

▸ Optional onClear(row, col, rowCount, colCount, changes): boolean

实现此钩子以处理清除内容操作。返回true表示阻止工作表的清除操作。返回false表示阻止清除数据范围内容。默认为false。

Parameters

Name	Type
row	number
col	number
rowCount	number
colCount	number
changes	any[]

Returns

boolean

---

onColumnChange

▸ Optional onColumnChange(col, colCount, changeType, changes): void

实现此钩子以接收更改的列信息。col和colCount参数基于数据范围轴。如果需要撤销/重做，请将更改发布到changes参数中。

Parameters

Name	Type
col	number
colCount	number
changeType	"delete" | "add"
changes	any[]

Returns

void

---

onContextMenu

▸ Optional onContextMenu(row, col, e): boolean

实现此钩子以处理鼠标右键菜单操作。row和col参数基于数据范围轴。返回true表示阻止后续工作表操作。默认为false。

Parameters

Name	Type
row	number
col	number
e	MouseEvent

Returns

boolean

---

onCopy

▸ Optional onCopy(name): boolean | { dataProvider: IDataProvider ; name: string }

实现此钩子以处理复制操作。输入参数name是复制的数据范围名称，需要返回一个不同的新数据范围name和数据提供者实例。返回true表示阻止工作表的复制操作。返回false表示阻止复制数据范围。默认为false。

Parameters

Name	Type
name	string

Returns

boolean | { dataProvider: IDataProvider ; name: string }

---

onDestroy

▸ Optional onDestroy(): void

实现此钩子以处理销毁操作。

Returns

void

---

onDoubleClick

▸ Optional onDoubleClick(row, col, e): boolean

实现此钩子以处理鼠标双击操作。row和col参数基于数据范围轴。返回true表示阻止后续工作表操作。默认为false。

Parameters

Name	Type
row	number
col	number
e	MouseEvent

Returns

boolean

---

onKeyDown

▸ Optional onKeyDown(row, col, e): boolean

实现此钩子以处理按键按下操作。row和col参数基于数据范围轴。返回true表示阻止后续工作表操作。默认为false。

Parameters

Name	Type
row	number
col	number
e	KeyboardEvent

Returns

boolean

---

onKeyUp

▸ Optional onKeyUp(row, col, e): boolean

实现此钩子以处理按键释放操作。row和col参数基于数据范围轴。返回true表示阻止后续工作表操作。默认为false。

Parameters

Name	Type
row	number
col	number
e	KeyboardEvent

Returns

boolean

---

onMouseDown

▸ Optional onMouseDown(row, col, e): boolean

实现此钩子以处理鼠标按下操作。row和col参数基于数据范围轴。返回true表示阻止后续工作表操作。默认为false。

Parameters

Name	Type
row	number
col	number
e	MouseEvent

Returns

boolean

---

onMouseMove

▸ Optional onMouseMove(row, col, e): boolean

实现此钩子以处理鼠标移动操作。row和col参数基于数据范围轴。返回true表示阻止后续工作表操作。默认为false。

Parameters

Name	Type
row	number
col	number
e	MouseEvent

Returns

boolean

---

onMouseUp

▸ Optional onMouseUp(row, col, e): boolean

实现此钩子以处理鼠标释放操作。row和col参数基于数据范围轴。返回true表示阻止后续工作表操作。默认为false。

Parameters

Name	Type
row	number
col	number
e	MouseEvent

Returns

boolean

---

onMouseWheel

▸ Optional onMouseWheel(deltaX, deltaY, e): boolean

实现此钩子以处理鼠标滚轮操作。返回true表示阻止后续工作表操作。默认为false。

Parameters

Name	Type
deltaX	number
deltaY	number
e	MouseEvent

Returns

boolean

---

onRowChange

▸ Optional onRowChange(row, rowCount, changeType, changes): void

实现此钩子以接收更改的行信息。row和rowCount参数基于数据范围轴。如果需要撤销/重做，请将更改发布到changes参数中。

Parameters

Name	Type
row	number
rowCount	number
changeType	"delete" | "add"
changes	any[]

Returns

void

---

setValue

▸ Optional setValue(row, col, value, changes): boolean

实现此钩子以接收来自数据范围的更改值。row和col参数基于数据范围轴。如果需要撤销/重做，请将更改发布到changes参数中。如果返回true，表示成功将值设置到数据提供者，将阻止将值设置到工作表模型。

Parameters

Name	Type
row	number
col	number
value	unknown
changes	any[]

Returns

boolean

---

toJSON

▸ Optional toJSON(): Object

实现此钩子以处理序列化。

Returns

Object

Name	Type
typeName	string

---

undo

▸ Optional undo(change): void

实现此钩子以处理撤销操作。输入参数change是用户在相应钩子中创建的。

Parameters

Name	Type
change	any

Returns

void