diff --git a/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant.md b/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/aiAssistant.md similarity index 64% rename from api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant.md rename to api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/aiAssistant.md index c0eabebd48..206584b14e 100644 --- a/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant.md +++ b/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/aiAssistant.md @@ -1,10 +1,11 @@ --- id: dxDataGrid.Options.aiAssistant type: AIAssistant +inheritsType: AIAssistant --- --- ##### shortDescription - +Configures the {WidgetName} AI Assistant. --- \ No newline at end of file diff --git a/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseText.md b/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseText.md new file mode 100644 index 0000000000..96099e0592 --- /dev/null +++ b/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseText.md @@ -0,0 +1,145 @@ +--- +id: dxDataGrid.Options.aiAssistant.customizeResponseText +type: function(command) +--- +--- +##### shortDescription +Customizes AI Assistant response texts for each requested command. + +##### param(command): DataGridCommandInfo +Information about the command. + +##### return: ResponseStatusTexts +Custom texts for **success** and **failure** response statuses. + +--- +Use this function to customize response message texts for AI Assistant commands. **customizeResponseText** is called for each requested command. The AI Assistant chat displays these texts below the response title. When a response includes multiple commands, the chat displays each command's text on separate lines. + +When a command succeeds, the AI Assistant chat displays the response text in green and prefixes the text with a checkmark button emoji (✅). When a command fails, the AI Assistant chat displays the text in red and prefixes with a cross mark emoji (❌) instead. + +The **command** parameter contains the following fields: + +- **name**: The command's name ([DataGridPredefinedCommandNames]({basewidgetpath}/Types/DataGridPredefinedCommandNames/)). +- **args**: Command arguments. Refer to [DataGridPredefinedCommands]({basewidgetpath}/Types/DataGridPredefinedCommands/) for information about the arguments of each available command. + +Configure **customizeResponseText** to return an object with the following fields: + +- **success**: Text to display when the command succeeds. +- **failure**: Text to display when the command fails. + +Omit a field in the return object to use default texts. + +You can use this function to translate response texts. The following code snippet uses the [locale()](/Documentation/ApiReference/Common/Utils/localization/#locale) method to specify texts for multiple locales: + +--- + +##### jQuery + + + const currentLocale = DevExpress.localization.locale(); + + $('#{widget-name}-container').dx{WidgetName}({ + aiAssistant: { + customizeResponseText(command) { + switch (currentLocale) { + case 'en': + return { + success: `Command succeeded: ${command.name}`, + failure: `Command failed: ${command.name}`, + }; + case 'fr': + return { /* Translated texts */ }; + } + }, + }, + }); + +##### Angular + + + + + + + + import { Dx{WidgetName}Module, type Dx{WidgetName}Types } from 'devextreme-angular/ui/{widget-name}'; + import { locale } from "devextreme/localization"; + + export class AppComponent { + currentLocale = locale(); + customizeResponseText = (command) => { + switch (this.currentLocale) { + case 'en': + return { + success: `Command succeeded: ${command.name}`, + failure: `Command failed: ${command.name}`, + }; + case 'fr': + return { /* Translated texts */ }; + } + }; + } + +##### Vue + + + + + + + + + + +##### React + + + import { {WidgetName}, AIAssistant, type {WidgetName}Types } from 'devextreme-react/{widget-name}'; + import { locale } from "devextreme/localization"; + + const currentLocale = locale(); + function customizeResponseText(command) { + switch (currentLocale) { + case 'en': + return { + success: `Command succeeded: ${command.name}`, + failure: `Command failed: ${command.name}`, + }; + case 'fr': + return { /* Translated texts */ }; + } + }; + + function App() { + return ( + <{WidgetName}> + + {WidgetName}> + ); + }; + +--- diff --git a/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseTitle.md b/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseTitle.md new file mode 100644 index 0000000000..87cdd122bb --- /dev/null +++ b/api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseTitle.md @@ -0,0 +1,122 @@ +--- +id: dxDataGrid.Options.aiAssistant.customizeResponseTitle +type: function(status, commandNames) +--- +--- +##### shortDescription +Customizes AI Assistant response titles. + +##### param(status): Enums.ResponseStatus +The response status. If a response includes multiple requested commands, all must succeed for this parameter to return *"success"*. + +##### param(commandNames): Array +An array of requested commands ([DataGridPredefinedCommandNames]({basewidgetpath}/Types/DataGridPredefinedCommandNames/)). + +##### return: String +The custom response title. + +--- +Use this function to customize the titles of AI Assistant response messages. + +You can use this function to translate response texts. The following code snippet uses the [locale()](/Documentation/ApiReference/Common/Utils/localization/#locale) method to specify texts for multiple locales: + +--- + +##### jQuery + + + const currentLocale = DevExpress.localization.locale(); + + $('#{widget-name}-container').dx{WidgetName}({ + aiAssistant: { + customizeResponseTitle(status, commandNames) { + switch (currentLocale) { + case 'en': + return `${status.toUpperCase()}: ${commandNames.join(', ')}`; + case 'fr': + return /* Translated texts */; + } + }, + }, + }); + +##### Angular + + + + + + + + import { Dx{WidgetName}Module, type Dx{WidgetName}Types } from 'devextreme-angular/ui/{widget-name}'; + import { locale } from "devextreme/localization"; + + export class AppComponent { + currentLocale = locale(); + customizeResponseTitle = (status, commandNames) => { + switch (this.currentLocale) { + case 'en': + return `${status.toUpperCase()}: ${commandNames.join(', ')}`; + case 'fr': + return /* Translated texts */; + } + }; + } + +##### Vue + + + + + + + + + + +##### React + + + import { {WidgetName}, AIAssistant, type {WidgetName}Types } from 'devextreme-react/{widget-name}'; + import { locale } from "devextreme/localization"; + + const currentLocale = locale(); + function customizeResponseTitle(status, commandNames) { + switch (currentLocale) { + case 'en': + return `${status.toUpperCase()}: ${commandNames.join(', ')}`; + case 'fr': + return /* Translated texts */; + } + }; + + function App() { + return ( + <{WidgetName}> + + {WidgetName}> + ); + }; + +--- diff --git a/api-reference/10 UI Components/dxDataGrid/9 Types/DataGridCommandInfo/DataGridCommandInfo.md b/api-reference/10 UI Components/dxDataGrid/9 Types/DataGridCommandInfo/DataGridCommandInfo.md new file mode 100644 index 0000000000..704e92e6c3 --- /dev/null +++ b/api-reference/10 UI Components/dxDataGrid/9 Types/DataGridCommandInfo/DataGridCommandInfo.md @@ -0,0 +1,16 @@ +--- +id: DataGridCommandInfo +module: ui/data_grid +export: DataGridCommandInfo +type: CommandInfo +generateTypeLink: +--- +--- +##### shortDescription +Information about a predefined DataGrid command. + +--- +**DataGridCommandInfo** contains the following fields: + +- **name**: The predefined command's name ([DataGridPredefinedCommandNames]({basewidgetpath}/Types/DataGridPredefinedCommandNames/)). +- **args**: Command arguments. Refer to [DataGridPredefinedCommands]({basewidgetpath}/Types/DataGridPredefinedCommands/) for information about the arguments of each available command. diff --git a/api-reference/10 UI Components/dxDataGrid/9 Types/DataGridPredefinedCommandNames/DataGridPredefinedCommandNames.md b/api-reference/10 UI Components/dxDataGrid/9 Types/DataGridPredefinedCommandNames/DataGridPredefinedCommandNames.md new file mode 100644 index 0000000000..d49f0dbbb0 --- /dev/null +++ b/api-reference/10 UI Components/dxDataGrid/9 Types/DataGridPredefinedCommandNames/DataGridPredefinedCommandNames.md @@ -0,0 +1,39 @@ +--- +id: DataGridPredefinedCommandNames +module: ui/data_grid +export: DataGridPredefinedCommandNames +type: String +--- +--- +##### shortDescription +Names of predefined commands available in the DevExtreme DataGrid. + +--- +The following commands are available: + +- **columnsVisibility** +- **columnsReorder** +- **columnsPinning** +- **columnsResize** +- **filterValue** +- **clearFilter** +- **focusRowByKey** +- **focusRowByIndex** +- **paging** +- **pageSize** +- **pageIndex** +- **searching** +- **selectByKeys** +- **selectByIndexes** +- **selectAll** +- **deselectAll** +- **clearSelection** +- **sorting** +- **clearSorting** +- **grouping** +- **clearGrouping** +- **summary** +- **clearSummary** + +#####See Also##### +- [DataGridPredefinedCommands]({basewidgetpath}/Types/DataGridPredefinedCommands) \ No newline at end of file diff --git a/api-reference/10 UI Components/dxDataGrid/9 Types/DataGridPredefinedCommands/DataGridPredefinedCommands.md b/api-reference/10 UI Components/dxDataGrid/9 Types/DataGridPredefinedCommands/DataGridPredefinedCommands.md new file mode 100644 index 0000000000..62e99664d7 --- /dev/null +++ b/api-reference/10 UI Components/dxDataGrid/9 Types/DataGridPredefinedCommands/DataGridPredefinedCommands.md @@ -0,0 +1,78 @@ +--- +id: DataGridPredefinedCommands +module: ui/data_grid +export: DataGridPredefinedCommands +type: PredefinedCommands | Object +inherits: PredefinedCommands +--- +--- +##### shortDescription +Predefined commands available in the DevExtreme DataGrid. + +--- +The following code snippet lists available commands with their arguments: + + columnsVisibility: { + dataField: string; + visible: boolean; + }; + columnsReorder: { + dataField: string; + visibleIndex: number; + }; + columnsPinning: { + dataField: string; + fixed: boolean; + fixedPosition?: 'left' | 'right'; + }; + columnsResize: { + dataField: string; + width: number | string; + }; + filterValue: { + expression: FilterExprObj | null; + }; + clearFilter: {}; + focusRowByKey: { + key: string | number | Array; + }; + focusRowByIndex: { + index: number; + }; + paging: { + enabled: boolean; + }; + pageSize: { + pageSize: number; + }; + pageIndex: { + pageIndex: number; + }; + searching: { + text: string; + }; + selectByKeys: { + keys: Array>; + preserve: boolean; + }; + selectByIndexes: { + indexes: number[]; + }; + selectAll: {}; + deselectAll: {}; + clearSelection: {}; + sorting: { + dataField: string; + sortOrder: SortOrder | 'none'; + }; + clearSorting: {}; + grouping: { + dataField: string; + groupIndex: number; + }; + clearGrouping: {}; + summary: { + totalItems: Array; + groupItems: Array; + }; + clearSummary: {}; diff --git a/api-reference/10 UI Components/dxDataGrid/9 Types/SummaryCommandGroupItem/SummaryCommandGroupItem.md b/api-reference/10 UI Components/dxDataGrid/9 Types/SummaryCommandGroupItem/SummaryCommandGroupItem.md new file mode 100644 index 0000000000..1cff8e0876 --- /dev/null +++ b/api-reference/10 UI Components/dxDataGrid/9 Types/SummaryCommandGroupItem/SummaryCommandGroupItem.md @@ -0,0 +1,23 @@ +--- +id: SummaryCommandGroupItem +module: ui/data_grid +export: SummaryCommandGroupItem +acceptValues: 'showInColumn' | 'displayFormat' | 'showInGroupFooter' | 'alignByColumn' +type: Pick | Object +--- +--- +##### shortDescription +A group summary item in a DataGrid summary command. + +--- +This object includes the following fields: + +- **alignByColumn**: Specifies whether the summary item is aligned to a column. +- **column**: The summary item's data column. +- **displayFormat**: The format of the summary item's text. +- **showInColumn**: The column that displays the summary item. +- **showInGroupFooter**: Specifies whether the summary item is displayed in the group footer. +- **summaryType**: The summary calculation type ([SummaryType](/Documentation/ApiReference/Common_Types/grids/#SummaryType)). + +#####See Also##### +- [SummaryGroupItem]({basewidgetpath}/Types/SummaryGroupItem/) \ No newline at end of file diff --git a/api-reference/10 UI Components/dxDataGrid/9 Types/SummaryCommandTotalItem/SummaryCommandTotalItem.md b/api-reference/10 UI Components/dxDataGrid/9 Types/SummaryCommandTotalItem/SummaryCommandTotalItem.md new file mode 100644 index 0000000000..59ef519b5e --- /dev/null +++ b/api-reference/10 UI Components/dxDataGrid/9 Types/SummaryCommandTotalItem/SummaryCommandTotalItem.md @@ -0,0 +1,21 @@ +--- +id: SummaryCommandTotalItem +module: ui/data_grid +export: SummaryCommandTotalItem +acceptValues: 'showInColumn' | 'displayFormat' +type: Pick | Object +--- +--- +##### shortDescription +A total summary item in a DataGrid summary command. + +--- +This object includes the following fields: + +- **column**: The summary item's data column. +- **displayFormat**: The format of the summary item's text. +- **showInColumn**: The column that displays the summary item. +- **summaryType**: The summary calculation type ([SummaryType](/Documentation/ApiReference/Common_Types/grids/#SummaryType)). + +#####See Also##### +- [SummaryTotalItem]({basewidgetpath}/Types/SummaryTotalItem/) \ No newline at end of file diff --git a/api-reference/40 Common Types/15 grids/AIAssistant/chat.md b/api-reference/40 Common Types/15 grids/AIAssistant/chat.md index ca53132ed1..fbf4802903 100644 --- a/api-reference/40 Common Types/15 grids/AIAssistant/chat.md +++ b/api-reference/40 Common Types/15 grids/AIAssistant/chat.md @@ -13,7 +13,10 @@ Use DevExtreme [Chat](/api-reference/10%20UI%20Components/dxChat/1%20Configurati We do not recommend that you specify the following Chat options: -- [messageTemplate](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/messageTemplate.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#messageTemplate') +- [dataSource](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#dataSource) - [editing](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/editing '/Documentation/ApiReference/UI_Components/dxChat/Configuration/editing/') +- [messageTemplate](/api-reference/10%20UI%20Components/dxChat/1%20Configuration/messageTemplate.md '/Documentation/ApiReference/UI_Components/dxChat/Configuration/#messageTemplate') +- [onMessageEntered](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#onMessageEntered) +- [reloadOnChange](/Documentation/ApiReference/UI_Components/dxChat/Configuration/#reloadOnChange) [/note] \ No newline at end of file diff --git a/api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseText.md b/api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseText.md index 23ae6289d9..5c749a22e2 100644 --- a/api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseText.md +++ b/api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseText.md @@ -4,13 +4,142 @@ type: function(command) --- --- ##### shortDescription - +Customizes AI Assistant response texts for each requested command. ##### param(command): CommandInfo - +Information about the command. ##### return: ResponseStatusTexts - +Custom texts for `success` and `failure` response statuses. + +--- +Use this function to customize response message texts for AI Assistant commands. **customizeResponseText** is called for each requested command. The AI Assistant chat displays these texts below the response title. When a response includes multiple commands, the chat displays each command's text on separate lines. + +When a command succeeds, the AI Assistant chat displays the response text in green and prefixes the text with a checkmark button emoji (✅). When a command fails, the AI Assistant chat displays the text in red and prefixes with a cross mark emoji (❌) instead. + +The **command** parameter contains the following fields: + +- **name**: The command's name ([PredefinedCommandNames](/Documentation/ApiReference/Common_Types/grids/PredefinedCommandNames/)). +- **args**: Command arguments. Refer to [PredefinedCommands](/Documentation/ApiReference/Common_Types/grids/PredefinedCommands/) for information about the arguments of each available command. + +Configure **customizeResponseText** to return an object with the following fields: + +- **success**: Text to display when the command succeeds. +- **failure**: Text to display when the command fails. + +Omit a field in the return object to use default texts. + +You can use this function to translate response texts. The following code snippet uses the [locale()](/Documentation/ApiReference/Common/Utils/localization/#locale) method to specify texts for multiple locales: + +--- + +##### jQuery + + + const currentLocale = DevExpress.localization.locale(); + + $('#{widget-name}-container').dx{WidgetName}({ + aiAssistant: { + customizeResponseText(command) { + switch (currentLocale) { + case 'en': + return { + success: `Command succeeded: ${command.name}`, + failure: `Command failed: ${command.name}`, + }; + case 'fr': + return { /* Translated texts */ }; + } + }, + }, + }); + +##### Angular + + + + + + + + import { Dx{WidgetName}Module, type Dx{WidgetName}Types } from 'devextreme-angular/ui/{widget-name}'; + import { locale } from "devextreme/localization"; + + export class AppComponent { + currentLocale = locale(); + customizeResponseText = (command) => { + switch (this.currentLocale) { + case 'en': + return { + success: `Command succeeded: ${command.name}`, + failure: `Command failed: ${command.name}`, + }; + case 'fr': + return { /* Translated texts */ }; + } + }; + } + +##### Vue + + + + + + + + + + +##### React + + + import { {WidgetName}, AIAssistant, type {WidgetName}Types } from 'devextreme-react/{widget-name}'; + import { locale } from "devextreme/localization"; + + const currentLocale = locale(); + function customizeResponseText(command) { + switch (currentLocale) { + case 'en': + return { + success: `Command succeeded: ${command.name}`, + failure: `Command failed: ${command.name}`, + }; + case 'fr': + return { /* Translated texts */ }; + } + }; + + function App() { + return ( + <{WidgetName}> + + {WidgetName}> + ); + }; --- - \ No newline at end of file diff --git a/api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseTitle.md b/api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseTitle.md index 3ac42b0a0e..5892fdc761 100644 --- a/api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseTitle.md +++ b/api-reference/40 Common Types/15 grids/AIAssistant/customizeResponseTitle.md @@ -4,16 +4,119 @@ type: function(status, commandNames) --- --- ##### shortDescription - +Customizes AI Assistant response titles. ##### param(status): Enums.ResponseStatus - +The response status. If a response includes multiple requested commands, all must succeed for this parameter to return *"success"*. ##### param(commandNames): Array - +An array of requested commands ([PredefinedCommandNames]({basewidgetpath}/PredefinedCommandNames/)). ##### return: String - +The custom response title. + +--- +Use this function to customize the titles of AI Assistant response messages. + +You can use this function to translate response texts. The following code snippet uses the [locale()](/Documentation/ApiReference/Common/Utils/localization/#locale) method to specify texts for multiple locales: + +--- + +##### jQuery + + + const currentLocale = DevExpress.localization.locale(); + + $('#{widget-name}-container').dx{WidgetName}({ + aiAssistant: { + customizeResponseTitle(status, commandNames) { + switch (currentLocale) { + case 'en': + return `${status.toUpperCase()}: ${commandNames.join(', ')}`; + case 'fr': + return /* Translated texts */; + } + }, + }, + }); + +##### Angular + + + + + + + + import { Dx{WidgetName}Module, type Dx{WidgetName}Types } from 'devextreme-angular/ui/{widget-name}'; + import { locale } from "devextreme/localization"; + + export class AppComponent { + currentLocale = locale(); + customizeResponseTitle = (status, commandNames) => { + switch (this.currentLocale) { + case 'en': + return `${status.toUpperCase()}: ${commandNames.join(', ')}`; + case 'fr': + return /* Translated texts */; + } + }; + } + +##### Vue + + + + + + + + + + +##### React + + + import { {WidgetName}, AIAssistant, type {WidgetName}Types } from 'devextreme-react/{widget-name}'; + import { locale } from "devextreme/localization"; + + const currentLocale = locale(); + function customizeResponseTitle(status, commandNames) { + switch (currentLocale) { + case 'en': + return `${status.toUpperCase()}: ${commandNames.join(', ')}`; + case 'fr': + return /* Translated texts */; + } + }; + + function App() { + return ( + <{WidgetName}> + + {WidgetName}> + ); + }; --- - \ No newline at end of file diff --git a/api-reference/40 Common Types/15 grids/AIAssistant/popup.md b/api-reference/40 Common Types/15 grids/AIAssistant/popup.md index 12a4e81999..1ac3199055 100644 --- a/api-reference/40 Common Types/15 grids/AIAssistant/popup.md +++ b/api-reference/40 Common Types/15 grids/AIAssistant/popup.md @@ -15,6 +15,8 @@ We do not recommend that you specify the following Popup options: - [contentTemplate](/api-reference/10%20UI%20Components/dxOverlay/1%20Configuration/contentTemplate.md '/Documentation/ApiReference/UI_Components/dxPopup/Configuration/#contentTemplate') - [fullScreen](/api-reference/10%20UI%20Components/dxPopup/1%20Configuration/fullScreen.md '/Documentation/ApiReference/UI_Components/dxPopup/Configuration/#fullScreen') +- [onHidden](/Documentation/ApiReference/UI_Components/dxPopup/Configuration/#onHidden) +- [onShowing](/Documentation/ApiReference/UI_Components/dxPopup/Configuration/#onShowing) - [showTitle](/api-reference/10%20UI%20Components/dxPopup/1%20Configuration/showTitle.md '/Documentation/ApiReference/UI_Components/dxPopup/Configuration/#showTitle') - [toolbarItems](/api-reference/10%20UI%20Components/dxPopup/1%20Configuration/toolbarItems '/Documentation/ApiReference/UI_Components/dxPopup/Configuration/toolbarItems/') diff --git a/api-reference/40 Common Types/15 grids/BasicFilterExprObj/BasicFilterExprObj.md b/api-reference/40 Common Types/15 grids/BasicFilterExprObj/BasicFilterExprObj.md new file mode 100644 index 0000000000..be6ea05a22 --- /dev/null +++ b/api-reference/40 Common Types/15 grids/BasicFilterExprObj/BasicFilterExprObj.md @@ -0,0 +1,21 @@ +--- +id: BasicFilterExprObj +module: common/grids +export: BasicFilterExprObj +type: Object +--- +--- +##### shortDescription +A basic DataGrid/TreeList filter expression. + +--- +This object includes the following fields: + +- **type**: The expression type. Set to *"basic"*. +- **field**: The filtered data field. +- **operator**: A [SearchOperation](/Documentation/ApiReference/Common_Types/data/#SearchOperation) comparison operator. +- **value**: The comparison value. Can be one of the following types: + - `string` + - `number` + - `boolean` + - `null` diff --git a/api-reference/40 Common Types/15 grids/CombinedFilterExprObj/CombinedFilterExprObj.md b/api-reference/40 Common Types/15 grids/CombinedFilterExprObj/CombinedFilterExprObj.md new file mode 100644 index 0000000000..1bc7f78296 --- /dev/null +++ b/api-reference/40 Common Types/15 grids/CombinedFilterExprObj/CombinedFilterExprObj.md @@ -0,0 +1,17 @@ +--- +id: CombinedFilterExprObj +module: common/grids +export: CombinedFilterExprObj +type: Object +--- +--- +##### shortDescription +A combined DataGrid/TreeList filter expression. + +--- +This object includes the following fields: + +- **type**: The expression type. Set to *"combined"*. +- **left**: The first filter expression. +- **combiner**: The combination operation. Accepted values: *"and"*, *"or"*. +- **right**: The second filter expression. \ No newline at end of file diff --git a/api-reference/40 Common Types/15 grids/CommandInfo/CommandInfo.md b/api-reference/40 Common Types/15 grids/CommandInfo/CommandInfo.md new file mode 100644 index 0000000000..4f922f78ff --- /dev/null +++ b/api-reference/40 Common Types/15 grids/CommandInfo/CommandInfo.md @@ -0,0 +1,16 @@ +--- +id: CommandInfo +module: common/grids +export: CommandInfo +type: any +generateTypeLink: +--- +--- +##### shortDescription +Information about a predefined DataGrid/TreeList command. + +--- +**CommandInfo** contains the following fields: + +- **name**: The predefined command's name ([PredefinedCommandNames]({basewidgetpath}/PredefinedCommandNames/)). +- **args**: Command arguments. Refer to [PredefinedCommands]({basewidgetpath}/PredefinedCommands/) for information about the arguments of each available command. diff --git a/api-reference/40 Common Types/15 grids/CompositeKeyPair/CompositeKeyPair.md b/api-reference/40 Common Types/15 grids/CompositeKeyPair/CompositeKeyPair.md new file mode 100644 index 0000000000..b9ad236db4 --- /dev/null +++ b/api-reference/40 Common Types/15 grids/CompositeKeyPair/CompositeKeyPair.md @@ -0,0 +1,15 @@ +--- +id: CompositeKeyPair +module: common/grids +export: CompositeKeyPair +type: Object +--- +--- +##### shortDescription +A field/value pair used in composite DataGrid/TreeList keys. + +--- +This object includes the following fields: + +- **field**: The key field's name. +- **value**: The key field's value. Can be a `string` or `number`. \ No newline at end of file diff --git a/api-reference/40 Common Types/15 grids/FilterExprObj/FilterExprObj.md b/api-reference/40 Common Types/15 grids/FilterExprObj/FilterExprObj.md new file mode 100644 index 0000000000..5caf4812e5 --- /dev/null +++ b/api-reference/40 Common Types/15 grids/FilterExprObj/FilterExprObj.md @@ -0,0 +1,16 @@ +--- +id: FilterExprObj +module: common/grids +export: FilterExprObj +type: BasicFilterExprObj | CombinedFilterExprObj | NegatedFilterExprObj +--- +--- +##### shortDescription +A DataGrid/TreeList filter expression. + +--- +**FilterExprObj** is a union of multiple types that changes based on the represented filter expression. Refer to the following topics for additional information: + +- [BasicFilterExprObj]({basewidgetpath}/BasicFilterExprObj/) +- [CombinedFilterExprObj]({basewidgetpath}/CombinedFilterExprObj/) +- [NegatedFilterExprObj]({basewidgetpath}/NegatedFilterExprObj/) \ No newline at end of file diff --git a/api-reference/40 Common Types/15 grids/NegatedFilterExprObj/NegatedFilterExprObj.md b/api-reference/40 Common Types/15 grids/NegatedFilterExprObj/NegatedFilterExprObj.md new file mode 100644 index 0000000000..ac391c35ad --- /dev/null +++ b/api-reference/40 Common Types/15 grids/NegatedFilterExprObj/NegatedFilterExprObj.md @@ -0,0 +1,15 @@ +--- +id: NegatedFilterExprObj +module: common/grids +export: NegatedFilterExprObj +type: Object +--- +--- +##### shortDescription +A negated ([unary NOT](/Documentation/Guide/Data_Binding/Data_Layer/#Reading_Data/Filtering/Unary_Filter_Operation)) DataGrid/TreeList filter expression. + +--- +This object includes the following fields: + +- **type**: The expression type. Set to *"negated"*. +- **expression**: A filter expression ([FilterExprObj]({basewidgetpath}/FilterExprObj/)) to negate. \ No newline at end of file diff --git a/api-reference/40 Common Types/15 grids/PredefinedCommandNames/PredefinedCommandNames.md b/api-reference/40 Common Types/15 grids/PredefinedCommandNames/PredefinedCommandNames.md new file mode 100644 index 0000000000..89c1107929 --- /dev/null +++ b/api-reference/40 Common Types/15 grids/PredefinedCommandNames/PredefinedCommandNames.md @@ -0,0 +1,35 @@ +--- +id: PredefinedCommandNames +module: common/grids +export: PredefinedCommandNames +type: String +--- +--- +##### shortDescription +Names of predefined commands available in the DevExtreme DataGrid and TreeList. + +--- +The following commands are available: + +- **columnsVisibility** +- **columnsReorder** +- **columnsPinning** +- **columnsResize** +- **filterValue** +- **clearFilter** +- **focusRowByKey** +- **focusRowByIndex** +- **paging** +- **pageSize** +- **pageIndex** +- **searching** +- **selectByKeys** +- **selectByIndexes** +- **selectAll** +- **deselectAll** +- **clearSelection** +- **sorting** +- **clearSorting** + +#####See Also##### +- [PredefinedCommands]({basewidgetpath}/PredefinedCommands) \ No newline at end of file diff --git a/api-reference/40 Common Types/15 grids/PredefinedCommands/PredefinedCommands.md b/api-reference/40 Common Types/15 grids/PredefinedCommands/PredefinedCommands.md new file mode 100644 index 0000000000..8b3da0d331 --- /dev/null +++ b/api-reference/40 Common Types/15 grids/PredefinedCommands/PredefinedCommands.md @@ -0,0 +1,67 @@ +--- +id: PredefinedCommands +module: common/grids +export: PredefinedCommands +type: Object +--- +--- +##### shortDescription +Predefined commands available in the DevExtreme DataGrid and TreeList. + +--- +The following code snippet lists available commands with their arguments: + + columnsVisibility: { + dataField: string; + visible: boolean; + }; + columnsReorder: { + dataField: string; + visibleIndex: number; + }; + columnsPinning: { + dataField: string; + fixed: boolean; + fixedPosition?: 'left' | 'right'; + }; + columnsResize: { + dataField: string; + width: number | string; + }; + filterValue: { + expression: FilterExprObj | null; + }; + clearFilter: {}; + focusRowByKey: { + key: string | number | Array; + }; + focusRowByIndex: { + index: number; + }; + paging: { + enabled: boolean; + }; + pageSize: { + pageSize: number; + }; + pageIndex: { + pageIndex: number; + }; + searching: { + text: string; + }; + selectByKeys: { + keys: Array>; + preserve: boolean; + }; + selectByIndexes: { + indexes: number[]; + }; + selectAll: {}; + deselectAll: {}; + clearSelection: {}; + sorting: { + dataField: string; + sortOrder: SortOrder | 'none'; + }; + clearSorting: {}; diff --git a/api-reference/_hidden/Enums/ResponseStatus.md b/api-reference/40 Common Types/15 grids/ResponseStatus.md similarity index 81% rename from api-reference/_hidden/Enums/ResponseStatus.md rename to api-reference/40 Common Types/15 grids/ResponseStatus.md index dbe9d96592..75938aadeb 100644 --- a/api-reference/_hidden/Enums/ResponseStatus.md +++ b/api-reference/40 Common Types/15 grids/ResponseStatus.md @@ -3,10 +3,11 @@ id: Enums.ResponseStatus acceptValues: 'success' | 'failure' type: Union references: AIAssistant.customizeResponseTitle +generateTypeLink: --- --- ##### shortDescription - +The AI response status. --- \ No newline at end of file diff --git a/api-reference/NewTopics/ResponseStatusTexts/ResponseStatusTexts.md b/api-reference/40 Common Types/15 grids/ResponseStatusTexts/ResponseStatusTexts.md similarity index 51% rename from api-reference/NewTopics/ResponseStatusTexts/ResponseStatusTexts.md rename to api-reference/40 Common Types/15 grids/ResponseStatusTexts/ResponseStatusTexts.md index bec3409a7f..e24984c6a4 100644 --- a/api-reference/NewTopics/ResponseStatusTexts/ResponseStatusTexts.md +++ b/api-reference/40 Common Types/15 grids/ResponseStatusTexts/ResponseStatusTexts.md @@ -3,10 +3,11 @@ id: ResponseStatusTexts module: common/grids export: ResponseStatusTexts type: Object +generateTypeLink: --- --- ##### shortDescription - +Response texts for each status. --- - \ No newline at end of file +This object can contain two string values: `success` and `failure`. \ No newline at end of file diff --git a/api-reference/NewTopics/BasicFilterExprObj/BasicFilterExprObj.md b/api-reference/NewTopics/BasicFilterExprObj/BasicFilterExprObj.md deleted file mode 100644 index 43169caa9b..0000000000 --- a/api-reference/NewTopics/BasicFilterExprObj/BasicFilterExprObj.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: BasicFilterExprObj -module: common/grids -export: BasicFilterExprObj -type: Object ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/CombinedFilterExprObj/CombinedFilterExprObj.md b/api-reference/NewTopics/CombinedFilterExprObj/CombinedFilterExprObj.md deleted file mode 100644 index 1a19ec7d1b..0000000000 --- a/api-reference/NewTopics/CombinedFilterExprObj/CombinedFilterExprObj.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: CombinedFilterExprObj -module: common/grids -export: CombinedFilterExprObj -type: Object ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/CommandInfo/CommandInfo.md b/api-reference/NewTopics/CommandInfo/CommandInfo.md deleted file mode 100644 index c52f8db071..0000000000 --- a/api-reference/NewTopics/CommandInfo/CommandInfo.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: CommandInfo -module: common/grids -export: CommandInfo -type: any ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/CompositeKeyPair/CompositeKeyPair.md b/api-reference/NewTopics/CompositeKeyPair/CompositeKeyPair.md deleted file mode 100644 index 1439cb7cf2..0000000000 --- a/api-reference/NewTopics/CompositeKeyPair/CompositeKeyPair.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: CompositeKeyPair -module: common/grids -export: CompositeKeyPair -type: Object ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/DataGridCommandInfo/DataGridCommandInfo.md b/api-reference/NewTopics/DataGridCommandInfo/DataGridCommandInfo.md deleted file mode 100644 index b698616711..0000000000 --- a/api-reference/NewTopics/DataGridCommandInfo/DataGridCommandInfo.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: DataGridCommandInfo -module: ui/data_grid -export: DataGridCommandInfo -type: CommandInfo ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/DataGridPredefinedCommandNames/DataGridPredefinedCommandNames.md b/api-reference/NewTopics/DataGridPredefinedCommandNames/DataGridPredefinedCommandNames.md deleted file mode 100644 index ddb8daeb66..0000000000 --- a/api-reference/NewTopics/DataGridPredefinedCommandNames/DataGridPredefinedCommandNames.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: DataGridPredefinedCommandNames -module: ui/data_grid -export: DataGridPredefinedCommandNames -type: String ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/DataGridPredefinedCommands/DataGridPredefinedCommands.md b/api-reference/NewTopics/DataGridPredefinedCommands/DataGridPredefinedCommands.md deleted file mode 100644 index 05d93d82ba..0000000000 --- a/api-reference/NewTopics/DataGridPredefinedCommands/DataGridPredefinedCommands.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: DataGridPredefinedCommands -module: ui/data_grid -export: DataGridPredefinedCommands -type: PredefinedCommands | Object -inherits: PredefinedCommands ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/FilterExprObj/FilterExprObj.md b/api-reference/NewTopics/FilterExprObj/FilterExprObj.md deleted file mode 100644 index 8ee77beef7..0000000000 --- a/api-reference/NewTopics/FilterExprObj/FilterExprObj.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: FilterExprObj -module: common/grids -export: FilterExprObj -type: BasicFilterExprObj | CombinedFilterExprObj | NegatedFilterExprObj ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/NegatedFilterExprObj/NegatedFilterExprObj.md b/api-reference/NewTopics/NegatedFilterExprObj/NegatedFilterExprObj.md deleted file mode 100644 index 669f314ee5..0000000000 --- a/api-reference/NewTopics/NegatedFilterExprObj/NegatedFilterExprObj.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: NegatedFilterExprObj -module: common/grids -export: NegatedFilterExprObj -type: Object ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/PredefinedCommandNames/PredefinedCommandNames.md b/api-reference/NewTopics/PredefinedCommandNames/PredefinedCommandNames.md deleted file mode 100644 index dfd343b63a..0000000000 --- a/api-reference/NewTopics/PredefinedCommandNames/PredefinedCommandNames.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: PredefinedCommandNames -module: common/grids -export: PredefinedCommandNames -type: String ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/PredefinedCommands/PredefinedCommands.md b/api-reference/NewTopics/PredefinedCommands/PredefinedCommands.md deleted file mode 100644 index 4efcc31424..0000000000 --- a/api-reference/NewTopics/PredefinedCommands/PredefinedCommands.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: PredefinedCommands -module: common/grids -export: PredefinedCommands -type: Object ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/SummaryCommandGroupItem/SummaryCommandGroupItem.md b/api-reference/NewTopics/SummaryCommandGroupItem/SummaryCommandGroupItem.md deleted file mode 100644 index 2d97e326e9..0000000000 --- a/api-reference/NewTopics/SummaryCommandGroupItem/SummaryCommandGroupItem.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: SummaryCommandGroupItem -module: ui/data_grid -export: SummaryCommandGroupItem -acceptValues: 'showInColumn' | 'displayFormat' | 'showInGroupFooter' | 'alignByColumn' -type: Pick | Object ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/api-reference/NewTopics/SummaryCommandTotalItem/SummaryCommandTotalItem.md b/api-reference/NewTopics/SummaryCommandTotalItem/SummaryCommandTotalItem.md deleted file mode 100644 index 683dac22b3..0000000000 --- a/api-reference/NewTopics/SummaryCommandTotalItem/SummaryCommandTotalItem.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: SummaryCommandTotalItem -module: ui/data_grid -export: SummaryCommandTotalItem -acceptValues: 'showInColumn' | 'displayFormat' -type: Pick | Object ---- ---- -##### shortDescription - - ---- - \ No newline at end of file diff --git a/images/DataGrid/icons/aiAssistantButton.png b/images/DataGrid/icons/aiAssistantButton.png new file mode 100644 index 0000000000..c51d5e0d05 Binary files /dev/null and b/images/DataGrid/icons/aiAssistantButton.png differ diff --git a/includes/grids-toolbar.md b/includes/grids-toolbar.md index 87e577c75e..fc5482fe90 100644 --- a/includes/grids-toolbar.md +++ b/includes/grids-toolbar.md @@ -9,6 +9,11 @@ Predefined controls appear on the toolbar depending on whether a specific {Widge Image Prerequisites + + aiAssistantButton + + aiIntegration or aiAssistant.aiIntegration is configured and aiAssistant.enabled is true + addRowButton