Строки и Столбцы

Работа со столбцами

Скрыть/показать столбцы

Чтобы управлять видимостью столбцов на листе Spreadsheet, используйте метод hideColumn.
Метод принимает следующие параметры:

• columnId - (number,array) ID столбца/столбцов
• state - (boolean) true - скрыть столбец, false - показать столбец
• page - (string) опциональный, название страницы. Если не задан, метод применяется к текущей странице

$$("ssheet").hideColumn(2, true, "Sheet1");

Если параметр columnId не задан, метод скроет выделенный столбец. Метод также принимает массив ID в качестве первого параметра. В этом случае все столбцы из диапазона будут скрыты:

$$("ssheet").hideColumn([2, 5], true, "Sheet1");

Вставить новый столбец

Чтобы вставить новый столбец слева от указанного, используйте метод insertColumn.
В качестве параметра метод принимает ID столбца, перед которым будет вставлен новый столбец.

$$("ssheet").insertColumn(3);

Если ID столбца не задан, новый столбец будет вставлен перед выделенным столбцом.

Удалить столбец

Вы можете удалить определенный столбец или диапазон столбцов, передав их ID методу deleteColumn.

$$("ssheet").deleteColumn(3);
// или
$$("ssheet").deleteColumn([1, 3]);

Если параметр не задан, метод удалит выделенный столбец.

Получить конфигурацию столбца

Используя метод getColumn, вы можете получить объект конфигурации столбца.
В качестве параметра передайте методу ID столбца. Вы также можете передать название страницы вторым параметром:

var config = $$("ssheet").getColumn(5, "Sheet1");

Метод возвращает объект конфигурации столбца.

Проверить видимость столбца

Чтобы проверить видимость столбца, используйте метод isColumnVisible.
В качестве параметра метод принимает ID столбца:

var isVisible = $$("ssheet").isColumnVisible(2);

Метод возвращает true, если столбец виден, и false - если скрыт.

Работа со строками

Скрыть/показать строки

Чтобы управлять видимостью строк на листе Spreadsheet, используйте метод hideRow.
Метод принимает следующие параметры:

• rowId - (number,array) ID строки/строк
• state - (boolean) true - скрыть строку, false - показать строку
• page - (string) опциональный, название страницы. Если не задан, метод применяется к текущей странице

$$("ssheet").hideRow(3, true, "Sheet1");

Если параметр rowId не задан, метод скроет выделенную строку. Метод также принимает массив ID в качестве первого параметра. В этом случае все строки из диапазона будут скрыты:

$$("ssheet").hideRow([3, 7], true, "Sheet1");

Вставить новую строку

Чтобы вставить новую строку над указанной, используйте метод insertRow.
В качестве параметра метод принимает ID строки, над которой будет вставлена новая строка.

$$("ssheet").insertRow(3);

Если ID строки не задан, новая строка будет вставлена над выделенной строкой.

Удалить строку

Вы можете удалить определенную строку или диапазон строк, передав их ID методу deleteRow.

$$("ssheet").deleteRow(3);
// или
$$("ssheet").deleteRow([1, 3]);

Если параметр не задан, метод удалит выделенную строку.

Получить данные строки

Чтобы получить данные строки, используйте метод getRow.
В качестве параметра передайте методу ID строки. Вы также можете передать название страницы вторым параметром:

var data = $$("ssheet").getRow(5, "Sheet1");

Метод возвращает объект с данными строки.

Проверить видимость строки

Чтобы проверить видимость строки, используйте метод isRowVisible.
В качестве параметра метод принимает ID строки:

var isVisible = $$("ssheet").isRowVisible(2);

Метод возвращает true, если строка видима, и false - если скрыта.

Фиксирование строк и столбцов

Фиксирование столбцов

Вы можете "закрепить" столбец с данными, сделав его видимым независимо от горизонтальной прокрутки.

Чтобы закрепить столбцы, используйте метод freezeColumns. Фиксирование столбцов происходит начиная с крайнего слева, поэтому вам необходимо передать методу число столбцов для фиксации, начиная с 0 (нуля). Вы также можете передать название страницы вторым параметром:

$$("ssheet").freezeColumns(2, "Sheet1");

Если первый параметр не передан, метод снимет закрепление.

Фиксирование строк

Также вы можете закрепить строки, сделав их видимыми независимо от вертикальной прокрутки.

Чтобы закрепить строки, используйте метод freezeRows. В качестве первого параметра передайте методу количество строк, которые нужно закрепить, начиная с 0. Вы также можете передать название страницы вторым параметром:

$$("ssheet").freezeRows(3, "Sheet1");

Если первый параметр не передан, метод снимет закрепление.

Группировка строк и столбцов

