Onetastic Macro Documentation > Functions > Object Functions > SortObjects

SortObjects

Sorts given objects by a given property or a given custom sort order. When sorting object that are not under the same parent object, they are sorted only within their siblings. For instance if you try to sort all pages in current notebook, they will be sorted within each section and they won't move between sections.

Syntax

void SortObjects(
	Array objects, 
	Mixed by, 
	Bool ascending)

Parameters

Array objects

Array of objects to be sorted.

Mixed by

The property to sort by (in which case its type is string) or a custom sort order (in which case its type is an array). A custom sort order array must have indices 0 to number of elements being sorted and its values will be used when comparing corresponding object in the object array.

Bool ascending

Sort in ascending order, if set to true, descending order if set to false.