TreeList.sort

Синтаксис

sort (column: Number, method: PP.SortDirection, property: String, recursive: Boolean);

Параметры

column. Номер столбца, по которому будет осуществляться сортировка;

method. Способ сортировки, элемент перечисления PP.SortDirection;

property. Свойство вершины, по которому будет производиться сортировка;

recursive. Определяет, будет ли осуществляться сортировка дочерних элементов. По умолчанию установлено true, то есть будет.

Описание

Метод sort осуществляет сортировку элементов дерева по столбцу.

Комментарии

Для работы метода необходимо, чтобы была включена возможность сортировки, то есть для свойства TreeList.EnableSortColumns должно быть установлено значение true.

Сортировка происходит при нажатии на заголовок столбца. При сортировке по убыванию появляется пиктограмма , по возрастанию - .

Пример

Для выполнения примера предполагается наличие на странице компонента TreeList с наименованием «treeListSett» (см. «Пример создания компонента TreeList»). Добавим кнопку, при нажатии на которую будет осуществляться сортировка дерева по убыванию по первому столбцу:

    var but1 = new PP.Ui.Button(
    {
        ParentNode: document.getElementById("but1"),
        Content: "Sort",
        Click: function ()
        {
            treeListSett.setEnableSortColumns(true);//включаем возможность сортировки по столбцам
            treeListSett.collapseAll();//сворачиваем все вершины дерева
          treeListSett.sort(0, PP.Ui.TreeListSort.desc, 'Checked', true); //сортировка по убыванию по первому столбцу, при сортировке будет учитываться значение совйства TreeNode.Checked: в начале будут вершины с установленным флажком; сортировка с рекурсией: производится и в свернутых дочерних вершинах
            //выводим в консоль параметры сортировки
            console.log("Сортируемая колонка: " + treeListSett.getSortColumn() + "; Метод сортировки: " + treeListSett.getSortMethod() + "; Свойство: " + treeListSett.getSortProperty() + "; С рекурсией: " + treeListSett.getSortRecursive());
        }
    })

После выполнения примера при нажатии на кнопку «Sort» будет включена возможность сортировки по столбцам и будет осуществлена сортировка элементов первого столбца по убыванию, с рекурсией и с учетом свойства TreeNode.Checked.

В консоль будет выведены параметры сортировки:

Сортируемая колонка: 0; Метод сортировки: 2; Свойство: Checked; С рекурсией: true

См. также:

TreeList