presentation-models

Augmented.js Presentation Models & Collections Module

API

$3

- Model
- Parameters
- crossOrigin
- Properties
- \_uri
- Properties
- sync
- Parameters
- fetch
- Parameters
- save
- Parameters
- update
- Parameters
- destroy
- Parameters
- Collection
- Parameters
- \_uri
- Properties
- sync
- Parameters
- fetch
- Parameters
- save
- Parameters
- update
- Parameters
- destroy
- Parameters
- LocalStorageCollection
- Parameters
- key
- Properties
- persist
- Properties
- namespace
- Properties
- initialize
- Parameters
- init
- Parameters
- fetch
- Parameters
- save
- Parameters
- update
- Parameters
- destroy
- Parameters
- sync
- Parameters
- PaginatedCollection
- Parameters
- setPageSize
- Parameters
- setPageSize
- Parameters
- setPageSize
- Parameters
- setCurrentPage
- Parameters
- fetch
- Parameters
- nextPage
- previousPage
- goToPage
- Parameters
- firstPage
- lastPage
- refresh
- PaginationFactory
- PAGINATION_API_TYPE
- Properties
- getPaginatedCollection
- Parameters

Model

Extends AbstractModel

Model

Supports:

• REST


• Validation and Schemas


• Security

$3

- attributes
- options (optional, default {})
- args ...any

$3

Cross Origin property

#### Properties

- crossOrigin boolean Cross Origin property

$3

#### Properties

- uri string The uri for the datasource (if applicable)

$3

sync - Sync model data to bound REST call

#### Parameters

- method (optional, default "READ")
- model
- options (optional, default {})

$3

Fetch the model

#### Parameters

- options object Any options to pass

$3

Save the model

#### Parameters

- options object Any options to pass

$3

Update the model

#### Parameters

- options object Any options to pass

$3

Destroy the model

#### Parameters

- options object Any options to pass

Collection

Extends AbstractCollection

Collection Class

$3

- models
- options (optional, default {})

$3

#### Properties

- uri string The uri for the datasource (if applicable)

$3

Sync collection data to bound REST call

#### Parameters

- method string The method to Unsuccessfull
- model Model The model to Sync
- options object The options to pass (optional, default {})

Returns function Returns a request function

$3

Fetch the collection

#### Parameters

- options object Any options to pass

$3

Save the collection

#### Parameters

- options object Any options to pass

$3

Update the collection

#### Parameters

- options object Any options to pass

$3

Destroy the collection

#### Parameters

- options object Any options to pass

LocalStorageCollection

Extends AbstractCollection

A local storage-based Collection

$3

- models
- options (optional, default {})

$3

Base key name for the collection (simular to url for rest-based)

#### Properties

- key string The key

$3

is Persistant or not

#### Properties

- persist boolean Persistant property

$3

The namespace

#### Properties

- namespace boolean

$3

Initialize the model with needed wireing

#### Parameters

- options object Any options to pass

$3

Custom init method for the model (called at inititlize)

#### Parameters

- options object Any options to pass

$3

Fetch the collection

#### Parameters

- options object Any options to pass

$3

Save the collection

#### Parameters

- options object Any options to pass

$3

Update the collection

#### Parameters

- options object Any options to pass

$3

Destroy the collection

#### Parameters

- options object Any options to pass

$3

Sync method for Collection

#### Parameters

- method (optional, default "READ")
- model
- options (optional, default {})

PaginatedCollection

Extends Collection

Paginated Collection Class - A Collection that handles pagination from client or server-side

$3

- models
- options (optional, default {})

$3

Current page for the collection

#### Parameters

- size

$3

Total pages for the collection

#### Parameters

- size

$3

Sets the number of items in a page

#### Parameters

- size number Number of items in each page

$3

Sets the current page

#### Parameters

- page number Current page in collection

$3

Collection.fetch - rewritten fetch method from Backbone.Collection.fetch

#### Parameters

- options

$3

Moves to the next page

$3

Moves to the previous page

$3

Goes to page

#### Parameters

- page number Page to go to

$3

Moves to the first page

$3

Moves to the last page

$3

Refreshes the collection

PaginationFactory

Pagination factory for returning pagination collections of an API type

PAGINATION_API_TYPE

Types of pagination API

$3

- GITHUB Symbol GitHub API
- SOLR Symbol SOLR API
- DATABASE Symbol Database-like API

getPaginatedCollection

Get a pagination collection of type

$3

- apiType Pagination.PAGINATION_API_TYPE The API type to return an instance of
- data object Collection models
- options object Collection options