import PaginatedResourceListing from '@mapcreator/api/src/PaginatedResourceListing.js'
PaginatedResourceListing
Proxy for accessing paginated resources
Member Summary
Public Members | ||
public get |
Target: Class<ResourceBase>: * Target to wrap results in |
|
public get |
api: Mapcreator: * Get api instance |
|
public get |
cacheToken: string: * Used for caching pages internally |
|
public get |
data: Array<ResourceBase>: * Page data |
|
public get |
Deleted items filter state |
|
public set |
Deleted items filter state |
|
public get |
If there is a next page |
|
public get |
hasPrevious: boolean: * If there is a previous page |
|
public get |
Current page number |
|
public get |
Amount of pages available |
|
public get |
Request parameters |
|
public set |
parameters(value: RequestParameters) Request parameters |
|
public get |
Maximum amount of items per page |
|
public get |
Optional search query |
|
public set |
Optional search query |
|
public get |
Target route |
|
public set |
Override the target route |
|
public get |
Row count |
|
public get |
Set sort direction |
|
public set |
Current sorting value |
Method Summary
Public Methods | ||
public |
getPage(page: Number, perPage: Number): CancelablePromise<PaginatedResourceListing> Get target page |
|
public |
Get next page |
|
public |
Get previous page |
Public Members
public get cacheToken: string: * source
Used for caching pages internally
See:
- PaginatedResourceWrapper
- ResourceCache
public set query(value: Object<String, String|Array<String>>) source
Optional search query
Throw:
See:
- ResourceProxy#search
Public Methods
public getPage(page: Number, perPage: Number): CancelablePromise<PaginatedResourceListing> source
Get target page
Throw:
If the api returns errors |
public next(): CancelablePromise<PaginatedResourceListing> source
Get next page
Throw:
If the api returns errors |
public previous(): CancelablePromise<PaginatedResourceListing> source
Get previous page
Throw:
If the api returns errors |