Группировка позволяет организовывать строки или столбцы в сворачиваемые диапазоны, что упрощает навигацию и работу с большими листами. Группы можно вкладывать до 8 уровней.

Related sample:  Spreadsheet: Grouping API

Структура данных

Группы хранятся внутри table.groups содержимого каждого листа:

{
  "table": {
    "groups": {
      "row": [{ "start": 3, "end": 8, "level": 1, "open": true }],
      "column": [{ "start": 4, "end": 7, "level": 0, "open": false }]
    }
  }
}

Каждый объект группы - это массив объектов (групп) со следующими свойствами:

• start - (number) начальный столбец/строка группы
• end - (number) конечный столбец/строка группы
• level - (number) уровень вложенности группы
• open - (boolean) определяет, развёрнута ли группа

Группы поддерживают до 8 уровней вложенности; поле level использует нумерацию с нуля. По умолчанию группы развёрнуты.

Группировка столбцов

Добавление группы столбцов

Для группировки диапазона столбцов используйте метод addColumnGroup. Параметры метода:

• columnId - (number,array) необязательный, ID столбца или диапазон ID столбцов [start, end]
• page - (string) необязательный, название страницы

$$("ssheet").addColumnGroup([2, 5], "Sheet1");

Если параметр columnId не указан, метод добавляет группу для выбранных столбцов.

Удаление группы столбцов

Для удаления одного уровня группировки из диапазона столбцов используйте метод removeColumnGroup. Параметры метода:

• columnId - (number,array) необязательный, ID столбца или диапазон ID столбцов [start, end]
• page - (string) необязательный, название страницы

$$("ssheet").removeColumnGroup([2, 5], "Sheet1");

Если параметр columnId не указан, метод удаляет уровень группировки для выбранных столбцов.

Разворачивание и сворачивание групп столбцов

Для разворачивания группы столбцов используйте метод openColumnGroup. Для сворачивания - метод closeColumnGroup. Оба метода принимают одинаковые параметры:

• columnId - (number,array) необязательный, ID столбца или диапазон ID столбцов [start, end]
• page - (string) необязательный, название страницы

$$("ssheet").openColumnGroup(3, "Sheet1");
$$("ssheet").closeColumnGroup(3, "Sheet1");

Если параметр columnId не указан, метод работает с группой для выбранных столбцов.

Получение групп столбцов

Для получения всех групп столбцов листа используйте метод getColumnGroups. Название страницы можно передать как необязательный параметр:

const columnGroups = $$("ssheet").getColumnGroups();

Метод возвращает массив объектов групп со следующими свойствами: start, end, level и open.

Группировка строк

Добавление группы строк

Для группировки диапазона строк используйте метод addRowGroup. Параметры метода:

• rowId - (number,array) необязательный, ID строки или диапазон ID строк: [start, end]
• page - (string) необязательный, название страницы

$$("ssheet").addRowGroup([3, 7], "Sheet1");

Если параметр rowId не указан, метод добавляет группу для выбранных строк.

Удаление группы строк

Для удаления одного уровня группировки из диапазона строк используйте метод removeRowGroup. Параметры метода:

• rowId - (number,array) необязательный, ID строки или диапазон ID строк: [start, end]
• page - (string) необязательный, название страницы

$$("ssheet").removeRowGroup([3, 7], "Sheet1");

Если параметр rowId не указан, метод удаляет уровень группировки для выбранных строк.

Разворачивание и сворачивание групп строк

Для разворачивания группы строк используйте метод openRowGroup. Для сворачивания - метод closeRowGroup. Оба метода принимают одинаковые параметры:

• rowId - (number,array) необязательный, ID строки или диапазон ID строк: [start, end]
• page - (string) необязательный, название страницы

$$("ssheet").openRowGroup(5, "Sheet1");
$$("ssheet").closeRowGroup(5, "Sheet1");

Если параметр rowId не указан, метод работает с группой для выбранных строк.

Получение групп строк

Для получения всех групп строк листа используйте метод getRowGroups. Название страницы можно передать как необязательный параметр:

const rowGroups = $$("ssheet").getRowGroups();

Метод возвращает массив объектов групп со следующими свойствами: start, end, level и open.

Горячие клавиши

• Alt+Shift+Right - Group: открывает диалог для выбора строк или столбцов, затем группирует текущее выделение.

• Alt+Shift+Left - Ungroup: открывает диалог для выбора строк или столбцов, затем разгруппирует текущее выделение.

• Alt+Shift+Up - Collapse/Close: сворачивает группу (или несколько групп) для текущего выделения. Работает для обоих измерений (строки/столбцы) одновременно.
• Alt+Shift+Down - Expand/Open: разворачивает группу (или несколько групп) для текущего выделения. Работает для обоих измерений (строки/столбцы) одновременно.

Наверх