简体中文

DataProxy

电子表格操作的核心数据管理类。通过 useSheetStore 访问。

访问方式

import { useSheetStore } from '@tego/sheet';

const { getActiveSheet } = useSheetStore();
const dataProxy = getActiveSheet();

单元格操作

`getCell(ri, ci)`

通过行列索引获取单元格数据。

const cell = dataProxy.getCell(0, 0);
// { text: 'Hello', style: 0, merge: [1, 1] }

`getCellTextOrDefault(ri, ci)`

获取单元格文本或默认值。

const text = dataProxy.getCellTextOrDefault(0, 0);

`getCellStyle(ri, ci)`

获取单元格样式。

const style = dataProxy.getCellStyle(0, 0);

`getCellStyleOrDefault(ri, ci)`

获取单元格样式或默认样式。

const style = dataProxy.getCellStyleOrDefault(0, 0);

`setCellText(ri, ci, text, state)`

设置单元格文本。

ri: 行索引
ci: 列索引
text: 文本内容
state: 'input' 或 'finished'

dataProxy.setCellText(0, 0, 'Hello', 'finished');

`getSelectedCell()`

获取当前选中的单元格。

const cell = dataProxy.getSelectedCell();

`getSelectedCellStyle()`

获取选中单元格的样式。

const style = dataProxy.getSelectedCellStyle();

`setSelectedCellAttr(property, value)`

设置选中单元格的属性。

dataProxy.setSelectedCellAttr('bold', true);
dataProxy.setSelectedCellAttr('bgcolor', '#ffff00');

`setSelectedCellText(text, state)`

设置选中单元格的文本。

dataProxy.setSelectedCellText('Hello', 'finished');

选区操作

`calSelectedRangeByStart(ri, ci)`

通过起始位置计算选区范围。

dataProxy.calSelectedRangeByStart(0, 0);

`calSelectedRangeByEnd(ri, ci)`

通过结束位置计算选区范围。

dataProxy.calSelectedRangeByEnd(5, 5);

`isSignleSelected()`

检查是否只选中了单个单元格。

const isSingle = dataProxy.isSignleSelected();

`getSelectedRect()`

获取选中的矩形区域。

const rect = dataProxy.getSelectedRect();

`xyInSelectedRect(x, y)`

检查坐标是否在选中区域内。

const isInside = dataProxy.xyInSelectedRect(100, 200);

`getCellRectByXY(x, y)`

通过坐标获取单元格矩形。

const rect = dataProxy.getCellRectByXY(100, 200);

剪贴板

`copy()`

复制选中单元格。

dataProxy.copy();

`copyToSystemClipboard()`

复制到系统剪贴板。

dataProxy.copyToSystemClipboard();

`cut()`

剪切选中单元格。

dataProxy.cut();

`paste(what, error)`

从剪贴板粘贴。

what: 'all'、'text' 或 'format'
error: 错误回调函数

dataProxy.paste('all', (msg) => console.error(msg));

`pasteFromText(txt)`

粘贴文本。

dataProxy.pasteFromText('Hello\tWorld');

`clearClipboard()`

清除剪贴板。

dataProxy.clearClipboard();

`getClipboardRect()`

获取剪贴板选区矩形。

const rect = dataProxy.getClipboardRect();

合并单元格

`merge()`

合并选中单元格。

dataProxy.merge();

`unmerge()`

取消合并选中单元格。

dataProxy.unmerge();

`canUnmerge()`

检查是否可以取消合并。

const canUnmerge = dataProxy.canUnmerge();

历史记录

`undo()`

撤销上一次操作。

dataProxy.undo();

`redo()`

重做上一次撤销的操作。

dataProxy.redo();

`canUndo()`

检查是否可以撤销。

const canUndo = dataProxy.canUndo();

`canRedo()`

检查是否可以重做。

const canRedo = dataProxy.canRedo();

行列操作

`setRowHeight(ri, height)`

设置行高。

dataProxy.setRowHeight(0, 50);

`setColWidth(ci, width)`

设置列宽。

dataProxy.setColWidth(0, 150);

`insert(type, n)`

插入行或列。

type: 'row' 或 'column'
n: 插入数量

dataProxy.insert('row', 1);
dataProxy.insert('column', 2);

`delete(type)`

删除选中的行或列。

dataProxy.delete('row');
dataProxy.delete('column');

`hideRowsOrCols()`

隐藏选中的行或列。

dataProxy.hideRowsOrCols();

`unhideRowsOrCols(type, index)`

取消隐藏行或列。

dataProxy.unhideRowsOrCols('row', 5);

冻结窗格

`setFreeze(ri, ci)`

设置冻结窗格。

dataProxy.setFreeze(1, 1); // 冻结第一行和第一列

`freezeIsActive()`

检查冻结是否激活。

const isActive = dataProxy.freezeIsActive();

`freezeTotalWidth()`

获取冻结区域宽度。

const width = dataProxy.freezeTotalWidth();

`freezeTotalHeight()`

获取冻结区域高度。

