Class PDFNet.PageSet
PDFNet.PageSet
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.PageSet(id)
PageSet is a container of page numbers ordered following a linear sequence.
|
| Method Attributes | Method Name and Description |
|---|---|
|
addFilteredRange(range_start, range_end, filter)
Add a range of values to the sequence.
|
|
|
addPage(one_page)
Add a value to the sequence.
|
|
|
addRange(range_start, range_end)
[Documentation Not Yet Added]
|
|
| <static> |
PDFNet.PageSet.create()
Default constructor.
|
| <static> |
PDFNet.PageSet.createFilteredRange(range_start, range_end, filter)
Construct a range of pages
|
| <static> |
PDFNet.PageSet.createRange(range_start, range_end)
[Documentation Not Yet Added]
|
| <static> |
PDFNet.PageSet.createSinglePage(one_page)
Construct a set of pages with just one number
|
|
destroy()
Frees the native memory of the object.
|
Class Detail
PDFNet.PageSet(id)
PageSet is a container of page numbers ordered following a linear sequence.
The page numbers are integers and must be greater than zero. Duplicates are allowed.
(NOTE: This is not a mathematical set)
- Parameters:
- id
Method Detail
addFilteredRange(range_start, range_end, filter)
Add a range of values to the sequence. Reverse ordering is legal.
- Parameters:
- {number} range_start
- The starting value in the range
- {number} range_end
- The ending value in the range
- {number} filter
- -e_all: Default, includes all pages in the range -e_odd: Includes odd numbers in the range (discards even numbers) -e_even: Includes even numbers in the range (discards odd numbers)
addPage(one_page)
Add a value to the sequence.
- Parameters:
- {number} one_page
- The page number being added
addRange(range_start, range_end)
[Documentation Not Yet Added]
- Parameters:
- {number} range_start
- (generated documentation)
- {number} range_end
- (generated documentation)
<static>
{PageSet}
PDFNet.PageSet.create()
Default constructor. Constructs 'PageSet' with no pages
- Returns:
- {PageSet} A promise that resolves to an object of type: "PageSet" (generated documentation)
<static>
{PageSet}
PDFNet.PageSet.createFilteredRange(range_start, range_end, filter)
Construct a range of pages
- Parameters:
- {number} range_start
- (generated documentation)
- {number} range_end
- (generated documentation)
- {number/enum} filter
- (generated enum documentation)
PDFNet.PageSet.Filter = { e_all : 0 e_even : 1 e_odd : 2 }
- Returns:
- {PageSet} A promise that resolves to an object of type: "PageSet" (generated documentation)
- See:
- AddRange
<static>
{PageSet}
PDFNet.PageSet.createRange(range_start, range_end)
[Documentation Not Yet Added]
- Parameters:
- {number} range_start
- (generated documentation)
- {number} range_end
- (generated documentation)
- Returns:
- {PageSet} A promise that resolves to an object of type: "PageSet" (generated documentation)
<static>
{PageSet}
PDFNet.PageSet.createSinglePage(one_page)
Construct a set of pages with just one number
- Parameters:
- {number} one_page
- (generated documentation)
- Returns:
- {PageSet} A promise that resolves to an object of type: "PageSet" (generated documentation)
- See:
- AddPage
destroy()
Frees the native memory of the object.