Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 15 commits into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: DataHelperMixin
module: data_helper
export: default
export: DataHelperMixin
hidden:
---
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: Enums.GanttPdfExportDateRange
acceptValues: 'all' | 'visible'
type: Union
references: PdfExportGanttProps.dateRange
references: GanttExport.Options.dateRange
---
---
##### shortDescription
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: Enums.GanttPdfExportMode
acceptValues: 'all' | 'treeList' | 'chart'
type: Union
references: PdfExportGanttProps.exportMode
references: GanttExport.Options.exportMode
---
---
##### shortDescription
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: SchedulerTimeZone
module: common/core/environment
export: SchedulerTimeZone
type: Object
generateTypeLink:
---
---
##### shortDescription
A time zone object.

---
<!-- Description goes here -->
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: dxSchedulerTimeZone.id
id: SchedulerTimeZone.id
type: String
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: dxSchedulerTimeZone.offset
id: SchedulerTimeZone.offset
type: Number
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: dxSchedulerTimeZone.title
id: SchedulerTimeZone.title
type: String
---
---
Expand Down

This file was deleted.

6 changes: 3 additions & 3 deletions api-reference/30 Data Layer/ArrayStore/ArrayStore.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: ArrayStore
module: data/array_store
export: default
inherits: Store
module: common/data
export: ArrayStore
inheritsType: Store
---
---
##### shortDescription
Expand Down
4 changes: 2 additions & 2 deletions api-reference/30 Data Layer/CustomStore/CustomStore.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: CustomStore
module: data/custom_store
export: default
module: common/data
export: CustomStore
inherits: Store
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: LoadOptions
type: Object
module: data/index
module: common/data
export: Load_Options
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: DataSource.Options.searchOperation
type: Enums.SearchOperation
type: Object
default: 'contains'
---
---
Expand Down
4 changes: 2 additions & 2 deletions api-reference/30 Data Layer/DataSource/DataSource.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: DataSource
module: data/data_source
export: default
module: common/data
export: DataSource
---
---
##### shortDescription
Expand Down
2 changes: 1 addition & 1 deletion api-reference/30 Data Layer/EdmLiteral/EdmLiteral.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: EdmLiteral
module: data/odata/utils
module: common/data
export: EdmLiteral
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: EndpointSelector
module: data/endpoint_selector
export: default
module: common/data
export: EndpointSelector
---
---
##### shortDescription
Expand Down
4 changes: 2 additions & 2 deletions api-reference/30 Data Layer/Guid/Guid.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Guid
module: core/guid
export: default
module: common
export: Guid
---
---
##### shortDescription
Expand Down
4 changes: 2 additions & 2 deletions api-reference/30 Data Layer/LocalStore/LocalStore.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: LocalStore
module: data/local_store
export: default
module: common/data
export: LocalStore
inherits: ArrayStore
---
---
Expand Down
4 changes: 2 additions & 2 deletions api-reference/30 Data Layer/ODataContext/ODataContext.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: ODataContext
module: data/odata/context
export: default
module: common/data
export: ODataContext
---
---
##### shortDescription
Expand Down
4 changes: 2 additions & 2 deletions api-reference/30 Data Layer/ODataStore/ODataStore.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: ODataStore
module: data/odata/store
export: default
module: common/data
export: ODataStore
inherits: Store
---
---
Expand Down
2 changes: 1 addition & 1 deletion api-reference/30 Data Layer/Query/Query.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Query
type: Object
module: data/query
module: common/data
export: Query
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Utils.applyChanges(data, changes, options)
module: data/apply_changes
export: default
module: common/data
export: applyChanges
---
---
##### shortDescription
Expand Down
2 changes: 1 addition & 1 deletion api-reference/30 Data Layer/Utils/base64_encode(input).md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Utils.base64_encode(input)
module: data/utils
module: common/data
export: base64_encode
---
---
Expand Down
2 changes: 1 addition & 1 deletion api-reference/30 Data Layer/Utils/compileGetter(expr).md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Utils.compileGetter(expr)
module: utils
module: common/data
export: compileGetter
---
---
Expand Down
2 changes: 1 addition & 1 deletion api-reference/30 Data Layer/Utils/compileSetter(expr).md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Utils.compileSetter(expr)
module: utils
module: common/data
export: compileSetter
---
---
Expand Down
2 changes: 1 addition & 1 deletion api-reference/30 Data Layer/Utils/errorHandler.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Utils.errorHandler
module: data/errors
module: common/data
export: errorHandler
type: function(e)
dep: Utils.setErrorHandler
Expand Down
2 changes: 1 addition & 1 deletion api-reference/30 Data Layer/Utils/odata.keyConverters.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Utils.keyConverters
module: data/odata/utils
module: common/data
export: keyConverters
type: any
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Utils.query(array, queryOptions)
module: data/query
export: default
module: common/data
export: query
---
---
##### shortDescription
Expand Down
4 changes: 2 additions & 2 deletions api-reference/30 Data Layer/Utils/query(url_queryOptions).md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Utils.query(url, queryOptions)
module: data/query
export: default
module: common/data
export: query
---
---
##### shortDescription
Expand Down
2 changes: 1 addition & 1 deletion api-reference/30 Data Layer/Utils/setErrorHandler.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: Utils.setErrorHandler
module: data/errors
module: common/data
export: setErrorHandler
type: function(handler)
---
Expand Down
4 changes: 2 additions & 2 deletions api-reference/40 Common Types/10 data/FilterDescriptor.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: FilterDescriptor
type: any
module: data/index
type: Object
module: common/data
export: FilterDescriptor
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: LangParams
module: data/index
module: common/data
export: LangParams
type: Object
generateTypeLink:
Expand Down
2 changes: 1 addition & 1 deletion api-reference/40 Common Types/10 data/ResolvedData.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion api-reference/40 Common Types/10 data/SearchOperation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: Enums.SearchOperation
acceptValues: '=' | '<>' | '>' | '>=' | '<' | '<=' | 'startswith' | 'endswith' | 'contains' | 'notcontains'
type: Union
references: DataSource.Options.searchOperation|LoadOptions.searchOperation
references: LoadOptions.searchOperation
---
---
##### shortDescription
Expand Down
2 changes: 1 addition & 1 deletion api-reference/40 Common Types/10 data/SummaryDescriptor.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: SummaryDescriptor
type: Object
module: data/index
module: common/data
export: SummaryDescriptor
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: GroupItem
module: common/data/custom-store
module: common/data
export: GroupItem
type: Object
generateTypeLink:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: LoadResult
module: common/data/custom-store
module: common/data
export: LoadResult
type: Object
generateTypeLink:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: LoadResultObject
module: common/data/custom-store
module: common/data
export: LoadResultObject
type: Object
generateTypeLink:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: isGroupItemsArray
module: common/data/custom-store
module: common/data
export: isGroupItemsArray
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: isItemsArray
module: common/data/custom-store
module: common/data
export: isItemsArray
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: isLoadResultObject
module: common/data/custom-store
module: common/data
export: isLoadResultObject
---
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: AsyncCancelable
module: events/index
module: common/core/events
export: AsyncCancelable
type: Object
generateTypeLink:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
id: Cancelable
module: events/index
module: common/core/events
export: Cancelable
generateTypeLink:
type: Object
---
---
##### shortDescription
Expand Down
Loading
Loading