Merge remote-tracking branch 'upstream/24_2' into pagination-overview…

…24_2
vladaskorohodova · Dec 13, 2024 · 63d6e51 · 63d6e51
2 parents 1b2f827 + 300b646
commit 63d6e51
Show file tree

Hide file tree

Showing 188 changed files with 1,063 additions and 360 deletions.
diff --git a/MenuConfig.xml b/MenuConfig.xml
@@ -104,11 +104,9 @@
   <MenuRule Destination="10 UI Components/dxFloating Action Button/3 SpeedDialAction API" SourcePattern="ApiReference:^10 UI Components/dxSpeedDialAction" />
   <MenuRule Destination="10 UI Components/dx$1/3 API" SourcePattern="ApiReference:^10 UI Components/dx([a-zA-Z]+)" />
   <MenuRule Destination="10 UI Components/dx$1/4 Demos" SourcePattern="Howto:^05 UI Components/([a-zA-Z]+)/Demos" />
-  <MenuRule Destination="10 UI Components/dxDiagram/0 Overview" SourcePattern="Howto:^05 UI Components/Diagram/05 Add the Diagram Component to an Angular CLI Application" VisibleFor="Angular"/>
   <MenuRule Destination="10 UI Components/dx$1/0 Overview" SourcePattern="Howto:^05 UI Components/([a-zA-Z]+)/[0-9]+ Overview" />
   <MenuRule Destination="10 UI Components/dx$1/0 Overview" SourcePattern="Howto:^05 UI Components/([a-zA-Z]+)/[0-9]+ Visual Elements" />
   <MenuRule Destination="10 UI Components/dx$1/1 Getting Started" SourcePattern="Howto:^05 UI Components/(Drawer|FileManager|Floating Action Button)/[0-9]* Getting Started with (File Manager|Navigation Drawer|Floating Action Button)" />
-  <MenuRule Destination="10 UI Components/dxDiagram/1 Getting Started" SourcePattern="Howto:^05 UI Components/Diagram/00 Getting Started with Diagram" VisibleFor="jQuery"/>
   <MenuRule Destination="10 UI Components/dx$1/1 Getting Started" SourcePattern="Howto:^05 UI Components/([a-zA-Z]+)/[0-9]+ Getting Started with ([a-zA-Z]+)" />
   <MenuRule Destination="10 UI Components/dx$1/5 Accessibility" SourcePattern="Howto:^05 UI Components/([a-zA-Z]+)/[0-9]+ Accessibility" />
   <MenuRule Destination="" SourcePattern="Howto:^05 UI Components/(Accordion|BarGauge|Bullet|ButtonGroup|Chat|CheckBox|CircularGauge|Drawer|DropDownButton|Floating Action Button|LinearGauge|NavBar|Pagination|Resizable|SlideOut|SlideOutView|TabPanel|Tabs|Toolbar|TreeMap|zz Common)" />

diff --git a/api-reference/10 UI Components/DataHelperMixin/DataHelperMixin.md b/api-reference/10 UI Components/DataHelperMixin/DataHelperMixin.md
@@ -1,7 +1,7 @@
 ---
 id: DataHelperMixin
 module: data_helper
-export: default
+export: DataHelperMixin
 hidden: 
 ---
 ---