const height = dataProxy.freezeTotalHeight();

筛选

`autofilter()`

切换自动筛选。

dataProxy.autofilter();

`canAutofilter()`

检查是否可以应用自动筛选。

const can = dataProxy.canAutofilter();

`setAutoFilter(ci, order, operator, value)`

设置自动筛选选项。

dataProxy.setAutoFilter(0, 'asc', 'eq', 'value');

`resetAutoFilter()`

重置自动筛选。

dataProxy.resetAutoFilter();

数据验证

`addValidation(mode, ref, validator)`

添加验证规则。

dataProxy.addValidation('stop', 'A1:B10', validator);

`removeValidation()`

从选中范围移除验证。

dataProxy.removeValidation();

`getSelectedValidator()`

获取选中范围的验证器。

const validator = dataProxy.getSelectedValidator();

`getSelectedValidation()`

获取选中范围的验证信息。

const validation = dataProxy.getSelectedValidation();

视图

`viewWidth()`

获取视图宽度。

const width = dataProxy.viewWidth();

`viewHeight()`

获取视图高度。

const height = dataProxy.viewHeight();

`viewRange()`

获取可见范围。

const range = dataProxy.viewRange();

`freezeViewRange()`

获取冻结视图范围。

const range = dataProxy.freezeViewRange();

`contentRange()`

获取内容范围。

const range = dataProxy.contentRange();

滚动

`scrollx(x, cb)`

水平滚动。

dataProxy.scrollx(100, () => console.log('已滚动'));

`scrolly(y, cb)`

垂直滚动。

dataProxy.scrolly(100, () => console.log('已滚动'));

数据

`setData(d)`

设置表格数据。

dataProxy.setData({
  name: 'Sheet1',
  rows: { /* ... */ },
});

`getData()`

获取表格数据。

const data = dataProxy.getData();

`changeData(cb)`

设置变更回调。

dataProxy.changeData((data) => {
  console.log('数据变化:', data);
});

样式

`defaultStyle()`

获取默认样式。

const style = dataProxy.defaultStyle();

`addStyle(nstyle)`

添加样式到样式数组。

const styleIndex = dataProxy.addStyle({
  bold: true,
  bgcolor: '#ffff00',
});

工具方法

`cellRect(ri, ci)`

获取单元格矩形信息。

const rect = dataProxy.cellRect(0, 0);
// { left, top, width, height }

`getRect(cellRange)`

获取单元格范围的矩形。

const rect = dataProxy.getRect(cellRange);

`rowEach(min, max, cb)`

遍历行。

dataProxy.rowEach(0, 10, (ri, row) => {
  console.log(ri, row);
});

`colEach(min, max, cb)`

遍历列。

dataProxy.colEach(0, 10, (ci, col) => {
  console.log(ci, col);
});

`eachMergesInView(viewRange, cb)`

遍历视图中的合并单元格。

dataProxy.eachMergesInView(viewRange, (merge) => {
  console.log(merge);
});

大纲

DataProxy#

访问方式#

单元格操作#

getCell(ri, ci)#

getCellTextOrDefault(ri, ci)#

getCellStyle(ri, ci)#

getCellStyleOrDefault(ri, ci)#

setCellText(ri, ci, text, state)#

getSelectedCell()#

getSelectedCellStyle()#

setSelectedCellAttr(property, value)#

setSelectedCellText(text, state)#

选区操作#

calSelectedRangeByStart(ri, ci)#

calSelectedRangeByEnd(ri, ci)#

isSignleSelected()#

getSelectedRect()#

xyInSelectedRect(x, y)#

getCellRectByXY(x, y)#

剪贴板#

copy()#

copyToSystemClipboard()#

cut()#

paste(what, error)#

pasteFromText(txt)#

clearClipboard()#

getClipboardRect()#

合并单元格#

merge()#

unmerge()#

canUnmerge()#

历史记录#

undo()#

redo()#

canUndo()#

canRedo()#

行列操作#

setRowHeight(ri, height)#

setColWidth(ci, width)#

insert(type, n)#

delete(type)#

hideRowsOrCols()#

unhideRowsOrCols(type, index)#

冻结窗格#

setFreeze(ri, ci)#

freezeIsActive()#

freezeTotalWidth()#

freezeTotalHeight()#

筛选#

autofilter()#

canAutofilter()#

setAutoFilter(ci, order, operator, value)#

resetAutoFilter()#

数据验证#

addValidation(mode, ref, validator)#

removeValidation()#

getSelectedValidator()#

getSelectedValidation()#

视图#

viewWidth()#

viewHeight()#

viewRange()#

freezeViewRange()#

contentRange()#

滚动#

scrollx(x, cb)#

scrolly(y, cb)#

数据#

setData(d)#

getData()#

changeData(cb)#

样式#

defaultStyle()#

addStyle(nstyle)#

工具方法#

cellRect(ri, ci)#

getRect(cellRange)#

rowEach(min, max, cb)#

colEach(min, max, cb)#

eachMergesInView(viewRange, cb)#