Skip to content

Commit 4ccc6e4

Browse files
authored
DocGen 26_1 result (#8806)
1 parent 35bf208 commit 4ccc6e4

48 files changed

Lines changed: 147 additions & 70 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

api-reference/10 UI Components/Errors and Warnings/E1049.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: ErrorsUIWidgets.E1049
33
---
44
---
55
##### shortDescription
6-
Occurs in the TreeList or DataGrid when [filterSyncEnabled](/api-reference/10%20UI%20Components/GridBase/1%20Configuration/filterSyncEnabled.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#filterSyncEnabled') is **true** and the **columns[]**.[dataField](/api-reference/_hidden/GridBaseColumn/dataField.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#dataField') or **columns[]**.[name](/api-reference/_hidden/GridBaseColumn/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name') property is not specified in at least one column that allows filter operations.
6+
Occurs in the TreeList or DataGrid when [filterSyncEnabled](/api-reference/10%20UI%20Components/GridBase/1%20Configuration/filterSyncEnabled.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/#filterSyncEnabled') is **true** and the **columns[]**.[dataField](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/dataField.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#dataField') or **columns[]**.[name](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name') property is not specified in at least one column that allows filter operations.
77

88
---
99
Check that all columns that allow filter operations have the **dataField** or **name** property specified.

api-reference/10 UI Components/Errors and Warnings/E1059.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: ErrorsUIWidgets.E1059
33
---
44
---
55
##### shortDescription
6-
Occurs in a DataGrid or TreeList when at least one of its columns has a non-unique value assigned to the [name](/api-reference/_hidden/GridBaseColumn/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name') property.
6+
Occurs in a DataGrid or TreeList when at least one of its columns has a non-unique value assigned to the [name](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name') property.
77

88
---
99
Check that the **name** property has a unique value for all the columns.

api-reference/10 UI Components/Errors and Warnings/E1060.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: ErrorsUIWidgets.E1060
33
---
44
---
55
##### shortDescription
6-
Occurs in a DataGrid or TreeList when at least one of its editable columns does not have a [name](/api-reference/_hidden/GridBaseColumn/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name').
6+
Occurs in a DataGrid or TreeList when at least one of its editable columns does not have a [name](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name').
77

88
---
99
Check that the **name** property is specified for all editable columns.

api-reference/10 UI Components/Errors and Warnings/E1066.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ id: ErrorsUIWidgets.E1066
66
Occurs in [DataGrid](/concepts/05%20UI%20Components/DataGrid/03%20Overview/00%20Overview.md '/Documentation/Guide/UI_Components/DataGrid/Overview/') and [TreeList](/concepts/05%20UI%20Components/TreeList/02%20Overview/00%20Overview.md '/Documentation/Guide/UI_Components/TreeList/Overview/') when a **name** is not specified for an AI column.
77

88
---
9-
To resolve this error, specify unique [names](/api-reference/_hidden/GridBaseColumn/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name') for DataGrid and TreeList AI columns.
9+
To resolve this error, specify unique [names](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name') for DataGrid and TreeList AI columns.

api-reference/10 UI Components/GridBase/1 Configuration/aiIntegration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ The DevExtreme {WidgetName} ships with the following AI features:
1313
- AI Columns
1414
- AI Assistant
1515

16-
To activate these AI features, configure **aiIntegration** and specify {WidgetName} properties as follows:
16+
To activate these AI features, configure **aiIntegration** and specify {WidgetName} properties as follows:
1717

1818
- Assign *"ai"* to a column's [type](/api-reference/_hidden/dxDataGridColumn/type.md '{basewidgetpath}/Configuration/columns/#type') property to implement an AI Column.
19-
- Set **aiAssistant**.[enabled]({basewidgetpath}/Configuration/aiAssistant/#enabled) to `true` to activate the AI Assistant.
19+
- Set **aiAssistant**.[enabled](/api-reference/40%20Common%20Types/15%20grids/AIAssistant/enabled.md '{basewidgetpath}/Configuration/aiAssistant/#enabled') to `true` to activate the AI Assistant.
2020

21-
This object stores shared AI options for the {WidgetName} AI Assistant and all AI columns within the component. To configure AI options specific to a column, define **columns[]**.**ai**.[aiIntegration](/api-reference/40%20Common%20Types/15%20grids/ColumnAIOptions/aiIntegration.md '{basewidgetpath}/Configuration/columns/ai/#aiIntegration'). To configure AI options specific to the AI Assistant, define **aiAssistant**.[aiIntegration]({basewidgetpath}/Configuration/aiAssistant/#aiIntegration).
21+
This object stores shared AI options for the {WidgetName} AI Assistant and all AI columns within the component. To configure AI options specific to a column, define **columns[]**.**ai**.[aiIntegration](/api-reference/40%20Common%20Types/15%20grids/ColumnAIOptions/aiIntegration.md '{basewidgetpath}/Configuration/columns/ai/#aiIntegration'). To configure AI options specific to the AI Assistant, define **aiAssistant**.[aiIntegration](/api-reference/40%20Common%20Types/15%20grids/AIAssistant/aiIntegration.md '{basewidgetpath}/Configuration/aiAssistant/#aiIntegration').
2222

2323
#include common-demobutton-named with {
2424
url: "https://js.devexpress.com/Demos/WidgetsGallery/Demo/DataGrid/AIColumns/",

api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseText.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ When a command succeeds, the AI Assistant chat displays the response in green an
1919

2020
The **command** parameter contains the following fields:
2121

22-
- **name**: The command's name ([DataGridPredefinedCommandNames]({basewidgetpath}/Types/DataGridPredefinedCommandNames/)).
23-
- **args**: Command arguments. Refer to [DataGridPredefinedCommands]({basewidgetpath}/Types/DataGridPredefinedCommands/) for information about the arguments of each available command.
22+
- **name**: The command's name ([DataGridPredefinedCommandNames](/api-reference/10%20UI%20Components/dxDataGrid/9%20Types/DataGridPredefinedCommandNames '{basewidgetpath}/Types/DataGridPredefinedCommandNames/')).
23+
- **args**: Command arguments. Refer to [DataGridPredefinedCommands](/api-reference/10%20UI%20Components/dxDataGrid/9%20Types/DataGridPredefinedCommands '{basewidgetpath}/Types/DataGridPredefinedCommands/') for information about the arguments of each available command.
2424

2525
Configure **customizeResponseText** to return an object with the following fields:
2626

@@ -29,7 +29,7 @@ Configure **customizeResponseText** to return an object with the following field
2929

3030
If you do not specify any of these fields, the AI Assistant chat displays the default message.
3131

32-
You can use this function to localize response text. The following code snippet uses the [locale()](/Documentation/ApiReference/Common/Utils/localization/#locale) method to specify text for multiple locales:
32+
You can use this function to localize response text. The following code snippet uses the [locale()](/api-reference/50%20Common/utils/localization/locale().md '/Documentation/ApiReference/Common/Utils/localization/#locale') method to specify text for multiple locales:
3333

3434
---
3535

api-reference/10 UI Components/dxDataGrid/1 Configuration/aiAssistant/customizeResponseTitle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Customizes AI Assistant response titles.
1010
The response status. If a response describes multiple commands, this parameter equals *"success"* only if all commands succeed.
1111

1212
##### param(commandNames): Array<String>
13-
An array of commands ([DataGridPredefinedCommandNames]({basewidgetpath}/Types/DataGridPredefinedCommandNames/)).
13+
An array of commands ([DataGridPredefinedCommandNames](/api-reference/10%20UI%20Components/dxDataGrid/9%20Types/DataGridPredefinedCommandNames '{basewidgetpath}/Types/DataGridPredefinedCommandNames/')).
1414

1515
##### return: String
1616
The custom response title.
@@ -111,7 +111,7 @@ Use this function to customize the titles of AI Assistant response messages. The
111111

112112
---
113113

114-
You can use this function to translate response titles. The following code snippet uses the [locale()](/Documentation/ApiReference/Common/Utils/localization/#locale) method to specify titles for multiple locales:
114+
You can use this function to translate response titles. The following code snippet uses the [locale()](/api-reference/50%20Common/utils/localization/locale().md '/Documentation/ApiReference/Common/Utils/localization/#locale') method to specify titles for multiple locales:
115115

116116
---
117117

api-reference/10 UI Components/dxDataGrid/1 Configuration/columns/dataField.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,13 +96,13 @@ The following code snippet configures six columns:
9696

9797
Review the following notes about data binding:
9898

99-
- If you create an unbound column (use the [calculateCellValue](/api-reference/_hidden/GridBaseColumn/calculateCellValue.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#calculateCellValue') function), specify the **columns[]**.[name](/api-reference/_hidden/GridBaseColumn/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name') property instead of **dataField**.
99+
- If you create an unbound column (use the [calculateCellValue](/api-reference/_hidden/GridBaseColumn/calculateCellValue.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#calculateCellValue') function), specify the **columns[]**.[name](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name') property instead of **dataField**.
100100

101101
- Data field names cannot be `this` or contain the following characters: `.`, `:`, `[`, and `]`.
102102

103103
- The column caption is generated from the **dataField** value. If you want to use a custom caption, specify it in the [caption](/api-reference/_hidden/GridBaseColumn/caption.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#caption') property. Unlike **dataField**, **caption** can contain any characters.
104104

105-
- [Grouping](/Documentation/Guide/UI_Components/DataGrid/Grouping/#API) operations use **dataField** values as unique column identifiers (instead of [name]({basewidgetpath}/Configuration/columns/#name) values).
105+
- [Grouping](/concepts/05%20UI%20Components/DataGrid/45%20Grouping/20%20API '/Documentation/Guide/UI_Components/DataGrid/Grouping/#API') operations use **dataField** values as unique column identifiers (instead of [name](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/name.md '{basewidgetpath}/Configuration/columns/#name') values).
106106

107107
[/note]
108108

api-reference/10 UI Components/dxDataGrid/1 Configuration/columns/name.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ default: undefined
55
---
66
---
77
##### shortDescription
8-
Specifies the column's unique identifier. If undefined, this value is inherited from the column's [dataField](/api-reference/_hidden/GridBaseColumn/dataField.md '{basewidgetpath}/Configuration/columns/#dataField') property.
8+
Specifies the column's unique identifier. If undefined, this value is inherited from the column's [dataField](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/dataField.md '{basewidgetpath}/Configuration/columns/#dataField') property.
99

1010
---
1111

1212
Use the **name** value to modify column settings at runtime (for instance, using the [columnOption()](/api-reference/10%20UI%20Components/GridBase/3%20Methods/columnOption(id_optionName_optionValue).md '{basewidgetpath}/Methods/#columnOptionid_optionName_optionValue') method).
1313

1414
[note]
1515

16-
[Grouping](/Documentation/Guide/UI_Components/DataGrid/Grouping/#API) operations do not use **name** values as unique column identifiers. The following properties are used instead:
16+
[Grouping](/concepts/05%20UI%20Components/DataGrid/45%20Grouping/20%20API '/Documentation/Guide/UI_Components/DataGrid/Grouping/#API') operations do not use **name** values as unique column identifiers. The following properties are used instead:
1717

18-
- [dataField]({basewidgetpath}/Configuration/columns/#dataField)
19-
- [calculateDisplayValue]({basewidgetpath}/Configuration/columns/#calculateDisplayValue)
20-
- [calculateCellValue]({basewidgetpath}/Configuration/columns/#calculateCellValue)
21-
- [calculateGroupValue]({basewidgetpath}/Configuration/columns/#calculateGroupValue)
18+
- [dataField](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/dataField.md '{basewidgetpath}/Configuration/columns/#dataField')
19+
- [calculateDisplayValue](/api-reference/_hidden/GridBaseColumn/calculateDisplayValue.md '{basewidgetpath}/Configuration/columns/#calculateDisplayValue')
20+
- [calculateCellValue](/api-reference/_hidden/GridBaseColumn/calculateCellValue.md '{basewidgetpath}/Configuration/columns/#calculateCellValue')
21+
- [calculateGroupValue](/api-reference/_hidden/dxDataGridColumn/calculateGroupValue.md '{basewidgetpath}/Configuration/columns/#calculateGroupValue')
2222

2323
[/note]

api-reference/10 UI Components/dxDataGrid/1 Configuration/sortByGroupSummaryInfo/groupColumn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ id: dxDataGrid.Options.sortByGroupSummaryInfo.groupColumn
66
Specifies the identifier of the column that must be used in [grouping](/concepts/05%20UI%20Components/DataGrid/45%20Grouping '/Documentation/Guide/UI_Components/DataGrid/Grouping/') so that sorting by [group summary item values](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/summary/groupItems '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/summary/groupItems/') be applied.
77

88
---
9-
Sorting by group summary item values applies only when grid records are grouped by a specific column. To define this column, assign its [name](/api-reference/_hidden/GridBaseColumn/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name'), [data field](/api-reference/_hidden/GridBaseColumn/dataField.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#dataField') or [caption](/api-reference/_hidden/GridBaseColumn/caption.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#caption') to the **groupColumn** property. If you omit this property when declaring an object of the **sortByGroupSummaryInfo** array, the sorting setting will be applied when any column is used in grouping.
9+
Sorting by group summary item values applies only when grid records are grouped by a specific column. To define this column, assign its [name](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/name.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#name'), [data field](/api-reference/10%20UI%20Components/dxDataGrid/1%20Configuration/columns/dataField.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#dataField') or [caption](/api-reference/_hidden/GridBaseColumn/caption.md '/Documentation/ApiReference/UI_Components/dxDataGrid/Configuration/columns/#caption') to the **groupColumn** property. If you omit this property when declaring an object of the **sortByGroupSummaryInfo** array, the sorting setting will be applied when any column is used in grouping.
1010

1111
#####See Also#####
1212
- [Sort by Group Summary](/concepts/05%20UI%20Components/DataGrid/65%20Summaries/20%20Group%20Summary/15%20Sort%20by%20Group%20Summary.md '/Documentation/Guide/UI_Components/DataGrid/Summaries/Group_Summary/#Sort_by_Group_Summary')

0 commit comments

Comments
 (0)