-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from DHTMLX/next
[update] docs for v9.0
- Loading branch information
Showing
224 changed files
with
4,325 additions
and
9,614 deletions.
There are no files selected for viewing
This file contains 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
39 changes: 39 additions & 0 deletions
39
docs/data_collection/api/datacollection_aftergroup_event.md
This file contains 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,39 @@ | ||
| --- | ||
| sidebar_label: afterGroup | ||
| title: JavaScript DataCollection - afterGroup Event | ||
| description: You can explore the afterGroup event 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. | ||
| --- | ||
|
|
||
| # afterGroup | ||
|
|
||
| @short: fires after data is grouped | ||
|
|
||
| ## Usage | ||
|
|
||
| ~~~jsx | ||
| interface IGroupConfig { | ||
| showMissed?: boolean | string; // true by default | ||
| field?: string; // "group" by default | ||
| } | ||
|
|
||
| afterGroup: (grouped: string[], config: IGroupConfig) => void; | ||
| ~~~ | ||
|
|
||
| ## Parameters | ||
|
|
||
| - `grouped` - an array of fields data was grouped by | ||
| - `config` - the configuration of data grouping | ||
| - `showMissed` - (optional) specifies whether the elements that don't have the field for grouping should be displayed, *true* by default | ||
| - if set to *true*, the rows that don't have values for grouping are rendered row by row after all the data | ||
| - if a *string* value is set, e.g. "Missed", the rows that don't have values for grouping are rendered as a separate group the name of which will have the specified string value. This group will be rendered as the last one | ||
| - if set to *false*, the rows that don't suit the grouping criteria won't be rendered | ||
| - `field` - (optional) the group field name, *"group"* by default | ||
|
|
||
| @example: | ||
| component.data.events.on("afterGroup", (grouped, config) => { | ||
| console.log("Grouping complete. Fields:", grouped, "Configuration:", config); | ||
| }); | ||
|
|
||
| @descr: | ||
|
|
||
| @changelog: added in v9.0 |
39 changes: 39 additions & 0 deletions
39
docs/data_collection/api/datacollection_afterungroup_event.md
This file contains 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,39 @@ | ||
| --- | ||
| sidebar_label: afterUnGroup | ||
| title: JavaScript DataCollection - afterUnGroup Event | ||
| description: You can explore the afterUnGroup event 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. | ||
| --- | ||
|
|
||
| # afterUnGroup | ||
|
|
||
| @short: fires after data is ungrouped | ||
|
|
||
| ## Usage | ||
|
|
||
| ~~~jsx | ||
| interface IGroupConfig { | ||
| showMissed?: boolean | string; // true by default | ||
| field?: string; // "group" by default | ||
| } | ||
|
|
||
| afterUnGroup: (grouped: string[], config: IGroupConfig) => void; | ||
| ~~~ | ||
|
|
||
| ## Parameters | ||
|
|
||
| - `grouped` - an array of fields data was grouped by | ||
| - `config` - the configuration object used for the latest data grouping | ||
| - `showMissed` - (optional) specifies whether the elements that don't have the field for grouping should be displayed, *true* by default | ||
| - if set to *true*, the rows that don't have values for grouping are rendered row by row after all the data | ||
| - if a *string* value is set, e.g. "Missed", the rows that don't have values for grouping are rendered as a separate group the name of which will have the specified string value. This group will be rendered as the last one | ||
| - if set to *false*, the rows that don't suit the grouping criteria won't be rendered | ||
| - `field` - (optional) the group field name, *"group"* by default | ||
|
|
||
| @example: | ||
| grid.data.events.on("afterUnGroup", (grouped, config) => { | ||
| console.log("Grouping deletion completed. Fields:", grouped); | ||
| }); | ||
|
|
||
| @descr: | ||
|
|
||
| @changelog: added in v9.0 |
42 changes: 42 additions & 0 deletions
42
docs/data_collection/api/datacollection_beforegroup_event.md
This file contains 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,42 @@ | ||
| --- | ||
| sidebar_label: beforeGroup | ||
| title: JavaScript DataCollection - beforeGroup Event | ||
| description: You can explore the beforeGroup event 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. | ||
| --- | ||
|
|
||
| # beforeGroup | ||
|
|
||
| @short: fires before grouping of data has started | ||
|
|
||
| ## Usage | ||
|
|
||
| ~~~jsx | ||
| interface IGroupConfig { | ||
| showMissed?: boolean | string; // true by default | ||
| field?: string; // "group" by default | ||
| } | ||
|
|
||
| beforeGroup: (config: IGroupConfig) => boolean | void; | ||
| ~~~ | ||
|
|
||
| ## Parameters | ||
|
|
||
| - `config` - the configuration object used for data grouping | ||
| - `showMissed` - (optional) specifies whether the elements that don't have the field for grouping should be displayed, *true* by default | ||
| - if set to *true*, the rows that don't have values for grouping are rendered row by row after all the data | ||
| - if a *string* value is set, e.g. "Missed", the rows that don't have values for grouping are rendered as a separate group the name of which will have the specified string value. This group will be rendered as the last one | ||
| - if set to *false*, the rows that don't suit the grouping criteria won't be rendered | ||
| - `field` - (optional) the group field name, *"group"* by default | ||
|
|
||
| @returns: | ||
| Return `false` to prevent data grouping; otherwise, `true`. | ||
|
|
||
| @example: | ||
| component.data.events.on("beforeGroup", (config) => { | ||
| console.log("Grouping starts:", config); | ||
| return true; // continue grouping | ||
| }); | ||
|
|
||
| @descr: | ||
|
|
||
| @changelog: added in v9.0 |
Oops, something went wrong.