Sort

GanttSheet provides sorting functionality to organize tasks efficiently throughout the project. You can sort data by using the sort method of the GC.Spread.Sheets.GanttSheet.Project class.

SpreadJS allows you to sort and order GanttSheet data in different ways. These sorting options enable you to modify the display of tasks in GanttSheet according to your specific project needs.

Ascending Order

Sort tasks or resources from lowest values to highest (A to Z and 1, 2, 3…).

The following code sample shows how to sort the taskNumber field in ascending order.

// Sort taskNumber field ascending.     
ganttSheet.project.sort(["taskNumber"], [true]);    

Descending Order

Sort tasks or resources from highest values to lowest (Z to A and …3, 2, 1).

The following code sample shows how to sort the taskNumber field in descending order.

// Sort taskNumber field descending.     
ganttSheet.project.sort(["taskNumber"], [false]);

Keep Outline Structure

To keep the outline structure intact, GanttSheet sorts tasks by keeping the original task tree structure. In this scenario, the relationship between the child and parent tasks remains constant. This means that subtasks will remain linked to their parent tasks. GanttSheet can also be sorted without maintaining the outline structure as well.

The following code sample shows how to sort the taskNumber field in descending order without keeping the outline structure.

// Sort taskNumber field descending, not to keep structure. 
ganttSheet.project.sort(["taskNumber"], [false], false);

SpreadJS also supports flat sorting, but that will break the original task tree structure of GanttSheet. Flat sorting also ignores the data in groups. Note that the following actions will be prohibited once the GanttSheet has been flat sorted.

• The root node is not involved in sorting.

• If you sort without keeping the outline structure, the project will be temporary. Therefore,

  • All collapse/expand behaviors are prohibited.

  • Indent/outdent will not work.

  • Tasks cannot be renumbered.

Permanently Renumber Tasks

GanttSheet sorting can be temporary or permanent. While doing permanent sorting, the ID numbers of the tasks are renumbered based on the new order. But if you want to retain the sort state in your database, you can renumber all the tasks. To renumber tasks, make sure the Keep Outline Structure checkbox is enabled.

The following code sample shows how to sort the taskNumber field in descending order without keeping the outline structure wherein the task numbers are renumbered based on the new sort order.

// Sort taskNumber field descending and not to keep the structure.
ganttSheet.project.sort(["taskNumber"], [false], true, true);

The GIF below demonstrates different sorting behaviors.