setSort()

Описание

Сортирует карточки на основании заданных критериев

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

setSort(
    {
        by?: string, // 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, сортировка применяется однократно. Это значит, что после добавления или перемещения карточек порядок сортировки не сохраняется. Если preserve включён, порядок сортировки остаётся неизменным даже после добавления или перестановки карточек. Чтобы сбросить сохранённую сортировку, вызовите 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