setSort()

Описание

Сортирует карточки по заданным параметрам

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

setSort(
    {
        by?: string | function, // by?: ((card: object) => any),
        dir?: "asc" | "desc",
        columnId?: string | number,
        preserve?: boolean
    } | null
): void;

Параметры

Метод может принимать объект с параметрами сортировки или значение null. В объекте можно указать следующие параметры:

• by - (необязательно) поле карточки для сортировки. Параметр может быть строкой или функцией. Функция должна возвращать поле карточки для сортировки
• dir - (необязательно) порядок сортировки. Возможные значения: "asc" и "desc"
• columnId - (необязательно) ID колонки, которую нужно отсортировать
• preserve - (необязательно) включает или отключает сохранение состояния сортировки (по умолчанию false)

информация

Если параметр preserve установлен в false, сортировка применяется однократно. Это значит, что после добавления или перемещения карточек состояние сортировки не сохраняется (порядок изменится). В противном случае состояние сортировки сохраняется даже после добавления новых карточек или их перемещения. Чтобы сбросить сохранение, вызовите метод setSort() с параметром null.

Пример

// создаём Kanban
const board = new kanban.Kanban("#root", {
    columns,
    cards
});
// сортируем карточки в порядке возрастания по параметру "label"
board.setSort({ 
    by: (obj) => obj.label, // или by: "label"
    dir: "asc",
    columnId: "backlog",
    preserve: false
});

История изменений: Метод был добавлен в версии v1.2