beforeAction

Описание

Вызывается перед выполнением действия

Использование

beforeAction: (
    action: string,
    config: {
        action?: string,
        cell?: string,
        row?: number,
        col?: number,
        val?: any,
        prev?: any,
        groupAction?: string,
        pageId?: string | number,
        pageName?: string,
        // other properties of the action
    } | object[]
) => void | boolean;

Параметры

Колбэк события принимает следующие параметры:

• action - (обязательный) имя действия. Полный список доступных действий см. здесь

• config - (обязательный) объект с параметрами действия. Набор свойств зависит от действия. Объект может содержать:

  • action - (необязательный) имя действия
  • cell - (необязательный) идентификатор ячейки или диапазона ячеек, к которым применяется действие, например, "A1" или "B2:D5"
  • row - (необязательный) индекс строки ячейки, начиная с нуля
  • col - (необязательный) индекс столбца ячейки, начиная с нуля
  • val - (необязательный) новое значение, которое применяет действие, например, значение ячейки, стиль или размер
  • prev - (необязательный) предыдущее значение
  • groupAction - (необязательный) имя действия, которое выполняется вместо action, когда cell является диапазоном ячеек, например, "groupAction", "groupRowAction" или "resizeCol"
  • pageId - (необязательный) идентификатор листа
  • pageName - (необязательный) имя листа

  Когда несколько действий выполняются вместе, например, при вставке, параметр action равен "groupAction", а config - массив таких объектов.

Возвращаемое значение

Верните false, чтобы предотвратить выполнение действия; в противном случае верните true

Пример

const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
    // параметры конфигурации
});
spreadsheet.parse(dataset);

spreadsheet.events.on("beforeAction", (actionName, config) => {
    if (actionName === "sortCells") {
        console.log(actionName, config);
        return false;
    }
});

Журнал изменений: Добавлено в v4.3

Полезные статьи:

• Действия Spreadsheet
• Обработка событий