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

public class | source

ModelPage

Base → Model → ModelPage

A base class for server-side paginated list.

Constructor Summary

Public Constructor
public	constructor(options: *)

Public Members
public	cumulative: *
public get	has_search: *
public	loading: boolean
public get	pages: int: * Total amount of pages
public	query: *
public get	reversed: boolean: * Wether the sort is reversed (descending) or not (ascending)
public	serverside: boolean
public get	sorted: string: * Field name used for sorting

Public Methods
public	fetch(options: Object): Object Fetch page from server.
public	go_to_page(page: Number): Object Fetch a page given its index.
public	nextPage(options: Object): Object Fetch the next page.
public	on_fetched(data: *)
public	previousPage(): Object Fetch the previous page.
public	search(query: String): Object Perform a server-side search
public	sort(field: String, reversed: Boolean): Object Perform a server-side sort

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 Model
public	$options: *
public	loading: boolean
public	clear(): Object Empty the model
public	empty(): Object Empty or clear a data object based on a schema.
public	on_fetched(data: *)
public	validate(): Object Perform a model validation given its schema