message.sortCSVByString¶
Signature: message.sortCSVByString(sortNodePath, descending*)
Returns: void
Sorts the CSV alphabetically based on the sortNodePath.
Note
This method only applies to CSV formatted messages.
Parameters¶
| Type | Name | Description | Default |
|---|---|---|---|
| String | sortNodePath | the column of the CSV to sort on | |
| Boolean | descending* | (optional) when true sorts in descending order | false |
Example¶
// Example: Sort CSV rows alphabetically by a column (name or index).
// Sample CSV message structure
message = qie.createCSVMessage(
"Name,Age,DOB\n" +
"Alice,30,1992-03-15\n" +
"Bob,25,1997-08-22\n" +
"Charlie,35,1987-11-10\n", // value
false, // quote values
'"', // quote char
",", // separator
"UTF-8", // charset
true // contains header
);
// Sort by string column (ascending) using column name
message.sortCSVByString(
"Name" // column name
);
var firstNameAfterAsc = message.getNode("Name", 1); // "Alice"
var lastNameAfterAsc = message.getNode("Name", 3); // "Charlie"
// Sort by string column (descending) using column index
message.sortCSVByString(
"1", // column index ("Name")
true // descending
);
var firstNameAfterDesc = message.getNode("Name", 1); // "Charlie"
var lastNameAfterDesc = message.getNode("Name", 3); // "Alice"