Class adobeDPS-ArticlePosition
- Platforms:
- iOS, Android
This class represents the meta data of the article.
Constructor
adobeDPS-ArticlePosition(indexInFolio:number, indexInSection:number, pageNumber:number, pageCount:number)
[inner]
Create a Article Position object.
Fields
| Field | Defined By | |
|---|---|---|
|
currentIndexInFolio
: number
The index of the current article in the folio.
|
ArticlePosition
|
|
|
currentIndexInSection
: number
The index of the current article in the section of the current article.
|
ArticlePosition
|
|
|
currentPageNumber
: number
The current page number of the article being displayed.
|
ArticlePosition
|
|
|
totalPageCount
: number
The total number of pages in the article
|
ArticlePosition
|
Class Detail
adobeDPS-ArticlePosition(indexInFolio:number, indexInSection:number, pageNumber:number, pageCount:number)
[inner]
Create a Article Position object.
| Parameters | ||
|---|---|---|
| indexInFolio | number | Current article index in the folio |
| indexInSection | number | Current Article index in the section |
| pageNumber | number | current page number in the article |
| pageCount | number | Total number of pages in the article |
Field Details
currentIndexInFolio
: number
The index of the current article in the folio. Indices are Zero based.
- Platforms:
- iOS, Android
currentIndexInSection
: number
The index of the current article in the section of the current article. The index is
zero based. If the article does not have a section name, its value will be undefined
- Platforms:
- iOS
currentPageNumber
: number
The current page number of the article being displayed. In case of smooth scrolling article,
this represents the pageNumber of content representing the Top-Left corner of the screen.
page numbers are zero based.
- Platforms:
- iOS, Android
totalPageCount
: number
The total number of pages in the article
- Platforms:
- iOS, Android
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:39 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:39 GMT-0700 (PDT)