Skip to content

Commit 944ef1a

Browse files
committed
[fix] minor corrections in the sort(), filter() methods of treecollection
1 parent 34cd9ea commit 944ef1a

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/tree_collection/api/treecollection_filter_method.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ description: You can explore the filter method of TreeCollection in the document
1414
- `rule: function | object` - the filtering criteria
1515
- If set as a *function*, filtering will be applied by the rule specified in the function. The function takes an object of a data item as a parameter and returns *true/false*
1616
- If set as an *object*, the parameter has the following attributes:
17-
- `by: string | number` - required, the id of a column
17+
- `by: string | number` - required, the id of a data field
1818
- `match: string` - required, a pattern to match
1919
- `compare: function` - optional, a function for extended filtering that takes three parameters:
20-
- `value` - the value to compare (e.g. a column in a row for Grid)
20+
- `value` - the value to compare
2121
- `match` - a pattern to match
22-
- `item` - a data item the values of which should be compared (e.g. a row)
22+
- `item` - a data item the values of which should be compared
2323
- `config: object` - optional, defines the parameters of filtering. The parameter may contain the following properties:
2424
- `type: string` - optional, defines the area the filtering will be applied: "all", "level", "leafs"
2525
- `level: number` - optional, the level the filtering will be applied to

docs/tree_collection/api/treecollection_sort_method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ description: You can explore the sort method of TreeCollection in the documentat
1212

1313
@params:
1414
- `rule: object` - an object with parameters for sorting. The object has the following attributes:
15-
- `by: string | number` - the id of a data field (a column of Grid in the TreeGrid mode)
15+
- `by: string | number` - the id of a data field
1616
- `dir: string` - the direction of sorting: "asc" or "desc"
1717
- `as: function` - a function that specifies the type to sort data as
1818
- `rule: function` - optional, a sorting rule; the function must have two parameters and return a number (-1,0,1)

0 commit comments

Comments
 (0)