Home Reference Source Repository 
import {List} from 'udata/js/models/base.js'
public class | source

List

Extends:

Base → List

Direct Subclass:

PageList

A base class for unpaginated list

Constructor Summary

Public Constructor
public

constructor(options: *)

Member Summary

Public Members
public
public set

data: *

public get

data: *

public
public get
public

items: *

public

loading: *

public
public

query: *

public
public

sorted: *

Method Summary

Public Methods
public

by_id(id: *): *

Get an item given its ID
public
Empty the list
public

fetch(options: [type]): [type]

Fetch an unpaginated list.
public

on_fetched(data: *)

public
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

Inherited Summary

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.

Public Constructors

public constructor(options: *) source

Override:

Base#constructor

Params:

NameTypeAttributeDescription
options *

Public Members

public $options: * source

public set data: * source

public get data: * source

public filtered: * source

public items: * source

public loading: * source

public page: number source

public query: * source

public reversed: boolean source

public sorted: * source

Public Methods

public by_id(id: *): * source

Get an item given its ID

Params:

NameTypeAttributeDescription
id *

Return:

*

public clear(): Object source

Empty the list

Return:

Object

Return itself allowing to chain methods.

public fetch(options: [type]): [type] source

Fetch an unpaginated list.

Params:

NameTypeAttributeDescription
options [type]

[description]

Return:

[type]

[description]

public on_fetched(data: *) source

Params:

NameTypeAttributeDescription
data *

public populate() source

Populate the data view (filtered and sorted)

Perform a client-side search

Params:

NameTypeAttributeDescription
query String

The query string to perform the search on.

Return:

Object

Return itself allowing to chain methods.

public sort(field: String, reversed: Boolean): Object source

Perform a client-side sort

Params:

NameTypeAttributeDescription
field String

The object attribute to sort on.
reversed Boolean

If true, sort is descending.

Return:

Object

Return itself allowing to chain methods.