Skip to content

[add] docs for v9.1 #48

Merged
mafanya23 merged 25 commits intomasterfrom
next
Feb 18, 2025
Merged

[add] docs for v9.1 #48
mafanya23 merged 25 commits intomasterfrom
next

Conversation

@mafanya23
Copy link
Contributor

No description provided.

@mafanya23 mafanya23 self-assigned this Feb 12, 2025

**Related sample**: [Grid. Sorting by multiple columns (multisorting)](https://snippet.dhtmlx.com/4ej0i3qi)

It is also possible to apply multi-sorting to [the grouped data](grid/usage.md#grouping-data). Check the example below:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23 тут пример в принципе про включение мульти сортировки при инициализации компонента, факт группировки тут малозначительный. Можно написать, что вот пример, как включить такую сортировку. Без упоминания групп.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Обновила раздел про мульти-сортировку

docs/whatsnew.md Outdated

#### Common features

- [Multi-user (live update) backend](integration/suite_and_backend.md#multi-user-backend-for-suite-widgets) for Suite widgets
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23 наверное в раздел с примерами. По сути, чтобы это заработало на клиента ничего не добавляли. Просто примеры

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Перенесла в примеры

docs/whatsnew.md Outdated

### Fixes

- DataCollection. The `sort()` method called without arguments doesn't reset the applied sorting
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23 DataCollection/TreeCollection

@short: returns an array of objects with the current parameters of sorting applied to the data

:::note
The method allows getting the result of sorting data by multiple columns.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23 работает всегда, в том числе у тех, у кого нет мультисортировки через UI.
Ограничений через API у сортировки нет.
Заметка не нужна.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Убрала заметку для data/treecollection getSortingStates()

<tbody>
<tr>
<td><b>by</b></td>
<td>(<i>string | number</i>) the id of a data field (a column of Grid) to sort by</td>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23 в описании метода TreeCollection лучше не допускать таких пометок, касательно иного компонента.
Коллекция может применятся в Toolbar или Tree.

(a column of Grid)

Лучше сноской выделить ниже, что для Grid это column id. Либо вовсе убрать фразу. Необходимо пройтись по методам/событиям. Исправить такие места.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Подправила описания для treecollection getSortingStates(), sort(), filter()


## Examples of using DHTMLX Suite widgets with Node.js

Let's have an overview of the examples.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23

Here you can find 12 interactive...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Пока немного переделала описание

## Usage

~~~jsx
interface ISortingState {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23

interface ISortingState {
    by: string | number, 
    dir: "asc" | "desc", 
    as?: (a) => any, 
    rule?: (a, b) => number, 
    smartSorting?: boolean 
}

## Usage

~~~jsx
interface ISortingState {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23 тот же комментарий, что и к TreeGridCollection

<tbody>
<tr>
<td><b>by</b></td>
<td>(<i>string | number</i>) the id of a data field (a column of Grid) to sort by</td>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23 не нужна тут эта фраза

(a column of Grid)

@params:
- `rule: object` - an object with parameters for sorting. The object has the following attributes:
- `by: string | number` - the id of a data field (a column of Grid in the TreeGrid mode)
- `by: string | number` - the id of a data field
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mafanya23 ошибки в записи, необходимо проверить в других местах

component.data.sort(
    {
        by: "price",
        dir: "asc",
        as: value => (value || "")
    },
    { smartSorting: true }
);
// cancels the applied sorting rules
component.data.sort();

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Поправила

@mafanya23 mafanya23 merged commit 710a815 into master Feb 18, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants