Check documentation for the latest version of dhtmlxSuite SortInterface Object DHTMLX Docs

SortInterface Object

add

adds a new sorting rule to collection

$coll->add("name","type");

Parameters:

  • name - name of the field.
  • type - sorting type: ASC or DESC See also:

  • Sorting

clear

clears collection (deletes all specified sorting rules)

$coll->clear();

Parameters:

  • none.

index

checks if there are some rules in collection for the specified field and returns the related hash.

$index = $coll->index("name");

Parameters:

  • name - name of the field

Returns:

  • true - if collection contains rule(s) for the specified field.
  • false - if collection doesn't contain any rules for the field.

rules

an array of all specified sorting rules

$name = $coll->rules[0]["name"];
$coll->rules[0]["direction"]="DESC";

Properties:

  • name - name of related field
  • direction - direction of sorting

See also:

Back to top