diff --git a/...ence/10 UI Components/GridBase/3 Methods/cellValue(rowIndex_dataField_value).md b/...ence/10 UI Components/GridBase/3 Methods/cellValue(rowIndex_dataField_value).md
@@ -15,6 +15,8 @@ The [data field](/api-reference/_hidden/GridBaseColumn/dataField.md '{basewidget
 The cell's new value.
 
 ---
+{WidgetName} re-renders the entire row or edit form after the **cellValue** method changes a cell value. To re-render only the modified cell or form item editor, enable [repaintChangesOnly]({basewidgetpath}/Configuration/#repaintChangesOnly).
+
 Call [saveEditData()](/api-reference/10%20UI%20Components/GridBase/3%20Methods/saveEditData().md '{basewidgetpath}/Methods/#saveEditData') after this method to save the changes:
 
 ---

diff --git a/api-reference/10 UI Components/dxGantt/9 Types/GanttPdfExportDateRange.md b/api-reference/10 UI Components/dxGantt/9 Types/GanttPdfExportDateRange.md
@@ -2,7 +2,7 @@
 id: Enums.GanttPdfExportDateRange
 acceptValues: 'all' | 'visible'
 type: Union
-references: PdfExportGanttProps.dateRange
+references: GanttExport.Options.dateRange
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/10 UI Components/dxGantt/9 Types/GanttPdfExportMode.md b/api-reference/10 UI Components/dxGantt/9 Types/GanttPdfExportMode.md
@@ -2,7 +2,7 @@
 id: Enums.GanttPdfExportMode
 acceptValues: 'all' | 'treeList' | 'chart'
 type: Union
-references: PdfExportGanttProps.exportMode
+references: GanttExport.Options.exportMode
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/10 UI Components/dxPagination/1 Configuration/displayMode.md b/api-reference/10 UI Components/dxPagination/1 Configuration/displayMode.md
@@ -0,0 +1,10 @@
+---
+id: dxPagination.Options.displayMode
+type: Enums.DisplayMode
+default: 'adaptive'
+---
+---
+##### shortDescription
+Specifies the pager's display mode.
+
+---
diff --git a/api-reference/10 UI Components/dxPagination/1 Configuration/infoText.md b/api-reference/10 UI Components/dxPagination/1 Configuration/infoText.md
@@ -0,0 +1,10 @@
+---
+id: dxPagination.Options.infoText
+type: String
+default: 'Page {0} of {1} ({2} items)'
+---
+---
+##### shortDescription
+Specifies the page information text.
+
+---
diff --git a/api-reference/10 UI Components/dxPagination/1 Configuration/label.md b/api-reference/10 UI Components/dxPagination/1 Configuration/label.md
@@ -0,0 +1,10 @@
+---
+id: dxPagination.Options.label
+type: String
+default: 'Page Navigation'
+---
+---
+##### shortDescription
+Specifies an [aria-label](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label) attribute for the pager.
+
+---
diff --git a/api-reference/10 UI Components/dxPagination/1 Configuration/showInfo.md b/api-reference/10 UI Components/dxPagination/1 Configuration/showInfo.md
@@ -0,0 +1,10 @@
+---
+id: dxPagination.Options.showInfo
+type: Boolean
+default: false
+---
+---
+##### shortDescription
+Specifies whether to show the [page information](/api-reference/10%20UI%20Components/dxPagination/1%20Configuration/infoText.md '{basewidgetpath}/Configuration/#infoText').
+
+---
diff --git a/...eference/10 UI Components/dxPagination/1 Configuration/showNavigationButtons.md b/...eference/10 UI Components/dxPagination/1 Configuration/showNavigationButtons.md
@@ -0,0 +1,10 @@
+---
+id: dxPagination.Options.showNavigationButtons
+type: Boolean
+default: false
+---
+---
+##### shortDescription
+Specifies whether to show navigation buttons.
+
+---
diff --git a/...reference/10 UI Components/dxPagination/1 Configuration/showPageSizeSelector.md b/...reference/10 UI Components/dxPagination/1 Configuration/showPageSizeSelector.md
@@ -0,0 +1,10 @@
+---
+id: dxPagination.Options.showPageSizeSelector
+type: Boolean
+default: false
+---
+---
+##### shortDescription
+Specifies whether to show the page size selector.
+
+---
diff --git a/api-reference/10 UI Components/dxPivotGrid/1 Configuration/export/export.md b/api-reference/10 UI Components/dxPivotGrid/1 Configuration/export/export.md
@@ -165,7 +165,7 @@ The following instructions show how to enable and configure client-side export:
     ---
 
 3. **Export the PivotGrid**   
-    Implement the [onExporting](/api-reference/10%20UI%20Components/dxPivotGrid/1%20Configuration/onExporting.md '/Documentation/ApiReference/UI_Components/dxPivotGrid/Configuration/#onExporting') handler and call the [exportPivotGrid(options)](/api-reference/50%20Common/utils/excelExporter/exportPivotGrid(options).md '/Documentation/ApiReference/Common/Utils/excelExporter/#exportPivotGridoptions') method in it. In the code below, this method exports the PivotGrid as is, but you can use [ExcelExportPivotGridProps](/api-reference/50%20Common/Object%20Structures/ExcelExportPivotGridProps '/Documentation/ApiReference/Common/Object_Structures/ExcelExportPivotGridProps/') to configure export settings, including [cell customization](/api-reference/50%20Common/Object%20Structures/ExcelExportPivotGridProps/customizeCell.md '/Documentation/ApiReference/Common/Object_Structures/ExcelExportPivotGridProps/#customizeCell'). The PivotGrid is exported to an Excel worksheet that is created using the ExcelJS API. To save the Excel document, call the FileSaver's **saveAs** method.
+    Implement the [onExporting](/api-reference/10%20UI%20Components/dxPivotGrid/1%20Configuration/onExporting.md '/Documentation/ApiReference/UI_Components/dxPivotGrid/Configuration/#onExporting') handler and call the [exportPivotGrid(options)](/api-reference/50%20Common/utils/excelExporter/exportPivotGrid(options).md '/Documentation/ApiReference/Common/Utils/excelExporter/#exportPivotGridoptions') method in it. In the code below, this method exports the PivotGrid as is, but you can use [PivotGridExportOptions](/api-reference/50%20Common/Object%20Structures/PivotGridExportOptions '/Documentation/ApiReference/Common/Object_Structures/PivotGridExportOptions/') to configure export settings, including [cell customization](/api-reference/50%20Common/Object%20Structures/PivotGridExportOptions/customizeCell.md '/Documentation/ApiReference/Common/Object_Structures/PivotGridExportOptions/#customizeCell'). The PivotGrid is exported to an Excel worksheet that is created using the ExcelJS API. To save the Excel document, call the FileSaver's **saveAs** method.
 
     ---
     ##### jQuery

diff --git a/...0 UI Components/dxScheduler/7 Interfaces/SchedulerTimeZone/SchedulerTimeZone.md b/...0 UI Components/dxScheduler/7 Interfaces/SchedulerTimeZone/SchedulerTimeZone.md
@@ -0,0 +1,13 @@
+---
+id: SchedulerTimeZone
+module: common/core/environment
+export: SchedulerTimeZone
+type: Object
+generateTypeLink: 
+---
+---
+##### shortDescription
+A time zone object.
+
+---
+<!-- Description goes here -->
diff --git a/...er/7 Interfaces/dxSchedulerTimeZone/id.md → ...uler/7 Interfaces/SchedulerTimeZone/id.md b/...er/7 Interfaces/dxSchedulerTimeZone/id.md → ...uler/7 Interfaces/SchedulerTimeZone/id.md
@@ -1,5 +1,5 @@
 ---
-id: dxSchedulerTimeZone.id
+id: SchedulerTimeZone.id
 type: String
 ---
 ---

diff --git a/... Interfaces/dxSchedulerTimeZone/offset.md → .../7 Interfaces/SchedulerTimeZone/offset.md b/... Interfaces/dxSchedulerTimeZone/offset.md → .../7 Interfaces/SchedulerTimeZone/offset.md
@@ -1,5 +1,5 @@
 ---
-id: dxSchedulerTimeZone.offset
+id: SchedulerTimeZone.offset
 type: Number
 ---
 ---

diff --git a/...7 Interfaces/dxSchedulerTimeZone/title.md → ...r/7 Interfaces/SchedulerTimeZone/title.md b/...7 Interfaces/dxSchedulerTimeZone/title.md → ...r/7 Interfaces/SchedulerTimeZone/title.md
@@ -1,5 +1,5 @@
 ---
-id: dxSchedulerTimeZone.title
+id: SchedulerTimeZone.title
 type: String
 ---
 ---

diff --git a/... Components/dxScheduler/7 Interfaces/dxSchedulerTimeZone/dxSchedulerTimeZone.md b/... Components/dxScheduler/7 Interfaces/dxSchedulerTimeZone/dxSchedulerTimeZone.md
diff --git a/api-reference/10 UI Components/dxTreeView/1 Configuration/selectByClick.md b/api-reference/10 UI Components/dxTreeView/1 Configuration/selectByClick.md
@@ -8,6 +8,8 @@ default: false
 Specifies whether an item is selected if a user clicks it.
 
 ---
+Enable this property to select items with the Enter key when [selectionMode](/Documentation/ApiReference/UI_Components/dxTreeView/Configuration/#selectionMode) is set to *'none'*.
+
 #include btn-open-demo with {
     href: "https://js.devexpress.com/Demos/WidgetsGallery/Demo/TreeView/ItemSelectionAndCustomization/"
 }

diff --git a/api-reference/30 Data Layer/ArrayStore/ArrayStore.md b/api-reference/30 Data Layer/ArrayStore/ArrayStore.md
@@ -1,8 +1,8 @@
 ---
 id: ArrayStore
-module: data/array_store
-export: default
-inherits: Store
+module: common/data
+export: ArrayStore
+inheritsType: Store
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/30 Data Layer/CustomStore/CustomStore.md b/api-reference/30 Data Layer/CustomStore/CustomStore.md
@@ -1,7 +1,7 @@
 ---
 id: CustomStore
-module: data/custom_store
-export: default
+module: common/data
+export: CustomStore
 inherits: Store
 ---
 ---

diff --git a/api-reference/30 Data Layer/CustomStore/LoadOptions/LoadOptions.md b/api-reference/30 Data Layer/CustomStore/LoadOptions/LoadOptions.md
@@ -1,7 +1,7 @@
 ---
 id: LoadOptions
 type: Object
-module: data/index
+module: common/data
 export: Load_Options
 ---
 ---

diff --git a/api-reference/30 Data Layer/DataSource/1 Configuration/searchOperation.md b/api-reference/30 Data Layer/DataSource/1 Configuration/searchOperation.md
@@ -1,6 +1,6 @@
 ---
 id: DataSource.Options.searchOperation
-type: Enums.SearchOperation
+type: Object
 default: 'contains'
 ---
 ---

diff --git a/api-reference/30 Data Layer/DataSource/DataSource.md b/api-reference/30 Data Layer/DataSource/DataSource.md
@@ -1,7 +1,7 @@
 ---
 id: DataSource
-module: data/data_source
-export: default
+module: common/data
+export: DataSource
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/30 Data Layer/EdmLiteral/EdmLiteral.md b/api-reference/30 Data Layer/EdmLiteral/EdmLiteral.md
@@ -1,6 +1,6 @@
 ---
 id: EdmLiteral
-module: data/odata/utils
+module: common/data
 export: EdmLiteral
 ---
 ---

diff --git a/api-reference/30 Data Layer/EndpointSelector/EndpointSelector.md b/api-reference/30 Data Layer/EndpointSelector/EndpointSelector.md
@@ -1,7 +1,7 @@
 ---
 id: EndpointSelector
-module: data/endpoint_selector
-export: default
+module: common/data
+export: EndpointSelector
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/30 Data Layer/Guid/Guid.md b/api-reference/30 Data Layer/Guid/Guid.md
@@ -1,7 +1,7 @@
 ---
 id: Guid
-module: core/guid
-export: default
+module: common
+export: Guid
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/30 Data Layer/LocalStore/LocalStore.md b/api-reference/30 Data Layer/LocalStore/LocalStore.md
@@ -1,7 +1,7 @@
 ---
 id: LocalStore
-module: data/local_store
-export: default
+module: common/data
+export: LocalStore
 inherits: ArrayStore
 ---
 ---

diff --git a/api-reference/30 Data Layer/ODataContext/ODataContext.md b/api-reference/30 Data Layer/ODataContext/ODataContext.md
@@ -1,7 +1,7 @@
 ---
 id: ODataContext
-module: data/odata/context
-export: default
+module: common/data
+export: ODataContext
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/30 Data Layer/ODataStore/ODataStore.md b/api-reference/30 Data Layer/ODataStore/ODataStore.md
@@ -1,7 +1,7 @@
 ---
 id: ODataStore
-module: data/odata/store
-export: default
+module: common/data
+export: ODataStore
 inherits: Store
 ---
 ---

diff --git a/api-reference/30 Data Layer/Query/Query.md b/api-reference/30 Data Layer/Query/Query.md
@@ -1,7 +1,7 @@
 ---
 id: Query
 type: Object
-module: data/query
+module: common/data
 export: Query
 ---
 ---

diff --git a/api-reference/30 Data Layer/Utils/applyChanges(data_changes_options).md b/api-reference/30 Data Layer/Utils/applyChanges(data_changes_options).md
@@ -1,7 +1,7 @@
 ---
 id: Utils.applyChanges(data, changes, options)
-module: data/apply_changes
-export: default
+module: common/data
+export: applyChanges
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/30 Data Layer/Utils/base64_encode(input).md b/api-reference/30 Data Layer/Utils/base64_encode(input).md
@@ -1,6 +1,6 @@
 ---
 id: Utils.base64_encode(input)
-module: data/utils
+module: common/data
 export: base64_encode
 ---
 ---

diff --git a/api-reference/30 Data Layer/Utils/compileGetter(expr).md b/api-reference/30 Data Layer/Utils/compileGetter(expr).md
@@ -1,6 +1,6 @@
 ---
 id: Utils.compileGetter(expr)
-module: utils
+module: common/data
 export: compileGetter
 ---
 ---

diff --git a/api-reference/30 Data Layer/Utils/compileSetter(expr).md b/api-reference/30 Data Layer/Utils/compileSetter(expr).md
@@ -1,6 +1,6 @@
 ---
 id: Utils.compileSetter(expr)
-module: utils
+module: common/data
 export: compileSetter
 ---
 ---

diff --git a/api-reference/30 Data Layer/Utils/errorHandler.md b/api-reference/30 Data Layer/Utils/errorHandler.md
@@ -1,6 +1,6 @@
 ---
 id: Utils.errorHandler
-module: data/errors
+module: common/data
 export: errorHandler
 type: function(e)
 dep: Utils.setErrorHandler

diff --git a/api-reference/30 Data Layer/Utils/odata.keyConverters.md b/api-reference/30 Data Layer/Utils/odata.keyConverters.md
@@ -1,6 +1,6 @@
 ---
 id: Utils.keyConverters
-module: data/odata/utils
+module: common/data
 export: keyConverters
 type: any
 ---

diff --git a/api-reference/30 Data Layer/Utils/query(array_queryOptions).md b/api-reference/30 Data Layer/Utils/query(array_queryOptions).md
@@ -1,7 +1,7 @@
 ---
 id: Utils.query(array, queryOptions)
-module: data/query
-export: default
+module: common/data
+export: query
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/30 Data Layer/Utils/query(url_queryOptions).md b/api-reference/30 Data Layer/Utils/query(url_queryOptions).md
@@ -1,7 +1,7 @@
 ---
 id: Utils.query(url, queryOptions)
-module: data/query
-export: default
+module: common/data
+export: query
 ---
 ---
 ##### shortDescription

diff --git a/api-reference/30 Data Layer/Utils/setErrorHandler.md b/api-reference/30 Data Layer/Utils/setErrorHandler.md
@@ -1,6 +1,6 @@
 ---
 id: Utils.setErrorHandler
-module: data/errors
+module: common/data
 export: setErrorHandler
 type: function(handler)
 ---

diff --git a/api-reference/40 Common Types/10 data/FilterDescriptor.md b/api-reference/40 Common Types/10 data/FilterDescriptor.md
@@ -1,7 +1,7 @@
 ---
 id: FilterDescriptor
-type: any
-module: data/index
+type: Object
+module: common/data
 export: FilterDescriptor
 ---
 ---

diff --git a/api-reference/40 Common Types/10 data/LangParams/LangParams.md b/api-reference/40 Common Types/10 data/LangParams/LangParams.md
@@ -1,6 +1,6 @@
 ---
 id: LangParams
-module: data/index
+module: common/data
 export: LangParams
 type: Object
 generateTypeLink:
-Original file line number
+Diff line change
@@ Expand Up @@
     The cell's new value.
     ---
+    {WidgetName} re-renders the entire row or edit form after the **cellValue** method changes a cell value. To re-render only the modified cell or form item editor, enable [repaintChangesOnly]({basewidgetpath}/Configuration/#repaintChangesOnly).
     Call [saveEditData()](/api-reference/10%20UI%20Components/GridBase/3%20Methods/saveEditData().md '{basewidgetpath}/Methods/#saveEditData') after this method to save the changes:
     ---
@@ Expand Down @@