Common Types: export common entities from 'common' folder (#6885)

DevExpress · Dec 13, 2024 · 649d036 · 649d036
1 parent 18e1859
commit 649d036
Show file tree

Hide file tree

Showing 156 changed files with 231 additions and 220 deletions.
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/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/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/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: 

diff --git a/api-reference/40 Common Types/10 data/ResolvedData.md b/api-reference/40 Common Types/10 data/ResolvedData.md
@@ -1,6 +1,6 @@
 ---
 id: ResolvedData
-module: data/custom_store
+module: common/data
 export: ResolvedData
 type: Object
 deprecated: Use [LoadResult](/api-reference/40%20Common%20Types/10%20data/custom-store/LoadResult '/Documentation/ApiReference/Common_Types/data/custom-store/LoadResult/') instead.

diff --git a/api-reference/40 Common Types/10 data/SearchOperation.md b/api-reference/40 Common Types/10 data/SearchOperation.md
@@ -2,7 +2,7 @@
 id: Enums.SearchOperation
 acceptValues: '=' | '<>' | '>' | '>=' | '<' | '<=' | 'startswith' | 'endswith' | 'contains' | 'notcontains'
 type: Union
-references: DataSource.Options.searchOperation|LoadOptions.searchOperation
+references: LoadOptions.searchOperation
 ---
 ---
 ##### shortDescription

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

diff --git a/api-reference/40 Common Types/10 data/custom-store/GroupItem/GroupItem.md b/api-reference/40 Common Types/10 data/custom-store/GroupItem/GroupItem.md
@@ -1,6 +1,6 @@
 ---
 id: GroupItem
-module: common/data/custom-store
+module: common/data
 export: GroupItem
 type: Object
 generateTypeLink: 

diff --git a/api-reference/40 Common Types/10 data/custom-store/LoadResult/LoadResult.md b/api-reference/40 Common Types/10 data/custom-store/LoadResult/LoadResult.md
@@ -1,6 +1,6 @@
 ---
 id: LoadResult
-module: common/data/custom-store
+module: common/data
 export: LoadResult
 type: Object
 generateTypeLink: 

diff --git a/...rence/40 Common Types/10 data/custom-store/LoadResultObject/LoadResultObject.md b/...rence/40 Common Types/10 data/custom-store/LoadResultObject/LoadResultObject.md
@@ -1,6 +1,6 @@
 ---
 id: LoadResultObject
-module: common/data/custom-store
+module: common/data
 export: LoadResultObject
 type: Object
 generateTypeLink: 

diff --git a/api-reference/40 Common Types/10 data/custom-store/isGroupItemsArray.md b/api-reference/40 Common Types/10 data/custom-store/isGroupItemsArray.md
@@ -1,6 +1,6 @@
 ---
 id: isGroupItemsArray
-module: common/data/custom-store
+module: common/data
 export: isGroupItemsArray
 ---
 ---

diff --git a/api-reference/40 Common Types/10 data/custom-store/isItemsArray.md b/api-reference/40 Common Types/10 data/custom-store/isItemsArray.md
@@ -1,6 +1,6 @@
 ---
 id: isItemsArray
-module: common/data/custom-store
+module: common/data
 export: isItemsArray
 ---
 ---

diff --git a/api-reference/40 Common Types/10 data/custom-store/isLoadResultObject.md b/api-reference/40 Common Types/10 data/custom-store/isLoadResultObject.md
@@ -1,6 +1,6 @@
 ---
 id: isLoadResultObject
-module: common/data/custom-store
+module: common/data
 export: isLoadResultObject
 ---
 ---

diff --git a/api-reference/40 Common Types/13 events/AsyncCancelable/AsyncCancelable.md b/api-reference/40 Common Types/13 events/AsyncCancelable/AsyncCancelable.md
@@ -1,6 +1,6 @@
 ---
 id: AsyncCancelable
-module: events/index
+module: common/core/events
 export: AsyncCancelable
 type: Object
 generateTypeLink: 

diff --git a/api-reference/40 Common Types/13 events/Cancelable/Cancelable.md b/api-reference/40 Common Types/13 events/Cancelable/Cancelable.md
@@ -1,8 +1,9 @@
 ---
 id: Cancelable
-module: events/index
+module: common/core/events
 export: Cancelable
 generateTypeLink: 
+type: Object
 ---
 ---
 ##### shortDescription