import {PageList} from 'udata/js/models/base.js'

public class | source

PageList

Base → List → PageList

A client-side pager wrapper for list.

Constructor Summary

Public Constructor
public	constructor(options: *)

Public Members
public get	data: *
public set	data: *
public	page: number
public	page_size: *
public get	pages: int: * Total amount of pages

Public Methods
public	go_to_page(page: Number): Object Display a page given its index.
public	nextPage(): Object Display the next page.
public	previousPage(): Object Display the previous page.

From class Base
public	$pubsub: *
public	$api(endpoint: String, data: Object, callback: Function): * Call an API endpoint.
public	$emit(name: String, args: Array) Emit an event on this model instance
public	$off(name: String, handler: Function): * Unregister a listener on an event.
public	$on(name: String, handler: Function): Object Register a listener on an event.
public	$once(name: String, handler: Function): * Register once a listener on an event.

From class List
public get	data: *
public set	data: *
public get	has_search: *
public	$options: *
public	filtered: *
public	items: *
public	loading: *
public	page: number
public	query: *
public	reversed: boolean
public	sorted: *
public	by_id(id: ): Get an item given its ID
public	clear(): Object Empty the list
public	fetch(options: [type]): [type] Fetch an unpaginated list.
public	on_fetched(data: *)
public	populate() Populate the data view (filtered and sorted)
public	search(query: String): Object Perform a client-side search
public	sort(field: String, reversed: Boolean): Object Perform a client-side sort