跳到主要内容

单元格操作

设置单元格值​

设置值​

要通过 API 为单元格设置值，请使用 setValue() 方法。向该方法传入以下参数：

  • cells - (string) 单元格或单元格区域的 id
  • value - (string/number/array) 要为单元格设置的值
// setting value for one cell
spreadsheet.setValue("A1",5);
// setting the same value for a range of cells
spreadsheet.setValue("A1:D1",5);
// setting the same value for different cells
spreadsheet.setValue("B6,A1:D1",5);
// setting values from an array for cells in a range alternately
spreadsheet.setValue("A1:D1",[1,2,3]);
备注

请注意，该方法为指定的单元格设置相同（重复）的值。如果要向电子表格单元格中添加不同的值，请使用 parse() 方法。

获取值​

您也可以通过将所需单元格或单元格区域的 id 传入 getValue() 方法来返回单元格中的值。

该方法以字符串、数字或数组的形式返回值：

// returning the value of one cell
var cellValue = spreadsheet.getValue("A2"); // "Ecuador"

// returning the values of the range of cells
var rangeValues = spreadsheet.getValue("A1:A3"); // -> ["Country","Ecuador","Belarus"]

// returning the values of different cells
var values = spreadsheet.getValue("A1,B1,C1:C3");
//-> ["Country", "Product", "Price", 6.68, 3.75]

验证单元格​

从 v4.3 开始，您可以通过添加下拉选项列表对单元格应用数据验证。为此，请使用 setValidation() 方法：

spreadsheet.setValidation("B10:B15", ["Apple", "Mango", "Avocado"]);

下拉列表限制了用户的选择范围。当用户在单元格中输入意外值时，将显示 无效值 消息。

信息

setValidation() 方法也可以从指定单元格中移除验证。查看详情。

要在单元格中插入超链接，请使用 insertLink() 方法。该方法还可以添加与超链接一起显示的文本：

// insert a link in "A2" cell
spreadsheet.insertLink("A2", {
    text:"DHX Spreadsheet", href: "https://dhtmlx.com/docs/products/dhtmlxSpreadsheet/"
});

如果需要从单元格中删除链接，只需向该方法传入单元格 ID：

// remove a link from "A2" cell
spreadsheet.insertLink("A2");

设置单元格样式​

设置样式​

您可以使用 setStyle() 方法为单元格或单元格区域应用样式。该方法接受两个参数：

  • cells - (string) 单元格或单元格区域的 id
  • styles - (object/array) 要应用于单元格的样式
// setting style for one cell
spreadsheet.setStyle("A1", {background: "red"});
// setting the same style for a range of cells
spreadsheet.setStyle("A1:D1", {color: "blue"});
// setting the same style for different cells
spreadsheet.setStyle("B6,A1:D1", {color: "blue"});
// setting styles from an array for cells in a range alternately
spreadsheet.setStyle("A1:D1", [{color: "blue"}, {color: "red"}]);
备注

该方法为指定的单元格设置相同的样式。如果要对电子表格单元格应用不同的样式，请使用 parse() 方法。

获取样式​

要获取应用于单元格的样式，请使用 getStyle() 方法。向其传入单元格或单元格区域的 id：

// getting style of one cell
var style = spreadsheet.getStyle("A1"); 
// -> {background: "#8DE9E1", color: "#03A9F4"}
 
// getting styles of a range of cells
var rangeStyles = spreadsheet.getStyle("A1:D1"); // -> see details
 
// getting styles of different cells
var values = spreadsheet.getStyle("A1,B1,C1:C3");

对于多个单元格，该方法返回一个包含各单元格样式的对象数组：

[
    {background: "red", border: "solid 1px yellow", color: "blue"},
    {background: "red", border: "solid 1px yellow", color: "blue"},
    {background: "#C8FAF6", border: "solid 1px yellow", color: "#81C784"},
    {background: "#9575CD", border: "solid 1px yellow", color: "#079D8F"}
]

编辑单元格​

启用单元格编辑器​

您可以通过调用 startEdit() 方法在单元格中添加输入框：

