Skip to content

Commit

Permalink
DocGen 24_2 result (#6706)
Browse files Browse the repository at this point in the history
  • Loading branch information
dxrobot authored Oct 10, 2024
1 parent 1589b1c commit 4fb92f0
Show file tree
Hide file tree
Showing 21 changed files with 233 additions and 25 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: GridBase.Options.pager
type: common/grids:Pager
type: Pager
inheritsType: common/grids:Pager
---
---
Expand Down
7 changes: 7 additions & 0 deletions api-reference/40 Common Types/15 grids/Pager/Pager.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,16 @@ isType:
module: common/grids
export: Pager
generateTypeLink:
inherits: PagerBase
---
---
##### shortDescription
Configures the pager.

##### field(allowedPageSizes): Array | Enums.Mode
Specifies the available page sizes in the page size selector.

##### field(visible): Boolean | Enums.Mode
Specifies whether the pager is visible.

---
2 changes: 1 addition & 1 deletion api-reference/40 Common Types/Mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: Enums.Mode
acceptValues: 'auto'
type: Union
references: ui/data_grid:GroupPanel.visible|dxDataGrid.Options.remoteOperations|dxDropDownEditor.Options.validationMessagePosition|dxForm.Options.colCount|dxPivotGrid.Options.scrolling.useNative|dxTreeList.Options.remoteOperations|GridBase.Options.columnWidth|GridBase.Options.filterSyncEnabled|common/grids:LoadPanel.enabled|common/grids:Pager.allowedPageSizes|common/grids:Pager.visible|common/grids:ScrollingBase.useNative
references: ui/data_grid:GroupPanel.visible|dxDataGrid.Options.remoteOperations|dxDropDownEditor.Options.validationMessagePosition|dxForm.Options.colCount|dxPivotGrid.Options.scrolling.useNative|dxTreeList.Options.remoteOperations|GridBase.Options.columnWidth|GridBase.Options.filterSyncEnabled|common/grids:LoadPanel.enabled|common/grids:ScrollingBase.useNative|common/grids:Pager.allowedPageSizes|common/grids:Pager.visible
---
---
##### shortDescription
Expand Down
13 changes: 13 additions & 0 deletions api-reference/NewTopics/PagerBase/PagerBase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: PagerBase
module: common
export: PagerBase
hidden:
type: Object
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
11 changes: 11 additions & 0 deletions api-reference/NewTopics/PagerBase/displayMode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: PagerBase.displayMode
type: Enums.DisplayMode
default: 'adaptive'
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
11 changes: 11 additions & 0 deletions api-reference/NewTopics/PagerBase/infoText.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: PagerBase.infoText
type: String
default: 'Page {0} of {1} ({2} items)'
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
11 changes: 11 additions & 0 deletions api-reference/NewTopics/PagerBase/label.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: PagerBase.label
type: String
default: 'Page Navigation'
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
11 changes: 11 additions & 0 deletions api-reference/NewTopics/PagerBase/showInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: PagerBase.showInfo
type: Boolean
default: false
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
11 changes: 11 additions & 0 deletions api-reference/NewTopics/PagerBase/showNavigationButtons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: PagerBase.showNavigationButtons
type: Boolean
default: false
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
11 changes: 11 additions & 0 deletions api-reference/NewTopics/PagerBase/showPageSizeSelector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: PagerBase.showPageSizeSelector
type: Boolean
default: false
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
##### shortDescription
<!-- Description goes here -->

---
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: dxPagination.Options.allowedPageSizes
type: Array<Number, String>
default: [5, 10]
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
11 changes: 11 additions & 0 deletions api-reference/NewTopics/dxPagination/1 Configuration/itemCount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: dxPagination.Options.itemCount
type: Number
default: 1
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
12 changes: 12 additions & 0 deletions api-reference/NewTopics/dxPagination/1 Configuration/pageIndex.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: dxPagination.Options.pageIndex
firedEvents: optionChanged
type: Number
default: 1
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
12 changes: 12 additions & 0 deletions api-reference/NewTopics/dxPagination/1 Configuration/pageSize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: dxPagination.Options.pageSize
firedEvents: optionChanged
type: Number
default: 5
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
5 changes: 5 additions & 0 deletions api-reference/NewTopics/dxPagination/3 Methods/Methods.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
##### shortDescription
<!-- Description goes here -->

---
12 changes: 12 additions & 0 deletions api-reference/NewTopics/dxPagination/3 Methods/getPageCount().md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: dxPagination.getPageCount()
---
---
##### shortDescription
<!-- Description goes here -->

##### return: Number
<!-- Description goes here -->

---
<!-- Description goes here -->
12 changes: 12 additions & 0 deletions api-reference/NewTopics/dxPagination/dxPagination.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: dxPagination
module: ui/pagination
export: default
inherits: Widget
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
12 changes: 12 additions & 0 deletions api-reference/_hidden/Enums/DisplayMode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
id: Enums.DisplayMode
acceptValues: 'adaptive' | 'compact' | 'full'
type: Union
references: PagerBase.displayMode
---
---
##### shortDescription
<!-- Description goes here -->

---
<!-- Description goes here -->
Empty file.
76 changes: 53 additions & 23 deletions metadata/syntax-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -14074,6 +14074,26 @@
"dxOverlayOptions.wrapperAttr": {
"vue": "wrapper-attr"
},
"dxPagination": {
"angular": "dx-pagination",
"react": "Pagination",
"vue": "DxPagination"
},
"dxPaginationOptions": {
"vue": "dx-pagination-options"
},
"dxPaginationOptions.allowedPageSizes": {
"vue": "allowed-page-sizes"
},
"dxPaginationOptions.itemCount": {
"vue": "item-count"
},
"dxPaginationOptions.pageIndex": {
"vue": "page-index"
},
"dxPaginationOptions.pageSize": {
"vue": "page-size"
},
"dxPieChart": {
"angular": "dx-pie-chart",
"react": "PieChart",
Expand Down Expand Up @@ -19535,6 +19555,9 @@
"enums.DiscreteAxisDivisionMode": {
"vue": "discrete-axis-division-mode"
},
"enums.DisplayMode": {
"vue": "display-mode"
},
"enums.Distribution": {
"vue": "distribution"
},
Expand Down Expand Up @@ -19727,9 +19750,6 @@
"enums.PageOrientation": {
"vue": "page-orientation"
},
"enums.PagerDisplayMode": {
"vue": "pager-display-mode"
},
"enums.PagerPageSize": {
"vue": "pager-page-size"
},
Expand Down Expand Up @@ -20669,26 +20689,6 @@
"react": "Pager",
"vue": "DxPager"
},
"gridBaseOptions.pager.allowedPageSizes": {
"angular": "dxi-allowed-page-size",
"react": "AllowedPageSize",
"vue": "DxAllowedPageSize"
},
"gridBaseOptions.pager.displayMode": {
"vue": "display-mode"
},
"gridBaseOptions.pager.infoText": {
"vue": "info-text"
},
"gridBaseOptions.pager.showInfo": {
"vue": "show-info"
},
"gridBaseOptions.pager.showNavigationButtons": {
"vue": "show-navigation-buttons"
},
"gridBaseOptions.pager.showPageSizeSelector": {
"vue": "show-page-size-selector"
},
"gridBaseOptions.paging": {
"angular": "dxo-paging",
"react": "Paging",
Expand Down Expand Up @@ -20968,6 +20968,36 @@
"numericRule.ignoreEmptyValue": {
"vue": "ignore-empty-value"
},
"pager": {
"angular": "dxo-pager",
"react": "Pager",
"vue": "DxPager"
},
"pager.allowedPageSizes": {
"angular": "dxi-allowed-page-size",
"react": "AllowedPageSize",
"vue": "DxAllowedPageSize"
},
"pagerBase": {
"angular": "dxo-pager-base",
"react": "PagerBase",
"vue": "DxPagerBase"
},
"pagerBase.displayMode": {
"vue": "display-mode"
},
"pagerBase.infoText": {
"vue": "info-text"
},
"pagerBase.showInfo": {
"vue": "show-info"
},
"pagerBase.showNavigationButtons": {
"vue": "show-navigation-buttons"
},
"pagerBase.showPageSizeSelector": {
"vue": "show-page-size-selector"
},
"patternRule": {
"angular": "dxo-pattern-rule",
"react": "PatternRule",
Expand Down

0 comments on commit 4fb92f0

Please sign in to comment.