-
Notifications
You must be signed in to change notification settings - Fork 20
[add] docs for v9.1 #48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
77cf143
[update] move treegrid api to grid and update descriptions
mafanya23 17f2f50
[add] grid subRow/subRowConfig properties descriptions
mafanya23 28a04cb
[update] treegrid mode guide, fix api descriptions
mafanya23 42c1209
[add] a draft for the row expander guide, updates and fixes in api
mafanya23 615dedd
[update] complete the row expander guide and api
mafanya23 00e79bb
[update] examples for expand/collapse grid api
mafanya23 9271fd0
[update] minor corrections in row expander guide
mafanya23 46b5453
[add] a draft for what's new of v9.1
mafanya23 98401ae
[add] getSortingStates() method page for data/treecollection
mafanya23 93ee18f
Merge branch 'next' into grid-row-expander-3443
mafanya23 4b13f36
[update] data sorting api and guide
mafanya23 17017fa
[update] move treegrid configs to grid api
mafanya23 667f938
[add] how to work with row expander section into grid features
mafanya23 0012371
[update] improve grid row expander guide and api
mafanya23 7e212f9
[update] grid multi-sorting guide and api
mafanya23 69f9afd
Merge branch 'next' into 9.1
mafanya23 f4c268d
[update] what's new for v9.1
mafanya23 16ea244
[add] a section on multi-user backend
mafanya23 20c18e1
[add] images for row expander guide
mafanya23 34cd9ea
[update] docs for v9.1
mafanya23 944ef1a
[fix] minor corrections in the sort(), filter() methods of treecollec…
mafanya23 cd19b46
[fix] corrections in data/treecollection sort() examples
mafanya23 2d96541
[update] what's new for v9.1
mafanya23 b693868
[fix] a broken link
mafanya23 3c22aae
[update] what's new for v9.1
mafanya23 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
docs/data_collection/api/datacollection_getsortingstates_method.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| sidebar_label: getSortingStates() | ||
| title: JavaScript DataCollection - getSortingStates Method | ||
| description: You can explore the getSortingStates method of DataCollection in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite. | ||
| --- | ||
|
|
||
| # getSortingStates() | ||
|
|
||
| @short: returns an array of objects with the current parameters of sorting applied to the data | ||
|
|
||
| ## Usage | ||
|
|
||
| ~~~jsx | ||
| interface ISortingState { | ||
| by: string | number, | ||
| dir: "asc" | "desc", | ||
| as?: (a) => any, | ||
| rule?: (a, b) => number, | ||
| smartSorting?: boolean | ||
| } | ||
|
|
||
| getSortingStates(): ISortingState[]; | ||
| ~~~ | ||
|
|
||
| @returns: | ||
| An array of objects with the current parameters of sorting applied to the data. | ||
|
|
||
| @example: | ||
| const state = grid.data.getSortingStates(); | ||
| // -> [{by: "country", dir: "desc"}, {by: "population", dir: "desc"}] | ||
|
|
||
| @descr: | ||
| The array returned by the method contains objects with the following properties: | ||
|
|
||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td><b>by</b></td> | ||
| <td>(<i>string | number</i>) the id of a data field to sort by</td> | ||
| </tr> | ||
| <tr> | ||
| <td><b>dir</b></td> | ||
| <td>(<i>string</i>) the direction of sorting: "asc" or "desc"</td> | ||
| </tr> | ||
| <tr> | ||
| <td><b>as</b></td> | ||
| <td>(<i>function</i>) optional, a custom function of converting values before comparing</td> | ||
| </tr> | ||
| <tr> | ||
| <td><b>rule</b></td> | ||
| <td>(<i>function</i>) optional, a custom sorting function</td> | ||
| </tr> | ||
| <tr> | ||
| <td><b>smartSorting</b></td> | ||
| <td>(<i>boolean</i>) optional, (if applied) specifies whether a sorting rule should be applied each time after changing the data set</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| @changelog: | ||
| added in v9.1 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mafanya23 тот же комментарий, что и к TreeGridCollection