spreadsheet.startEdit();

该方法可接受两个可选参数：

  • cell - (string) 可选，单元格的 id
  • value - (string) 可选，单元格值

如果未传入单元格 id，输入框将添加到当前选中的单元格。

禁用单元格编辑器​

要完成单元格编辑，请使用 endEdit() 方法，该方法将关闭编辑器并保存输入的值。

spreadsheet.endEdit();

锁定单元格​

锁定单元格​

您可以通过程序锁定一个或多个单元格，使其对用户只读。为此请使用 lock() 方法。该方法以单元格 id 或单元格区域作为参数。

// locks a cell
spreadsheet.lock("A1");

// locks a range of cells
spreadsheet.lock("A1:C1");

// locks specified cells
spreadsheet.lock("A1,B5,B7,D4:D6");

相关示例：Spreadsheet. 锁定单元格

解锁单元格​

要解锁已锁定的单元格，请使用 unlock() 方法。将单元格 id 或包含锁定单元格的区域作为参数传入：

// unlocks a cell
spreadsheet.unlock("A1");
 
// unlocks a range of cells
spreadsheet.unlock("A1:C1");
 
// unlocks specified cells
spreadsheet.unlock("A1,B5,B7,D4:D6");

检查单元格是否已锁定​

要检查一个或多个单元格是否已锁定，请使用 isLocked() 方法，并将单元格 id 或单元格区域传入：

// checks whether a cell is locked
var cellLocked = spreadsheet.isLocked("A1"); 

// checks whether several cells are locked
var rangeLocked = spreadsheet.isLocked("A1:C1");

// checks whether scattered cells are locked
var cellsLocked = spreadsheet.isLocked("A1,B5,B7,D4:D6");

该方法根据单元格的状态返回 true 或 false。如果同时检查多个单元格，只要其中至少有一个锁定单元格，方法即返回 true。

合并单元格​

合并单元格​

您可以通过将要合并的单元格区域传入 mergeCells() 方法来将两个或多个单元格合并为一个：

//merge cells A6, A7, and A8
spreadsheet.mergeCells("A6:A8");

//merge cells B2, C2, and D2
spreadsheet.mergeCells("B2:D2");

拆分单元格​

您也可以使用 mergeCells() 方法拆分已合并的单元格。除单元格区域外，还需传入 true 作为第二个参数以取消合并指定单元格：

//unmerge cells B2, C2, and D2
spreadsheet.mergeCells("B2:D2", true);

选择单元格​

选中单元格​

Spreadsheet 支持通过 Selection 对象的 API 设置单元格选中状态。

您可以通过将单元格 id 传入 setSelectedCell() 方法来选中单元格：

// selecting a cell
spreadsheet.selection.setSelectedCell("B5");
// selecting a range of cells
spreadsheet.selection.setSelectedCell("B1:B5");
// selecting scattered cells
spreadsheet.selection.setSelectedCell("B7,B3,D4,D6,E4:E8");

也可以通过 getSelectedCell() 方法获取选中单元格的 id：

const selected = spreadsheet.selection.getSelectedCell(); // -> "B7,B3,D4,D6,E4:E8"

取消选中单元格​

要从单元格中移除选中状态，请将单元格 id 传入 removeSelectedCell() 方法：

// sets selection
spreadsheet.selection.setSelectedCell("B7,B3,D4,D6,E4:E8");
// removes selection
spreadsheet.selection.removeSelectedCell("B7,D4,E5:E7");

const selected = spreadsheet.selection.getSelectedCell();
console.log(selected); // -> "B3,D6,E4,E8"

相关示例：Spreadsheet. 移除选中状态

在单元格上设置焦点​

Selection 对象支持在电子表格单元格上设置焦点，以及获取已聚焦单元格的 id。为此请使用对应的方法：

// pass the id of the cell to set focus on
spreadsheet.selection.setFocusedCell("D4");
// getting the focused cell 
var focused = spreadsheet.selection.getFocusedCell(); // -> "D4"
Need more help?Contact Support