Строки и столбцы
Facade API
Полные определения типов Facade API доступны в справочнике Facade API.
Строки
Вставка строки после заданной позиции
insertRowAfter(afterPosition): вставляет строку после заданной позиции строки.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts a row after the first row positionsheet.insertRowAfter(0)Вставка строки перед заданной позицией
insertRowBefore(beforePosition): вставляет строку перед заданной позицией строки.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts a row before the first row positionsheet.insertRowBefore(0)Вставка нескольких строк в заданной позиции
insertRows(rowIndex, numRows): вставляет на листе одну или несколько последовательных пустых строк, начиная с заданной позиции.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Shifts all rows down by threesheet.insertRows(0, 3)Вставка нескольких строк после заданной позиции
insertRowsAfter(afterPosition, howMany): вставляет указанное количество строк после заданной позиции строки.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts five rows after the first rowsheet.insertRowsAfter(0, 5)Вставка нескольких строк перед заданной позицией
insertRowsBefore(beforePosition, howMany): вставляет указанное количество строк перед заданной позицией строки.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts five rows before the first rowsheet.insertRowsBefore(0, 5)Удаление строки в заданной позиции
deleteRow(rowPosition): удаляет строку в заданной позиции.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Rows start at "0" - this deletes the first rowsheet.deleteRow(0)Удаление нескольких строк, начиная с заданной позиции
deleteRows(rowPosition, howMany): удаляет указанное количество строк, начиная с заданной позиции.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Rows start at "0" - this deletes the first two rowssheet.deleteRows(0, 2)Удаление нескольких строк в заданных позициях
deleteRowsByPoints(rowPoints): удаляет несколько строк, не обязательно последовательных, заданных массивом позиций.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Rows start at "0" - this deletes the 3rd row and rows 5 to 7fWorksheet.deleteRowsByPoints([2, [4, 6]])Перемещение строк в новую позицию
moveRows(rowSpec, destinationIndex): перемещает строки, выбранные заданным диапазоном, в позицию с индексом destinationIndex. Диапазон rowSpec не обязан в точности представлять целую строку или группу строк: метод выбирает все строки, которые охватывает диапазон.
// The code below moves rows 1-2 to destination index 5// This results in those rows becoming rows 3-4const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Selects row 1 and row 2 to be movedconst rowSpec = sheet.getRange('1:2')sheet.moveRows(rowSpec, 5)Скрытие строк в заданном диапазоне
hideRow(row): скрывает строки в заданном диапазоне.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This hides the first rowconst range = sheet.getRange('1:1')sheet.hideRow(range)Скрытие нескольких последовательных строк
hideRows(rowIndex, numRows): скрывает одну или несколько последовательных строк, начиная с заданного индекса. В этом методе используется индексация с нуля.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Hides the first three rowssheet.hideRows(0, 3)Отображение строки в заданном диапазоне
unhideRow(row): отображает скрытую строку в заданном диапазоне.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This unhides the first row if it was previously hiddenconst range = sheet.getRange('1:1')sheet.unhideRow(range)Отображение нескольких последовательных строк
showRows(rowIndex, numRows): отображает одну или несколько последовательных скрытых строк, начиная с заданного индекса. В этом методе используется индексация с нуля.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Unhides the first three rowssheet.showRows(0, 3)Установка высоты строки
setRowHeight(rowPosition, height): задаёт высоту строки в пикселях. По умолчанию высота строк увеличивается под содержимое ячеек. Чтобы принудительно задать определённую высоту, используйте setRowHeightsForced(startRow, numRows, height).
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first row to a height of 200 pixelssheet.setRowHeight(0, 200)Установка высоты нескольких строк
setRowHeights(startRow, numRows, height): задаёт высоту указанных строк в пикселях. По умолчанию высота строк увеличивается под содержимое ячеек. Чтобы принудительно задать определённую высоту, используйте setRowHeightsForced(startRow, numRows, height).
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first three rows to a height of 200 pixelssheet.setRowHeights(0, 3, 200)Принудительная установка высоты нескольких строк
setRowHeightsForced(startRow, numRows, height): задаёт высоту указанных строк в пикселях. При использовании setRowHeightsForced заданная высота применяется принудительно, даже если содержимое ячейки выше строки.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first three rows to a height of 5 pixelssheet.setRowHeightsForced(0, 3, 5)Автоматическая настройка высоты строк
autoResizeRows(startRow, numRows): автоматически подбирает высоту указанных строк под их текстовое содержимое.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Set the first 3 rows to a height that fits their text.sheet.autoResizeRows(0, 3)Установка пользовательских свойств строк
setRowCustom(custom): задаёт пользовательские свойства строк. В строке сохраняется объект custom, в который можно поместить любые данные в формате JSON для хранения дополнительной информации.
При обновлении данных custom исходные данные custom перезаписываются. Если при обновлении необходимо сохранить исходные данные custom, заранее получите данные custom, объедините их с новыми, а затем выполните обновление.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Set custom properties for the first and third rowssheet.setRowCustom({ 0: { color: 'red' }, 2: { size: 16 },})Столбцы
Вставка столбца после заданной позиции
insertColumnAfter(afterPosition): вставляет столбец после заданной позиции столбца.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts a column after the first column positionsheet.insertColumnAfter(0)Вставка столбца перед заданной позицией
insertColumnBefore(beforePosition): вставляет столбец перед заданной позицией столбца.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts a column in the first column positionsheet.insertColumnBefore(0)Вставка нескольких столбцов в заданной позиции
insertColumns(columnIndex, numColumns): вставляет на листе один или несколько последовательных пустых столбцов, начиная с заданной позиции.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Shifts all columns by threesheet.insertColumns(0, 3)Вставка нескольких столбцов после заданной позиции
insertColumnsAfter(afterPosition, howMany): вставляет указанное количество столбцов после заданной позиции столбца.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Inserts two columns after the first columnsheet.insertColumnsAfter(0, 2)Вставка нескольких столбцов перед заданной позицией
insertColumnsBefore(beforePosition, howMany): вставляет указанное количество столбцов перед заданной позицией столбца.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This inserts five columns before the first columnsheet.insertColumnsBefore(0, 5)Удаление столбца в заданной позиции
deleteColumn(columnPosition): удаляет столбец в заданной позиции.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Columns start at "0" - this deletes the first columnsheet.deleteColumn(0)Удаление нескольких столбцов, начиная с заданной позиции
deleteColumns(columnPosition, howMany): удаляет указанное количество столбцов, начиная с заданной позиции.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Columns start at "0" - this deletes the first two columnssheet.deleteColumns(0, 2)Удаление нескольких столбцов в заданных позициях
deleteColumnsByPoints(columnPoints): удаляет несколько столбцов, не обязательно последовательных, заданных массивом позиций.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Columns start at "0" - this deletes the Column C and Columns E-GfWorksheet.deleteColumnsByPoints([2, [4, 6]])Перемещение столбцов в новую позицию
moveColumns(columnSpec, destinationIndex): перемещает столбцы, выбранные заданным диапазоном, в позицию с индексом destinationIndex. Диапазон columnSpec не обязан в точности представлять целый столбец или группу столбцов: метод выбирает все столбцы, которые охватывает диапазон.
// The code below moves rows A-B to destination index 5.// This results in those columns becoming columns C-D.const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Selects column A and column B to be moved.const columnSpec = sheet.getRange('A:B')sheet.moveColumns(columnSpec, 5)Скрытие столбцов в заданном диапазоне
hideColumn(column): скрывает столбец или столбцы в заданном диапазоне.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This hides the first columnconst range = sheet.getRange('A:A')sheet.hideColumn(range)Скрытие нескольких последовательных столбцов
hideColumns(columnIndex, numColumns): скрывает один или несколько последовательных столбцов, начиная с заданного индекса. В этом методе используется индексация с нуля.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Hides the first three columnssheet.hideColumns(0, 3)Отображение столбца в заданном диапазоне
unhideColumn(column): отображает скрытый столбец в заданном диапазоне.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// This unhides the first column if it was previously hiddenconst range = sheet.getRange('A:A')sheet.unhideColumn(range)Отображение нескольких последовательных столбцов
showColumns(columnIndex, numColumns): отображает один или несколько последовательных скрытых столбцов, начиная с заданного индекса. В этом методе используется индексация с нуля.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Unhides the first three columnssheet.showColumns(0, 3)Установка ширины столбца
setColumnWidth(columnPosition, width): задаёт ширину столбца в пикселях.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first column to a width of 200 pixelssheet.setColumnWidth(0, 200)Установка ширины нескольких столбцов
setColumnWidths(startColumn, numColumns, width): задаёт ширину указанных столбцов в пикселях.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Sets the first three columns to a width of 200 pixelssheet.setColumnWidths(0, 3, 200)Автоматическая настройка ширины столбцов
autoResizeColumns(startColumn, numColumns): автоматически подбирает ширину указанных столбцов под их текстовое содержимое.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Set the A:C columns to a width that fits their text.sheet.autoResizeColumns(0, 3)Установка пользовательских свойств столбцов
setColumnCustom(custom): задаёт пользовательские свойства столбцов. В столбце сохраняется объект custom, в который можно поместить любые данные в формате JSON для хранения дополнительной информации.
При обновлении данных custom исходные данные custom перезаписываются. Если при обновлении необходимо сохранить исходные данные custom, заранее получите данные custom, объедините их с новыми, а затем выполните обновление.
const sheet = univerAPI.getActiveWorkbook().getActiveSheet()// Set custom properties for the first and third columnssheet.setColumnCustom({ 0: { color: 'red' }, 2: { size: 16 },})Насколько полезно это руководство?